com.landawn.abacus.util

Class MutableBoolean

java.lang.Object

com.landawn.abacus.util.MutableBoolean

All Implemented Interfaces:

Mutable, java.io.Serializable, java.lang.Comparable<MutableBoolean>

public final class MutableBoolean
extends java.lang.Object
implements Mutable, java.io.Serializable, java.lang.Comparable<MutableBoolean>

Note: it's copied from Apache Commons Lang developed at The Apache Software Foundation (http://www.apache.org/), or under the Apache License 2.0. The methods copied from other products/frameworks may be modified in this class.

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

Version:

$Id: MutableBoolean.java 1669791 2015-03-28 15:22:59Z britter $

See Also:

Boolean, Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(MutableBoolean other) Compares this mutable to another in ascending order.
boolean	equals(java.lang.Object obj) Compares this object to the specified object.
boolean	getAndInvert()
boolean	getAndSet(boolean value)
boolean	getValue() Deprecated. replace by value().
int	hashCode() Returns a suitable hash code for this mutable.
void	invert()
boolean	invertAndGet()
boolean	isFalse() Checks if the current value is false.
boolean	isTrue() Checks if the current value is true.
static MutableBoolean	of(boolean value)
boolean	setAndGet(boolean value)
void	setFalse() Sets the value to true.
<E extends java.lang.Exception> boolean	setIf(boolean newValue, Try.BooleanBiPredicate<E> predicate) Set with the specified new value and returns true if predicate returns true.
<E extends java.lang.Exception> boolean	setIf(boolean newValue, Try.BooleanPredicate<E> predicate) Set with the specified new value and returns true if predicate returns true.
void	setTrue() Sets the value to false.
void	setValue(boolean value) Sets the value.
java.lang.String	toString() Returns the String value of this mutable.
boolean	value()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static MutableBoolean of(boolean value)

value

public boolean value()

getValue

@Deprecated
public boolean getValue()

Deprecated. replace by value().

Gets the value as a Boolean instance.

Returns:

the value as a Boolean, never null

setValue

public void setValue(boolean value)

Sets the value.

Parameters:

value - the value to set

getAndSet

public boolean getAndSet(boolean value)

setAndGet

public boolean setAndGet(boolean value)

getAndInvert

public boolean getAndInvert()

invertAndGet

public boolean invertAndGet()

setIf

public <E extends java.lang.Exception> boolean setIf(boolean newValue,
                                                     Try.BooleanPredicate<E> predicate)
                                              throws E extends java.lang.Exception

Set with the specified new value and returns true if predicate returns true. Otherwise just return false without setting the value to new value.

Parameters:

newValue -

predicate - - test the current value.

Returns:

Throws:

E extends java.lang.Exception

setIf

public <E extends java.lang.Exception> boolean setIf(boolean newValue,
                                                     Try.BooleanBiPredicate<E> predicate)
                                              throws E extends java.lang.Exception

Set with the specified new value and returns true if predicate returns true. Otherwise just return false without setting the value to new value.

Parameters:

newValue -

predicate - the first parameter is the current value, the second parameter is the new value.

Returns:

Throws:

E extends java.lang.Exception

setFalse

public void setFalse()

Sets the value to true.

Since:

3.3

setTrue

public void setTrue()

Sets the value to false.

Since:

3.3

isTrue

public boolean isTrue()

Checks if the current value is true.

Returns:

true if the current value is true

Since:

2.5

isFalse

public boolean isFalse()

Checks if the current value is false.

Returns:

true if the current value is false

Since:

2.5

invert

public void invert()

compareTo

public int compareTo(MutableBoolean other)

Compares this mutable to another in ascending order.

Specified by:

compareTo in interface java.lang.Comparable<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

public boolean equals(java.lang.Object obj)

Compares this object to the specified object. The result is true if and only if the argument is not null and is an MutableBoolean object that contains the same boolean value as this object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare with, null returns false

Returns:

true if the objects are the same; false otherwise.

hashCode

public int hashCode()

Returns a suitable hash code for this mutable.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code returned by Boolean.TRUE or Boolean.FALSE

toString

public java.lang.String toString()

Returns the String value of this mutable.

Overrides:

toString in class java.lang.Object

Returns:

the mutable value as a string