Package org.apache.commons.lang3.mutable
Class MutableBoolean
java.lang.Object
org.apache.commons.lang3.mutable.MutableBoolean
- All Implemented Interfaces:
Serializable
,Comparable<MutableBoolean>
,Mutable<Boolean>
public class MutableBoolean
extends Object
implements Mutable<Boolean>, Serializable, Comparable<MutableBoolean>
A mutable
boolean
wrapper.
Note that as MutableBoolean does not extend Boolean, it is not treated by String.format as a Boolean parameter.
- Since:
- 2.2
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Required for serialization support.private boolean
The mutable value. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new MutableBoolean with the default value of false.MutableBoolean
(boolean value) Constructs a new MutableBoolean with the specified value.MutableBoolean
(Boolean value) Constructs a new MutableBoolean with the specified value. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the value of this MutableBoolean as a boolean.int
compareTo
(MutableBoolean other) Compares this mutable to another in ascending order.boolean
Compares this object to the specified object.getValue()
Gets the value as a Boolean instance.int
hashCode()
Returns a suitable hash code for this mutable.boolean
isFalse()
Checks if the current value isfalse
.boolean
isTrue()
Checks if the current value istrue
.void
setFalse()
Sets the value to false.void
setTrue()
Sets the value to true.void
setValue
(boolean value) Sets the value.void
Sets the value from any Boolean instance.Gets this mutable as an instance of Boolean.toString()
Returns the String value of this mutable.
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDRequired for serialization support.- See Also:
-
value
private boolean valueThe mutable value.
-
-
Constructor Details
-
MutableBoolean
public MutableBoolean()Constructs a new MutableBoolean with the default value of false. -
MutableBoolean
public MutableBoolean(boolean value) Constructs a new MutableBoolean with the specified value.- Parameters:
value
- the initial value to store
-
MutableBoolean
Constructs a new MutableBoolean with the specified value.- Parameters:
value
- the initial value to store, not null- Throws:
NullPointerException
- if the object is null
-
-
Method Details
-
booleanValue
public boolean booleanValue()Returns the value of this MutableBoolean as a boolean.- Returns:
- the boolean value represented by this object.
-
compareTo
Compares this mutable to another in ascending order.- Specified by:
compareTo
in interfaceComparable<MutableBoolean>
- Parameters:
other
- the other mutable to compare to, not null- Returns:
- negative if this is less, zero if equal, positive if greater where false is less than true
-
equals
Compares this object to the specified object. The result istrue
if and only if the argument is notnull
and is anMutableBoolean
object that contains the sameboolean
value as this object. -
getValue
Gets the value as a Boolean instance. -
hashCode
public int hashCode()Returns a suitable hash code for this mutable. -
isFalse
public boolean isFalse()Checks if the current value isfalse
.- Returns:
true
if the current value isfalse
- Since:
- 2.5
-
isTrue
public boolean isTrue()Checks if the current value istrue
.- Returns:
true
if the current value istrue
- Since:
- 2.5
-
setFalse
public void setFalse()Sets the value to false.- Since:
- 3.3
-
setTrue
public void setTrue()Sets the value to true.- Since:
- 3.3
-
setValue
public void setValue(boolean value) Sets the value.- Parameters:
value
- the value to set
-
setValue
Sets the value from any Boolean instance.- Specified by:
setValue
in interfaceMutable<Boolean>
- Parameters:
value
- the value to set, not null- Throws:
NullPointerException
- if the object is null
-
toBoolean
Gets this mutable as an instance of Boolean.- Returns:
- a Boolean instance containing the value from this mutable, never null
- Since:
- 2.5
-
toString
Returns the String value of this mutable.
-