Package dev.brachtendorf.mutable

Class MutableFloat

java.lang.Object

java.lang.Number

dev.brachtendorf.mutable.MutableFloat

All Implemented Interfaces:

Mutable<Float>, Serializable, Comparable<MutableFloat>

public class MutableFloat
extends Number
implements Mutable<Float>, Comparable<MutableFloat>

Mutable class wrapper for float values. Mutable classes are useful in lambda expressions or anonymous classes which want to alter the content of a variable but are limited to final or effective final variables. Be aware that the hashcode changes if the value is updated resulting in the object not being retrievable in hash collections.

Since:

1.0.0 com.github.kilianB

Author:

Kilian

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MutableFloat()	Create a mutable Float with an initial value of 0
MutableFloat(float initialValue)	Create a mutable Float.

Method Summary

Modifier and Type	Method	Description
int	compareTo(MutableFloat o)
double	doubleValue()
boolean	equals(Object obj)
float	floatValue()
Float	getValue()	Get an object encapsulating the current value
int	hashCode()
int	intValue()
long	longValue()
void	setValue(float newValue)	Set the internal field to the new value
void	setValue(Float newValue)	Set the internal field to the new value

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableFloat

public MutableFloat()

Create a mutable Float with an initial value of 0

MutableFloat

public MutableFloat(float initialValue)

Create a mutable Float.

Parameters:

initialValue - the initial value of the float

Method Detail

compareTo

public int compareTo(MutableFloat o)

Specified by:

compareTo in interface Comparable<MutableFloat>

getValue

public Float getValue()

Description copied from interface: Mutable

Get an object encapsulating the current value

Specified by:

getValue in interface Mutable<Float>

Returns:

The current value as an immutable base object

setValue

public void setValue(Float newValue)

Description copied from interface: Mutable

Set the internal field to the new value

Specified by:

setValue in interface Mutable<Float>

Parameters:

newValue - the new value

setValue

public void setValue(float newValue)

Set the internal field to the new value

Parameters:

newValue - the new value

Since:

1.2.0 com.github.kilianB

floatValue

public float floatValue()

Specified by:

floatValue in class Number

Returns:

the current value as float primitive

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number