org.forgerock.cuppa.model

Class Options

java.lang.Object

org.forgerock.cuppa.model.Options

public final class Options
extends java.lang.Object

A set of options. Options allow Cuppa's data model to be extended to include additional metadata about tests and test blocks.

Field Summary

Fields

Modifier and Type	Field and Description
static Options	EMPTY The empty option set.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
<V,O extends Option<V>> java.util.Optional<V>	get(java.lang.Class<O> optionClass) Get an option of the given type.
int	hashCode()
<T> Options	set(Option<T> option) Set an option.
java.lang.String	toString()
<O extends Option<?>> Options	unset(java.lang.Class<O> optionClass) Un-sets an option.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Options EMPTY

The empty option set.

Method Detail

get

public <V,O extends Option<V>> java.util.Optional<V> get(java.lang.Class<O> optionClass)

Get an option of the given type. If no such option has been set, then an empty optional will be returned.

Type Parameters:

V - The type of the value stored in the option.

O - The type of the option.

Parameters:

optionClass - The class that corresponds to the option.

Returns:

An optional value.

unset

public <O extends Option<?>> Options unset(java.lang.Class<O> optionClass)

Un-sets an option.

Type Parameters:

O - The type of the option.

Parameters:

optionClass - The class of the option to un-set.

Returns:

A new Option instance without the specified option.

set

public <T> Options set(Option<T> option)

Set an option. If an option of the given type is already set, then it will be overwritten.

Type Parameters:

T - The type of the option.

Parameters:

option - The option to store.

Returns:

A new Option instance with the specified option.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object