Package 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:

IComparable<MutableFloat>, ICloneable<MutableFloat>, IMutableNumeric<MutableFloat>, IMutableObject<MutableFloat>, INumber, 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

Constructor Summary

Constructors

Constructor	Description
MutableFloat(float fValue)
MutableFloat(Number aValue)

Method Summary

Modifier and Type	Method	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()	Returns the value of the specified number as a double, which may involve rounding.
boolean	equals(Object o)
float	floatValue()	Returns the value of the specified number as a float, which may involve rounding.
float	getAndInc()
MutableFloat	getClone()
int	hashCode()
float	inc()	Increment by 1 and return the modified value.
float	inc(float fDelta)
float	inc(Number aDelta)
float	incAndGet()
int	intValue()	Returns the value of the specified number as an int, which may involve rounding or truncation.
boolean	is0()
boolean	isGE0()
boolean	isGT0()
boolean	isLE0()
boolean	isLT0()
long	longValue()	Returns the value of the specified number as a long, which may involve rounding or truncation.
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

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.compare.IComparable

isEQ, isGE, isGT, isLE, isLT, isNE

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

thisAsT

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

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

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

byteValue, shortValue

Constructor Detail

MutableFloat

public MutableFloat(@Nonnull
                    Number aValue)

MutableFloat

public MutableFloat(float fValue)

Method Detail

floatValue

public float floatValue()

Description copied from interface: INumber

Returns the value of the specified number as a float, which may involve rounding.

Specified by:

floatValue in interface INumber

Specified by:

floatValue in class Number

Returns:

the numeric value represented by this object after conversion to type float.

doubleValue

public double doubleValue()

Description copied from interface: INumber

Returns the value of the specified number as a double, which may involve rounding.

Specified by:

doubleValue in interface INumber

Specified by:

doubleValue in class Number

Returns:

the numeric value represented by this object after conversion to type double.

intValue

public int intValue()

Description copied from interface: INumber

Returns the value of the specified number as an int, which may involve rounding or truncation.

Specified by:

intValue in interface INumber

Specified by:

intValue in class Number

Returns:

the numeric value represented by this object after conversion to type int.

longValue

public long longValue()

Description copied from interface: INumber

Returns the value of the specified number as a long, which may involve rounding or truncation.

Specified by:

longValue in interface INumber

Specified by:

longValue in class Number

Returns:

the numeric value represented by this object after conversion to type long.

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

isLT0

public boolean isLT0()

Returns:

true if the value is < 0

isLE0

public boolean isLE0()

Returns:

true if the value is ≤ 0

isGT0

public boolean isGT0()

Returns:

true if the value is > 0

isGE0

public boolean isGE0()

Returns:

true if the value is ≥ 0

getAndInc

public float getAndInc()

incAndGet

public float incAndGet()

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