org.kitteh.irc.client.library.feature

Interface MessageTagManager

All Known Implementing Classes:

DefaultMessageTagManager

public interface MessageTagManager

Manages message tags.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessageTagManager.DefaultMessageTag Default message tag.

Method Summary

Modifier and Type	Method and Description
@NonNull Map<String,TriFunction<Client,String,String,? extends MessageTag>>	getCapabilityTagCreators(@NonNull String capability) Gets the registered tag creators for a given capability.
@NonNull List<MessageTag>	getCapabilityTags(@NonNull String tagList) Gets capability tags for a given raw tag list.
@NonNull Optional<TriFunction<Client,String,String,? extends MessageTag>>	getTagCreator(@NonNull String tagName) Gets the registered tag creator for a given tag name.
@NonNull Optional<TriFunction<Client,String,String,? extends MessageTag>>	registerTagCreator(@NonNull String capability, @NonNull String tagName, @NonNull TriFunction<Client,String,String,? extends MessageTag> tagCreator) Registers a function that creates a tag from given tag name and tag value, only to run if the given capability is enabled.
@NonNull Optional<TriFunction<Client,String,String,? extends MessageTag>>	unregisterTag(@NonNull String tagName) Removes the registered tag creator for a given tag name.

Method Detail

getCapabilityTagCreators

@NonNull Map<String,TriFunction<Client,String,String,? extends MessageTag>> getCapabilityTagCreators(@NonNull String capability)

Gets the registered tag creators for a given capability.

Parameters:

capability - capability name

Returns:

mapping of tags to their creators for the given capability

getCapabilityTags

@NonNull List<MessageTag> getCapabilityTags(@NonNull String tagList)

Gets capability tags for a given raw tag list.

Parameters:

tagList - raw list

Returns:

tags for the given list

getTagCreator

@NonNull Optional<TriFunction<Client,String,String,? extends MessageTag>> getTagCreator(@NonNull String tagName)

Gets the registered tag creator for a given tag name.

Parameters:

tagName - tag name

Returns:

registered creator if present

registerTagCreator

@NonNull Optional<TriFunction<Client,String,String,? extends MessageTag>> registerTagCreator(@NonNull String capability,
                                                                                             @NonNull String tagName,
                                                                                             @NonNull TriFunction<Client,String,String,? extends MessageTag> tagCreator)

Registers a function that creates a tag from given tag name and tag value, only to run if the given capability is enabled.

Parameters:

capability - capability for which this tag exists

tagName - name of the tag to register

tagCreator - function that creates tags

Returns:

displaced tag creator if one existed for the given tag name

unregisterTag

@NonNull Optional<TriFunction<Client,String,String,? extends MessageTag>> unregisterTag(@NonNull String tagName)

Removes the registered tag creator for a given tag name.

Parameters:

tagName - tag name

Returns:

registered creator if present