org.kitteh.irc.client.library.util

Class AbstractNameValueProcessor<NameValue>

java.lang.Object

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

Type Parameters:

NameValue - type of pair

Direct Known Subclasses:

DefaultISupportManager, DefaultMessageTagManager

public abstract class AbstractNameValueProcessor<NameValue>
extends Object

Abstract class for registering and processing name/value pairs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractNameValueProcessor.Creator<NameValue> A creator of name/value pairs of a particular type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNameValueProcessor(Client.WithManagement client) Constructs the processor.

Method Summary

Modifier and Type	Method and Description
Client.WithManagement	getClient() Gets the Client for which this processor functions.
protected Optional<TriFunction<Client,String,String,? extends NameValue>>	getCreatorByName(String name) Gets a registered creator function by registered name.
protected Map<String,AbstractNameValueProcessor.Creator<NameValue>>	getRegistrations() Gets the actual registrations map, for manipulation.
protected Optional<TriFunction<Client,String,String,? extends NameValue>>	registerCreator(String name, AbstractNameValueProcessor.Creator<NameValue> creator) Registers a creator to a name.
String	toString()
protected Optional<TriFunction<Client,String,String,? extends NameValue>>	unregisterCreator(String name) Removes registration of a creator to a name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNameValueProcessor

protected AbstractNameValueProcessor(Client.WithManagement client)

Constructs the processor.

Parameters:

client - client this will be used for

Method Detail

getClient

public Client.WithManagement getClient()

Gets the Client for which this processor functions.

Returns:

client

getRegistrations

protected final Map<String,AbstractNameValueProcessor.Creator<NameValue>> getRegistrations()

Gets the actual registrations map, for manipulation.

Returns:

registration map

getCreatorByName

@Nonnull
protected final Optional<TriFunction<Client,String,String,? extends NameValue>> getCreatorByName(@Nonnull
                                                                                                           String name)

Gets a registered creator function by registered name.

Parameters:

name - name to find

Returns:

registered creator function

registerCreator

@Nonnull
protected final Optional<TriFunction<Client,String,String,? extends NameValue>> registerCreator(@Nonnull
                                                                                                          String name,
                                                                                                          @Nonnull
                                                                                                          AbstractNameValueProcessor.Creator<NameValue> creator)

Registers a creator to a name.

Parameters:

name - name

creator - creator

Returns:

previous occupant of the name registration, if there was one

unregisterCreator

@Nonnull
protected final Optional<TriFunction<Client,String,String,? extends NameValue>> unregisterCreator(@Nonnull
                                                                                                            String name)

Removes registration of a creator to a name.

Parameters:

name - name

Returns:

previous occupant of the name registration, if there was one

toString

@Nonnull
public String toString()

Overrides:

toString in class Object