com.ibasco.agql.core.util

Class Option<T>

java.lang.Object

com.ibasco.agql.core.util.Option<T>

Type Parameters:

T - The underlying type of the option value

public final class Option<T>
extends Object

Represents a configuration option

Author:

Rafael Luis Ibasco

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Option.CacheEntry

Method Summary

Modifier and Type	Method and Description
T	attr(io.netty.channel.Channel channel) A convenient method for retrieving a channel's attribute associated with this option
T	attr(io.netty.channel.ChannelHandlerContext context) A convenient method for retrieving a channel's attribute associated with this option
void	attr(io.netty.channel.ChannelHandlerContext context, T value) A convenient method for modifying a channel's attribute
void	attr(io.netty.channel.Channel channel, T value) A convenient method for modifying a channel's attribute
static void	consolidate(Options options, Class<?> source)
static <V> Option<V>	create(String key) Creates a singleton instance of an Option based on the key provided
static <V> Option<V>	create(String key, V defaultValue) Creates a singleton instance of an Option based on the key provided
static <V> Option<V>	create(String key, V defaultValue, boolean channelAttribute) Creates a singleton instance of an Option based on the key provided
static <V> Option<V>	create(String key, V defaultValue, boolean channelAttribute, boolean autoCreate) Creates a singleton instance of an Option based on the key provided.
boolean	equals(Object o)
Class<? extends Options>	getDeclaringClass() The declaring Class of this Option
T	getDefaultValue() Getter for the field defaultValue.
String	getFieldName() Getter for the field fieldName.
static <V> V	getGlobal(Option<V> option) Retrieve a global Option declared from GeneralOptions container
static <V> V	getGlobal(Option<V> option, V defaultValue) Retrieve a global Option declared from GeneralOptions container
UUID	getId()
String	getKey() Getter for the field key.
static com.google.common.collect.SetMultimap<Class<? extends Options>,Option.CacheEntry>	getOptions() Returns a read-only SetMultimap containing of all the Options provided by this library
int	hashCode()
static void	initialize(Class<? extends Options> containerClass)
boolean	isAutoCreate() isAutoCreate.
boolean	isChannelAttribute() isChannelAttribute.
boolean	isGlobal() isGlobal.
boolean	isShared()
static <V> Option<V>	of(Class<? extends Options> containerClass, Class<?> context, Option<?> option)
static <V> Option<V>	of(Class<? extends Options> containerClass, Class<?> context, String key)
static <V> Option<V>	of(Class<? extends Options> containerClass, String key) Retrieve an singleton Option instance using the provided class group and key combination
static <V> Option<V>	of(String key) Retrieve a singleton instance of an Option using the provided key.
static <V> Option<V>	ofGlobal(String key) Returns a singleton Option instance from global
io.netty.util.AttributeKey<T>	toAttributeKey() toAttributeKey.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

consolidate

@ApiStatus.Internal
public static void consolidate(Options options,
                                                   Class<?> source)

initialize

@ApiStatus.Internal
public static void initialize(Class<? extends Options> containerClass)

of

public static <V> Option<V> of(String key)

Retrieve a singleton instance of an Option using the provided key.

Note: This will lookup the GeneralOptions container by default

Type Parameters:

V - a V class

Parameters:

key - The key to be used for the lookup

Returns:

A singleton instance of Option associated with the key

getKey

public String getKey()

Getter for the field key.

Returns:

The unique key associated with this Option

of

public static <V> Option<V> of(Class<? extends Options> containerClass,
                               Class<?> context,
                               Option<?> option)

of

public static <V> Option<V> of(Class<? extends Options> containerClass,
                               Class<?> context,
                               String key)

ofGlobal

public static <V> Option<V> ofGlobal(String key)

Returns a singleton Option instance from global

Type Parameters:

V - The captured type of the Option

Parameters:

key - The option key to be used for lookup

Returns:

The singleton Option instance if found, otherwise null.

isGlobal

public boolean isGlobal()

isGlobal.

Returns:

true if this option is a Global option type

See Also:

GeneralOptions

getGlobal

public static <V> V getGlobal(Option<V> option)

Retrieve a global Option declared from GeneralOptions container

Type Parameters:

V - The captured return type

Parameters:

option - The Option to be used as lookup

Returns:

