com.phloc.commons.mutable

Class MutableFloat

java.lang.Object

java.lang.Number

com.phloc.commons.mutable.MutableFloat

All Implemented Interfaces:

ICloneable<MutableFloat>, IMutable<MutableFloat>, IMutableNumeric<MutableFloat>, Serializable, Comparable<MutableFloat>

@NotThreadSafe
public final class MutableFloat
extends Number
implements IMutableNumeric<MutableFloat>

Object wrapper around a float so that it can be passed a final object but is mutable.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_VALUE The default value if the default constructor is used.

Constructor Summary

Constructors

Constructor and Description
MutableFloat() Initialize with default value 0.0f
MutableFloat(float fValue)
MutableFloat(Float aValue)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(MutableFloat rhs)
float	dec()
float	dec(float fDelta)
double	doubleValue()
boolean	equals(Object o)
float	floatValue()
Float	getAsFloat()
MutableFloat	getClone()
int	hashCode()
float	inc() Increment by 1 and return the modified value.
float	inc(float fDelta)
int	intValue()
boolean	is0()
boolean	isGreater0()
boolean	isGreaterOrEqual0()
boolean	isNot0()
boolean	isSmaller0()
boolean	isSmallerOrEqual0()
long	longValue()
EChange	set(float fValue)
String	toString()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VALUE

public static final float DEFAULT_VALUE

The default value if the default constructor is used.

See Also:

Constant Field Values

Constructor Detail

MutableFloat

public MutableFloat()

Initialize with default value 0.0f

MutableFloat

public MutableFloat(@Nonnull
            Float aValue)

MutableFloat

public MutableFloat(float fValue)

Method Detail

floatValue

public float floatValue()

Specified by:

floatValue in class Number

getAsFloat

@Nonnull
public Float getAsFloat()

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

inc

public float inc()

Increment by 1 and return the modified value.

Returns:

The by 1 incremented value.

inc

public float inc(float fDelta)

dec

public float dec()

dec

public float dec(float fDelta)

set

@Nonnull
public EChange set(float fValue)

is0

public boolean is0()

Specified by:

is0 in interface IMutableNumeric<MutableFloat>

Returns:

true if the value is 0

isNot0

public boolean isNot0()

Specified by:

isNot0 in interface IMutableNumeric<MutableFloat>

Returns:

true if the value is not 0

isSmaller0

public boolean isSmaller0()

Specified by:

isSmaller0 in interface IMutableNumeric<MutableFloat>

Returns:

true if the value is < 0

isSmallerOrEqual0

public boolean isSmallerOrEqual0()

Specified by:

isSmallerOrEqual0 in interface IMutableNumeric<MutableFloat>

Returns:

true if the value is ≤ 0

isGreater0

public boolean isGreater0()

Specified by:

isGreater0 in interface IMutableNumeric<MutableFloat>

Returns:

true if the value is > 0

isGreaterOrEqual0

public boolean isGreaterOrEqual0()

Specified by:

isGreaterOrEqual0 in interface IMutableNumeric<MutableFloat>

Returns:

true if the value is ≥ 0

compareTo

public int compareTo(@Nonnull
            MutableFloat rhs)

Specified by:

compareTo in interface Comparable<MutableFloat>

getClone

@Nonnull
public MutableFloat getClone()

Specified by:

getClone in interface ICloneable<MutableFloat>

Returns:

A 100% deep-copy of the implementing class.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object