com.phloc.commons.mutable

Class MutableChar

java.lang.Object

java.lang.Number

com.phloc.commons.mutable.MutableChar

All Implemented Interfaces:

ICloneable<MutableChar>, IMutable<MutableChar>, IMutableInteger<MutableChar>, IMutableNumeric<MutableChar>, Serializable, Comparable<MutableChar>

@NotThreadSafe
public final class MutableChar
extends Number
implements IMutableInteger<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.

Method Summary

Methods

Modifier and Type	Method and Description
char	charValue()
int	compareTo(MutableChar rhs)
int	dec()
int	dec(int nDelta)
double	doubleValue()
boolean	equals(Object o)
float	floatValue()
Character	getAsCharacter()
MutableChar	getClone()
int	hashCode()
int	inc() Increment by 1 and return the modified value.
int	inc(int nDelta)
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)
String	toString()

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.

Method Detail

charValue

public char charValue()

getAsCharacter

@Nonnull
public Character getAsCharacter()

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)

dec

public int dec()

dec

public int dec(int nDelta)

set

@Nonnull
public EChange set(int cValue)

set

@Nonnull
public EChange set(char cValue)

is0

public boolean is0()

Specified by:

is0 in interface IMutableNumeric<MutableChar>

Returns:

true if the value is 0

isNot0

public boolean isNot0()

Specified by:

isNot0 in interface IMutableNumeric<MutableChar>

Returns:

true if the value is not 0

isSmaller0

public boolean isSmaller0()

Specified by:

isSmaller0 in interface IMutableNumeric<MutableChar>

Returns:

true if the value is < 0

isSmallerOrEqual0

public boolean isSmallerOrEqual0()

Specified by:

isSmallerOrEqual0 in interface IMutableNumeric<MutableChar>

Returns:

true if the value is ≤ 0

isGreater0

public boolean isGreater0()

Specified by:

isGreater0 in interface IMutableNumeric<MutableChar>

Returns:

true if the value is > 0

isGreaterOrEqual0

public boolean isGreaterOrEqual0()

Specified by:

isGreaterOrEqual0 in interface IMutableNumeric<MutableChar>

Returns:

true if the value is ≥ 0

isEven

public boolean isEven()

Specified by:

isEven in interface IMutableInteger<MutableChar>

Returns:

true if the value is even

isOdd

public boolean isOdd()

Specified by:

isOdd in interface IMutableInteger<MutableChar>

Returns:

true if the value is odd

compareTo

public int compareTo(@Nonnull
            MutableChar rhs)

Specified by:

compareTo in interface Comparable<MutableChar>

getClone

@Nonnull
public MutableChar getClone()

Specified by:

getClone in interface ICloneable<MutableChar>

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