The value of the specified Option retrieved from the GeneralOptions container

getGlobal

public static <V> V getGlobal(Option<V> option,
                              V defaultValue)

Retrieve a global Option declared from GeneralOptions container

Type Parameters:

V - The captured return type

Parameters:

option - The Option to be used as lookup

defaultValue - The default value to return if the initial return value is null

Returns:

The value of the specified Option retrieved from the GeneralOptions container

create

public static <V> Option<V> create(String key)

Creates a singleton instance of an Option based on the key provided

Type Parameters:

V - The underlying type of the Option

Parameters:

key - The unique key of the option

Returns:

A singleton Option instance

create

public static <V> Option<V> create(String key,
                                   V defaultValue)

Creates a singleton instance of an Option based on the key provided

Type Parameters:

V - The underlying type of the Option

Parameters:

key - The unique key of the option

defaultValue - The default value for this Option

Returns:

A singleton Option instance

create

public static <V> Option<V> create(String key,
                                   V defaultValue,
                                   boolean channelAttribute)

Creates a singleton instance of an Option based on the key provided

Type Parameters:

V - The underlying type of the Option

Parameters:

key - The unique key of the option

defaultValue - The default value for this Option

channelAttribute - true if this option should be added as a default channel attribute

Returns:

A singleton Option instance based on the key provided.

create

public static <V> Option<V> create(String key,
                                   V defaultValue,
                                   boolean channelAttribute,
                                   boolean autoCreate)

Creates a singleton instance of an Option based on the key provided. NOTE: The newly created instance will not be added to the cache.

Type Parameters:

V - The underlying type of the Option

Parameters:

key - The unique key of the option

defaultValue - The default value for this Option

channelAttribute - true if this option should be added as a default channel attribute

autoCreate - If true, the channel attribute will be automatically initialized in the underlying Channel regardless whether or not it is explicitly set by the client. This is only applicable when channelAttribute is set to true.

Returns:

A singleton Option instance based on the key provided.

of

public static <V> Option<V> of(Class<? extends Options> containerClass,
                               String key)

Retrieve an singleton Option instance using the provided class group and key combination

Type Parameters:

V - The underlying type of the Option

Parameters:

containerClass - The Class A class of type Options

key - The key identifying the option

Returns:

The Option instance or null if no Option found for the specified combination.

getOptions

public static com.google.common.collect.SetMultimap<Class<? extends Options>,Option.CacheEntry> getOptions()

Returns a read-only SetMultimap containing of all the Options provided by this library

Returns:

an ImmutableSetMultimap

isShared

public boolean isShared()

getDeclaringClass

public Class<? extends Options> getDeclaringClass()

The declaring Class of this Option

Returns:

The declaring Class of this Option

getDefaultValue

public T getDefaultValue()

Getter for the field defaultValue.

Returns:

The default value assciated with this Option

getFieldName

public String getFieldName()

Getter for the field fieldName.

Returns:

a String object

isChannelAttribute

public boolean isChannelAttribute()

isChannelAttribute.

Returns:

true if this option is also a channel attribute

isAutoCreate

public boolean isAutoCreate()

isAutoCreate.

Returns:

true if autoCreate flag is set.

toAttributeKey

public io.netty.util.AttributeKey<T> toAttributeKey()

toAttributeKey.

Returns:

An AttributeKey instance of this option

attr

public void attr(io.netty.channel.ChannelHandlerContext context,
                 T value)

A convenient method for modifying a channel's attribute

Parameters:

context - The ChannelHandlerContext whose Channel will be updated

value - The value to be modified

attr

public void attr(io.netty.channel.Channel channel,
                 T value)

A convenient method for modifying a channel's attribute

Parameters:

channel - The Channel that will be updated

value - The value to be modified

attr

public T attr(io.netty.channel.ChannelHandlerContext context)

A convenient method for retrieving a channel's attribute associated with this option

Parameters:

context - The ChannelHandlerContext whos Channel will be queried using the attribute associated with this option.

Returns:

The value of the attribute

attr

public T attr(io.netty.channel.Channel channel)

A convenient method for retrieving a channel's attribute associated with this option

Parameters:

channel - The Channel that will be queried using the attribute associated with this option.

Returns:

The value of the attribute

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getId

public UUID getId()