Ice

Class Optional<T>

java.lang.Object

Ice.Optional<T>

public class Optional<T>
extends java.lang.Object

Generic class for optional parameters.

Constructor Summary

Constructors

Constructor and Description
Optional() The value defaults to unset.
Optional(Optional<T> opt) Sets the value to a shallow copy of the given optional.
Optional(T v) Sets the value to the given argument.

Method Summary

Modifier and Type	Method and Description
void	clear() Unsets this value.
T	get() Obtains the current value.
boolean	isSet() Determines whether the value is set.
static BooleanOptional	O(boolean v) Helper function for creating BooleanOptional instances.
static ByteOptional	O(byte v) Helper function for creating ByteOptional instances.
static DoubleOptional	O(double v) Helper function for creating DoubleOptional instances.
static FloatOptional	O(float v) Helper function for creating FloatOptional instances.
static IntOptional	O(int v) Helper function for creating IntOptional instances.
static LongOptional	O(long v) Helper function for creating LongOptional instances.
static ShortOptional	O(short v) Helper function for creating ShortOptional instances.
static <T> Optional<T>	O(T v) Helper function for creating Optional instances.
void	set(Optional<T> opt) If the given argument is set, this optional is set to a shallow copy of the argument, otherwise this optional is unset.
void	set(T v) Sets the value to the given argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

Optional

public Optional()

The value defaults to unset.

Optional

public Optional(T v)

Sets the value to the given argument.

Parameters:

v - The initial value.

Optional

public Optional(Optional<T> opt)

Sets the value to a shallow copy of the given optional.

Parameters:

opt - The source value.

Method Detail

get

public T get()

Obtains the current value.

Returns:

The current value.

Throws:

java.lang.IllegalStateException - If the value is not set.

set

public void set(T v)

Sets the value to the given argument.

Parameters:

v - The new value.

set

public void set(Optional<T> opt)

If the given argument is set, this optional is set to a shallow copy of the argument, otherwise this optional is unset.

Parameters:

opt - The source value.

isSet

public boolean isSet()

Determines whether the value is set.

Returns:

True if the value is set, false otherwise.

clear

public void clear()

Unsets this value.

O

public static <T> Optional<T> O(T v)

Helper function for creating Optional instances.

Type Parameters:

T - The type of the Optional.

Parameters:

v - The initial value of the Optional.

Returns:

A new Optional instance set to the given value.

O

public static BooleanOptional O(boolean v)

Helper function for creating BooleanOptional instances.

Parameters:

v - The initial value of the Optional.

Returns:

A new BooleanOptional instance set to the given value.

O

public static ByteOptional O(byte v)

Helper function for creating ByteOptional instances.

Parameters:

v - The initial value of the Optional.

Returns:

A new ByteOptional instance set to the given value.

O

public static ShortOptional O(short v)

Helper function for creating ShortOptional instances.

Parameters:

v - The initial value of the Optional.

Returns:

A new ShortOptional instance set to the given value.

O

public static IntOptional O(int v)

Helper function for creating IntOptional instances.

Parameters:

v - The initial value of the Optional.

Returns:

A new IntOptional instance set to the given value.

O

public static LongOptional O(long v)

Helper function for creating LongOptional instances.

Parameters:

v - The initial value of the Optional.

Returns:

A new LongOptional instance set to the given value.

O

public static FloatOptional O(float v)

Helper function for creating FloatOptional instances.

Parameters:

v - The initial value of the Optional.

Returns:

A new FloatOptional instance set to the given value.

O

public static DoubleOptional O(double v)

Helper function for creating DoubleOptional instances.

Parameters:

v - The initial value of the Optional.

Returns:

A new DoubleOptional instance set to the given value.