Ice

Class FloatOptional

java.lang.Object

Ice.FloatOptional

public class FloatOptional
extends java.lang.Object

Manages an optional float parameter.

Constructor Summary

Constructors

Constructor and Description
FloatOptional() The value defaults to unset.
FloatOptional(float v) Sets the value to the given argument.
FloatOptional(FloatOptional opt) Sets the value to a shallow copy of the given optional.

Method Summary

Modifier and Type	Method and Description
void	clear() Unsets this value.
float	get() Obtains the current value.
boolean	isSet() Determines whether the value is set.
void	set(float v) Sets the value to the given argument.
void	set(FloatOptional opt) If the given argument is set, this optional is set to a shallow copy of the argument, otherwise this optional is unset.

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatOptional

public FloatOptional()

The value defaults to unset.

FloatOptional

public FloatOptional(float v)

Sets the value to the given argument.

Parameters:

v - The initial value.

FloatOptional

public FloatOptional(FloatOptional opt)

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

Parameters:

opt - The source value.

Method Detail

get

public float get()

Obtains the current value.

Returns:

The current value.

Throws:

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

set

public void set(float v)

Sets the value to the given argument.

Parameters:

v - The new value.

set

public void set(FloatOptional 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.