org.kitteh.irc.client.library.defaults.feature

Class DefaultMessageTagManager

java.lang.Object

org.kitteh.irc.client.library.util.AbstractNameValueProcessor<MessageTag>

org.kitteh.irc.client.library.defaults.feature.DefaultMessageTagManager

All Implemented Interfaces:

MessageTagManager

public class DefaultMessageTagManager
extends AbstractNameValueProcessor<MessageTag>
implements MessageTagManager

Default implementation of MessageTagManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultMessageTagManager.TagCreator

Nested classes/interfaces inherited from class org.kitteh.irc.client.library.util.AbstractNameValueProcessor

AbstractNameValueProcessor.Creator<NameValue>

Nested classes/interfaces inherited from interface org.kitteh.irc.client.library.feature.MessageTagManager

MessageTagManager.DefaultMessageTag

Constructor Summary

Constructors

Constructor and Description
DefaultMessageTagManager(Client.WithManagement client) Constructs the default tag manager.

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> function) 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.

Methods inherited from class org.kitteh.irc.client.library.util.AbstractNameValueProcessor

getClient, getCreatorByName, getRegistrations, registerCreator, toString, unregisterCreator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultMessageTagManager

public DefaultMessageTagManager(Client.WithManagement client)

Constructs the default tag manager.

Parameters:

client - client

Method Detail

getCapabilityTagCreators

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

Description copied from interface: MessageTagManager

Gets the registered tag creators for a given capability.

Specified by:

getCapabilityTagCreators in interface MessageTagManager

Parameters:

capability - capability name

Returns:

mapping of tags to their creators for the given capability

getTagCreator

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

Description copied from interface: MessageTagManager

Gets the registered tag creator for a given tag name.

Specified by:

getTagCreator in interface MessageTagManager

Parameters:

tagName - tag name

Returns:

registered creator if present

registerTagCreator

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

Description copied from interface: MessageTagManager

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

Specified by:

registerTagCreator in interface MessageTagManager

Parameters:

capability - capability for which this tag exists

tagName - name of the tag to register

function - function that creates tags

Returns:

displaced tag creator if one existed for the given tag name

unregisterTag

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

Description copied from interface: MessageTagManager

Removes the registered tag creator for a given tag name.

Specified by:

unregisterTag in interface MessageTagManager

Parameters:

tagName - tag name

Returns:

registered creator if present

getCapabilityTags

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

Description copied from interface: MessageTagManager

Gets capability tags for a given raw tag list.

Specified by:

getCapabilityTags in interface MessageTagManager

Parameters:

tagList - raw list

Returns:

tags for the given list