org.forgerock.cuppa.model

Class Option<T>

java.lang.Object

org.forgerock.cuppa.model.Option<T>

Type Parameters:

T - The type of the value stored within this Option.

Direct Known Subclasses:

Runner.TagsRunOption, TagsOption

public abstract class Option<T>
extends java.lang.Object

An option stores a value of the given type. Options allow Cuppa's data model to be extended to include additional metadata about tests and test blocks.

To create a Option, you should create a unique subclass for your data. This allows you to avoid colliding with other extensions.

Options are immutable. Subclasses should make defensive copies of any mutable data structures passed to them.

See Also:

Options, TagsOption

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Option(T value) Create a new option.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
T	get() Get the value of the option.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Option

protected Option(T value)

Create a new option.

Parameters:

value - The immutable value to store in this option.

Method Detail

get

public final T get()

Get the value of the option.

Returns:

the value of the option.

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object