com.ibasco.agql.core.util

Interface Options

All Superinterfaces:

Cloneable, Iterable<Map.Entry<Option<?>,Object>>

All Known Implementing Classes:

AbstractOptions, ConnectOptions, FailsafeOptions, GeneralOptions, HttpOptions, MasterServerOptions, SourceQueryOptions, SourceRconOptions

public interface Options
extends Cloneable, Iterable<Map.Entry<Option<?>,Object>>

A container for configuration Option instances. Implementation of this must be thread-safe.

Author:

Rafael Luis Ibasco

Method Summary

Modifier and Type	Method and Description
boolean	contains(Option<?> option) Checks if the provided Option key exists in this container
default <X> X	get(Option<?> option, Class<? extends Options> context)
<X> X	get(Option<X> option) Retrieve Option value from this container
<X> X	get(Option<X> option, X defaultValue) Retrieve option value from this container.
<X> X	get(String key, Class<? extends Options> context)
<X> X	getOrDefault(Option<X> option) Retrieve the option value.
default <X> X	getOrDefault(Option<X> option, Class<? extends Options> context)
default <X> X	getOrDefault(String key, Class<? extends Options> context)
default boolean	isEmpty() Check if container is empty.
boolean	isLocked(Option<?> option) Check locked status of option
<X> void	put(Option<X> option, X value) Add option value to this container
<X> void	put(Option<X> option, X value, boolean locked) Add option value to this container with the additional option to lockout the value
<X> X	putIfAbsent(Option<X> option, X value) Add option value to this container if not yet existing
<X> void	remove(Option<X> option) Remove Option value from this container.
int	size() Returns the number of configuration Option present for this container

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

put

<X> void put(Option<X> option,
             X value)

Add option value to this container

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key

value - The Option value

putIfAbsent

<X> X putIfAbsent(Option<X> option,
                  X value)

Add option value to this container if not yet existing

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key

value - The Option value

put

<X> void put(Option<X> option,
             X value,
             boolean locked)

Add option value to this container with the additional option to lockout the value

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key to be used as lookup

value - The value to be added

locked - Set to true if we should lockout this value. Future invocations of put(Option, Object) will result in failure for this configuration Option

isLocked

boolean isLocked(Option<?> option)

Check locked status of option

Parameters:

option - a Option object

Returns:

true if the specified Option is currently locked.

contains

boolean contains(Option<?> option)

Checks if the provided Option key exists in this container

Parameters:

option - The Option key to be used as lookup

Returns:

true if the Option exists in this container

remove

<X> void remove(Option<X> option)

Remove Option value from this container.

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key to be used as lookup

get

<X> X get(Option<X> option)

Retrieve Option value from this container

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key to be used as lookup

Returns:

The value associated with the provided Option

getOrDefault

default <X> X getOrDefault(Option<X> option,
                           Class<? extends Options> context)

getOrDefault

default <X> X getOrDefault(String key,
                           Class<? extends Options> context)

get

default <X> X get(Option<?> option,
                  Class<? extends Options> context)

get

<X> X get(String key,
          Class<? extends Options> context)

get

<X> X get(Option<X> option,
          X defaultValue)

Retrieve option value from this container. If missing, the provided default value will be returned

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key to be used as lookup

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

Returns:

The value associated with the provided Option

getOrDefault

<X> X getOrDefault(Option<X> option)

Retrieve the option value. If missing, the default value defined by the Option will be returned instead

Type Parameters:

X - The captured type of the Option

Parameters:

option - a Option object

Returns:

The value associated with the provided Option

isEmpty

default boolean isEmpty()

Check if container is empty.

Returns:

true if the instance is empty.

size

int size()

Returns the number of configuration Option present for this container

Returns:

An integer representing the size of the Options present in this container.