Package com.helger.base.numeric.mutable

Class MutableChar

java.lang.Object

java.lang.Number

com.helger.base.numeric.mutable.AbstractMutableNumeric<MutableChar>

com.helger.base.numeric.mutable.AbstractMutableInteger<MutableChar>

com.helger.base.numeric.mutable.MutableChar

All Implemented Interfaces:

ICloneable<MutableChar>, IComparable<MutableChar>, INumber, IMutableInteger<MutableChar>, IMutableNumeric<MutableChar>, IMutableObject<MutableChar>, IGenericImplTrait<MutableChar>, Serializable, Comparable<MutableChar>

@NotThreadSafe
public class MutableChar
extends AbstractMutableInteger<MutableChar>

Object wrapper around a char so that it can be passed a final object but is mutable.

Author:

Philip Helger

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MutableChar(char cValue)	Initialize with a certain value.
MutableChar(int cValue)	Initialize with a certain int value.
MutableChar(@NonNull MutableChar aOther)	Copy constructor.
MutableChar(@NonNull Character aValue)	Initialize with a certain value.

Method Summary

Modifier and Type	Method	Description
char	charValue()
int	compareTo(@NonNull MutableChar rhs)
int	dec()	Decrement by 1 and return the modified value.
int	dec(int nDelta)	Decrement by the given delta and return the modified value.
int	dec(@NonNull MutableChar aMC)	Decrement by the given delta and return the modified value.
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.
char	getAndInc()	Get the current value and then increment by 1.
@NonNull MutableChar	getClone()
int	hashCode()
int	inc()	Increment by 1 and return the modified value.
int	inc(int nDelta)	Increment by the given delta and return the modified value.
int	inc(@NonNull MutableChar aMC)	Increment by the given delta and return the modified value.
char	incAndGet()	Increment by 1 and then get the new value.
int	intValue()	Returns the value of the specified number as an int, which may involve rounding or truncation.
boolean	is0()
boolean	isEven()
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.
@NonNull EChange	set(char cValue)	Set a new value.
@NonNull EChange	set(int cValue)	Set a new value.
@NonNull EChange	set(@NonNull MutableChar aMC)	Set a new value.
String	toString()

Methods inherited from class com.helger.base.numeric.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.base.compare.IComparable

isEQ, isGE, isGT, isLE, isLT, isNE

Methods inherited from interface com.helger.base.trait.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.base.numeric.mutable.IMutableInteger

isOdd

Methods inherited from interface com.helger.base.numeric.mutable.IMutableNumeric

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

Methods inherited from interface com.helger.base.numeric.INumber

byteValue, shortValue

Constructor Details

MutableChar

public MutableChar(int cValue)

Initialize with a certain int value. If the value does not fit into a char, the value is cut!

Parameters:

cValue - The value to be used.

MutableChar

public MutableChar(@NonNull Character aValue)

Initialize with a certain value.

Parameters:

aValue - The value to be used.

MutableChar

public MutableChar(char cValue)

Initialize with a certain value.

Parameters:

cValue - The value to be used.

MutableChar

public MutableChar(@NonNull MutableChar aOther)

Copy constructor.

Parameters:

aOther - The object to copy from. May not be null.

Method Details

charValue

public char charValue()

Returns:

The current char value.

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 int inc()

Increment by 1 and return the modified value.

Returns:

The by 1 incremented value.

inc

public int inc(int nDelta)

Increment by the given delta and return the modified value.

Parameters:

nDelta - The delta to add.

Returns:

The new value after incrementing.

inc

public int inc(@NonNull MutableChar aMC)

Increment by the given delta and return the modified value.

Parameters:

aMC - The delta to add. May not be null.

Returns:

The new value after incrementing.

dec

public int dec()

Decrement by 1 and return the modified value.

Returns:

The by 1 decremented value.

dec

public int dec(int nDelta)

Decrement by the given delta and return the modified value.

Parameters:

nDelta - The delta to subtract.

Returns:

The new value after decrementing.

dec

public int dec(@NonNull MutableChar aMC)

Decrement by the given delta and return the modified value.

Parameters:

aMC - The delta to subtract. May not be null.

Returns:

The new value after decrementing.

set

public @NonNull EChange set(int cValue)

Set a new value.

Parameters:

cValue - The new value to set. If the value does not fit into a char, it is cut.

Returns:

EChange.CHANGED if the value was changed.

set

public @NonNull EChange set(@NonNull MutableChar aMC)

Set a new value.

Parameters:

aMC - The new value to set. May not be null.

Returns:

EChange.CHANGED if the value was changed.

set

public @NonNull EChange set(char cValue)

Set a new value.

Parameters:

cValue - The new value to set.

Returns:

EChange.CHANGED if the value was changed.

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

isEven

public boolean isEven()

Returns:

true if the value is even

getAndInc

public char getAndInc()

Get the current value and then increment by 1.

Returns:

The value before incrementing.

incAndGet

public char incAndGet()

Increment by 1 and then get the new value.

Returns:

The value after incrementing.

compareTo

public int compareTo(@NonNull MutableChar rhs)

getClone

public @NonNull MutableChar 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