com.helger.commons.mutable

Class MutableFloat

java.lang.Object

java.lang.Number

com.helger.commons.mutable.AbstractMutableNumeric<MutableFloat>

com.helger.commons.mutable.MutableFloat

All Implemented Interfaces:

ICloneable<MutableFloat>, IMutableNumeric<MutableFloat>, IMutableObject<MutableFloat>, IGenericImplTrait<MutableFloat>, Serializable, Comparable<MutableFloat>

@NotThreadSafe
public class MutableFloat
extends AbstractMutableNumeric<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(Number aValue)

Method Summary

Modifier and Type	Method and Description
int	compareTo(MutableFloat rhs)
float	dec()
float	dec(float fDelta)
float	dec(Number aDelta)
float	divide(float fDivisor)
float	divide(Number aDivisor)
double	doubleValue()
boolean	equals(Object o)
float	floatValue()
MutableFloat	getClone()
int	hashCode()
float	inc() Increment by 1 and return the modified value.
float	inc(float fDelta)
float	inc(Number aDelta)
int	intValue()
boolean	is0()
boolean	isGreater0()
boolean	isGreaterOrEqual0()
boolean	isSmaller0()
boolean	isSmallerOrEqual0()
long	longValue()
float	multiply(float fMultiplicand)
float	multiply(Number aMultiplicand)
EChange	set(float fValue)
EChange	set(Number aValue)
String	toString()

Methods inherited from class com.helger.commons.mutable.AbstractMutableNumeric

getAsBigDecimal, getAsBigInteger, getAsByte, getAsCharacter, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsShort, onAfterChange

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.mutable.IMutableNumeric

isNot0

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

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
                    Number aValue)

MutableFloat

public MutableFloat(float fValue)

Method Detail

floatValue

public float floatValue()

Specified by:

floatValue in class Number

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)

inc

public float inc(@Nonnull
                 Number aDelta)

dec

public float dec()

dec

public float dec(float fDelta)

dec

public float dec(@Nonnull
                 Number aDelta)

divide

public float divide(float fDivisor)

divide

public float divide(@Nonnull
                    Number aDivisor)

multiply

public float multiply(float fMultiplicand)

multiply

public float multiply(@Nonnull
                      Number aMultiplicand)

set

@Nonnull
public EChange set(float fValue)

set

@Nonnull
public EChange set(@Nonnull
                             Number aValue)

is0

public boolean is0()

Returns:

true if the value is 0

isSmaller0

public boolean isSmaller0()

Returns:

true if the value is < 0

isSmallerOrEqual0

public boolean isSmallerOrEqual0()

Returns:

true if the value is ≤ 0

isGreater0

public boolean isGreater0()

Returns:

true if the value is > 0

isGreaterOrEqual0

public boolean isGreaterOrEqual0()

Returns:

true if the value is ≥ 0

compareTo

public int compareTo(@Nonnull
                     MutableFloat rhs)

getClone

@Nonnull
public MutableFloat getClone()

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