org.kitteh.irc.client.library.feature

Interface ISupportManager

All Known Implementing Classes:

DefaultISupportManager

public interface ISupportManager

Manages processing of ISUPPORT parameters.

Method Summary

Modifier and Type	Method and Description
@NonNull ISupportParameter	createParameter(@NonNull String tag) Creates a ISupportParameter from given input.
@NonNull Optional<TriFunction<Client,String,String,? extends ISupportParameter>>	getCreator(@NonNull String parameter) Gets the registered ISUPPORT creator for a given parameter name.
@NonNull Optional<TriFunction<Client,String,String,? extends ISupportParameter>>	registerParameter(@NonNull String parameter, @NonNull TriFunction<Client,String,String,? extends ISupportParameter> creator) Registers a function that creates an ISupportParameter from a given parameter and value.
@NonNull Optional<TriFunction<Client,String,String,? extends ISupportParameter>>	unregisterParameter(@NonNull String parameter) Removes the registered creator for a given parameter.

Method Detail

createParameter

@NonNull ISupportParameter createParameter(@NonNull String tag)

Creates a ISupportParameter from given input.

Parameters:

tag - input

Returns:

a parameter based on the input

getCreator

@NonNull Optional<TriFunction<Client,String,String,? extends ISupportParameter>> getCreator(@NonNull String parameter)

Gets the registered ISUPPORT creator for a given parameter name.

Parameters:

parameter - parameter

Returns:

registered creator if present

registerParameter

@NonNull Optional<TriFunction<Client,String,String,? extends ISupportParameter>> registerParameter(@NonNull String parameter,
                                                                                                   @NonNull TriFunction<Client,String,String,? extends ISupportParameter> creator)

Registers a function that creates an ISupportParameter from a given parameter and value.

Parameters:

parameter - name of the parameter to register

creator - function that creates tags

Returns:

displaced creator if one existed for the given parameter

unregisterParameter

@NonNull Optional<TriFunction<Client,String,String,? extends ISupportParameter>> unregisterParameter(@NonNull String parameter)

Removes the registered creator for a given parameter.

Parameters:

parameter - parameter

Returns:

registered creator if present