org.tensorics.core.commons.options

Class ImmutableOptionRegistry<T extends Option<T>>

java.lang.Object

org.tensorics.core.commons.options.ImmutableOptionRegistry<T>

Type Parameters:

T -

All Implemented Interfaces:

OptionRegistry<T>

public final class ImmutableOptionRegistry<T extends Option<T>>
extends java.lang.Object
implements OptionRegistry<T>

The default implementation of an options registry. It is backed by a class to instance map. Use the factory method of(Collection) to create a new instance.

This class is immutable

Method Summary

Modifier and Type	Method and Description
<T1 extends T> T1	get(java.lang.Class<T1> optionType) Has to return the option with the given marker interface
static <T extends Option<T>> ImmutableOptionRegistry<T>	of(java.util.Collection<T> processingOptions) creates a new registry which will contain the given options.
<T1 extends T> OptionRegistry<T>	with(T1 newOption) Has to return a new instance of an option registry, containing the same options, except the given one replacing the previously contained option with the same marker interface.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <T extends Option<T>> ImmutableOptionRegistry<T> of(java.util.Collection<T> processingOptions)

creates a new registry which will contain the given options. If the collection contains options of the same type (marker interface), then the ones in the order of the iterator of the collection, will override the earlier ones.

Parameters:

processingOptions - the options that will be contained in the registry

Returns:

a new instance of a registry, containing the options

get

public <T1 extends T> T1 get(java.lang.Class<T1> optionType)

Description copied from interface: OptionRegistry

Has to return the option with the given marker interface

Specified by:

get in interface OptionRegistry<T extends Option<T>>

Parameters:

optionType - the class of the marker interface for which an instance has to be retrieved

Returns:

an instance of the option of the given class

with

public <T1 extends T> OptionRegistry<T> with(T1 newOption)

Description copied from interface: OptionRegistry

Has to return a new instance of an option registry, containing the same options, except the given one replacing the previously contained option with the same marker interface.

Specified by:

with in interface OptionRegistry<T extends Option<T>>

Parameters:

newOption - the new option to replace the previously contained with the same marker interface

Returns:

a new instance of the option registry, containing also the new option