com.ibasco.agql.core.util

Class AbstractOptions

java.lang.Object

com.ibasco.agql.core.util.AbstractOptions

All Implemented Interfaces:

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

Direct Known Subclasses:

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

public abstract class AbstractOptions
extends Object
implements Options

Base class for all Option containers

Author:

Rafael Luis Ibasco

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOptions() Constructor for AbstractOptions.

Method Summary

Modifier and Type	Method and Description
boolean	contains(Option<?> option) Checks if the provided Option key exists in this container
<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.
boolean	isLocked(Option<?> option) Check locked status of option
@NotNull Iterator<Map.Entry<Option<?>,Object>>	iterator()
<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 class java.lang.Object

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

Methods inherited from interface com.ibasco.agql.core.util.Options

get, getOrDefault, getOrDefault, isEmpty

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AbstractOptions

protected AbstractOptions()

Constructor for AbstractOptions.

Method Detail

put

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

Add option value to this container

Specified by:

put in interface Options

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key

value - The Option value

putIfAbsent

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

Description copied from interface: Options

Add option value to this container if not yet existing

Specified by:

putIfAbsent in interface Options

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key

value - The Option value

put

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

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

Specified by:

put in interface Options

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 Options.put(Option, Object) will result in failure for this configuration Option

isLocked

public boolean isLocked(Option<?> option)

Check locked status of option

Specified by:

isLocked in interface Options

Parameters:

option - a Option object

Returns:

true if the specified Option is currently locked.

contains

public boolean contains(Option<?> option)

Checks if the provided Option key exists in this container

Specified by:

contains in interface Options

Parameters:

option - The Option key to be used as lookup

Returns:

true if the Option exists in this container

remove

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

Remove Option value from this container.

Specified by:

remove in interface Options

Type Parameters:

X - The captured type of the Option

Parameters:

option - The Option key to be used as lookup

get

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

Retrieve Option value from this container

Specified by:

get in interface Options

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

get

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

Specified by:

get in interface Options

get

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

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

Specified by:

get in interface Options

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

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

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

Specified by:

getOrDefault in interface Options

Type Parameters:

X - The captured type of the Option

Parameters:

option - a Option object

Returns:

The value associated with the provided Option

size

public int size()

Returns the number of configuration Option present for this container

Specified by:

size in interface Options

Returns:

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

iterator

@NotNull
public @NotNull Iterator<Map.Entry<Option<?>,Object>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<Option<?>,Object>>