Package dev.brachtendorf.mutable

Class MutableBoolean

java.lang.Object

dev.brachtendorf.mutable.MutableBoolean

All Implemented Interfaces:

Mutable<Boolean>, Serializable, Comparable<MutableBoolean>

public class MutableBoolean
extends Object
implements Mutable<Boolean>, Comparable<MutableBoolean>, Serializable

Mutable class wrapper for boolean 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
MutableBoolean()	Create a mutable Boolean with an initial value of False
MutableBoolean(boolean initialValue)	Create a mutable Boolean.

Method Summary

Modifier and Type	Method	Description
boolean	booleanValue()
int	compareTo(MutableBoolean o)
boolean	equals(Object obj)
Boolean	getValue()	Get an object encapsulating the current value
int	hashCode()
void	invertValue()	Invert the value of the internal field
void	setValue(boolean newValue)	Set the internal field to the new value
void	setValue(Boolean newValue)	Set the internal field to the new value

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableBoolean

public MutableBoolean()

Create a mutable Boolean with an initial value of False

MutableBoolean

public MutableBoolean(boolean initialValue)

Create a mutable Boolean.

Parameters:

initialValue - the initial value of the integer

Method Detail

getValue

public Boolean getValue()

Description copied from interface: Mutable

Get an object encapsulating the current value

Specified by:

getValue in interface Mutable<Boolean>

Returns:

The current value as an immutable base object

setValue

public void setValue(Boolean newValue)

Description copied from interface: Mutable

Set the internal field to the new value

Specified by:

setValue in interface Mutable<Boolean>

Parameters:

newValue - the new value

setValue

public void setValue(boolean newValue)

Set the internal field to the new value

Parameters:

newValue - the new value

Since:

1.2.0 com.github.kilianB

booleanValue

public boolean booleanValue()

invertValue

public void invertValue()

Invert the value of the internal field

compareTo

public int compareTo(MutableBoolean o)

Specified by:

compareTo in interface Comparable<MutableBoolean>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object