com.helger.commons.mutable

Class MutableChar

java.lang.Object

java.lang.Number

com.helger.commons.mutable.AbstractMutableNumeric<IMPLTYPE>

com.helger.commons.mutable.AbstractMutableInteger<MutableChar>

com.helger.commons.mutable.MutableChar

All Implemented Interfaces:

ICloneable<MutableChar>, IMutableInteger<MutableChar>, IMutableNumeric<MutableChar>, IMutableObject<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

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_VALUE The default value if the default constructor is used.

Constructor Summary

Constructors

Constructor and Description
MutableChar() Initialize with default value 0.
MutableChar(char cValue) Initialize with a certain value.
MutableChar(Character aValue) Initialize with a certain value.
MutableChar(int cValue) Initialize with a certain int value.
MutableChar(MutableChar aOther)

Method Summary

Modifier and Type	Method and Description
char	charValue()
int	compareTo(MutableChar rhs)
int	dec()
int	dec(int nDelta)
int	dec(MutableChar aMC)
double	doubleValue()
boolean	equals(Object o)
float	floatValue()
MutableChar	getClone()
int	hashCode()
int	inc() Increment by 1 and return the modified value.
int	inc(int nDelta)
int	inc(MutableChar aMC)
int	intValue()
boolean	is0()
boolean	isEven()
boolean	isGreater0()
boolean	isGreaterOrEqual0()
boolean	isNot0()
boolean	isOdd()
boolean	isSmaller0()
boolean	isSmallerOrEqual0()
long	longValue()
EChange	set(char cValue)
EChange	set(int cValue)
EChange	set(MutableChar aMC)
String	toString()

Methods inherited from class com.helger.commons.mutable.AbstractMutableNumeric

getAsBigDecimal, getAsBigInteger, getAsByte, getAsCharacter, getAsDouble, getAsFloat, getAsInteger, getAsLong, getAsShort, 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

Field Detail

DEFAULT_VALUE

public static final char DEFAULT_VALUE

The default value if the default constructor is used.

See Also:

Constant Field Values

Constructor Detail

MutableChar

public MutableChar()

Initialize with default value 0.

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)

Method Detail

charValue

public char charValue()

floatValue

public float floatValue()

Specified by:

floatValue in class Number

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

inc

public int inc()

Increment by 1 and return the modified value.

Returns:

The by 1 incremented value.

inc

public int inc(int nDelta)

inc

public int inc(@Nonnull
               MutableChar aMC)

dec

public int dec()

dec

public int dec(int nDelta)

dec

public int dec(@Nonnull
               MutableChar aMC)

set

@Nonnull
public EChange set(int cValue)

set

@Nonnull
public EChange set(@Nonnull
                             MutableChar aMC)

set

@Nonnull
public EChange set(char cValue)

is0

public boolean is0()

Returns:

true if the value is 0

isNot0

public boolean isNot0()

Returns:

true if the value is not 0

isSmaller0

public boolean isSmaller0()

Returns:

true if the value is < 0

isSmallerOrEqual0

public boolean isSmallerOrEqual0()

Returns:

true if the value is ≤ 0

isGreater0

public boolean isGreater0()

Returns:

true if the value is > 0

isGreaterOrEqual0

public boolean isGreaterOrEqual0()

Returns:

true if the value is ≥ 0

isEven

public boolean isEven()

Returns:

true if the value is even

isOdd

public boolean isOdd()

Returns:

true if the value is odd

compareTo

public int compareTo(@Nonnull
                     MutableChar rhs)

getClone

@Nonnull
public 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