#include <src/main/decaf/lang/Character.h>

Inheritance diagram for decaf::lang::Character:

Public Member Functions
	Character (char value)

virtual int	compareTo (const Character &c) const
	Compares this Character instance with another.

virtual bool	operator== (const Character &c) const
	Compares equality between this object and the one passed.

virtual bool	operator< (const Character &c) const
	Compares this object to another and returns true if this object is considered to be less than the one passed.

virtual int	compareTo (const char &c) const
	Compares this Character instance with a char type.

virtual bool	operator== (const char &c) const
	Compares equality between this object and the one passed.

virtual bool	operator< (const char &c) const
	Compares this object to another and returns true if this object is considered to be less than the one passed.

bool	equals (const Character &c) const

bool	equals (const char &c) const

std::string	toString () const

virtual double	doubleValue () const
	Answers the double value which the receiver represents.

virtual float	floatValue () const
	Answers the float value which the receiver represents.

virtual unsigned char	byteValue () const
	Answers the byte value which the receiver represents.

virtual short	shortValue () const
	Answers the short value which the receiver represents.

virtual int	intValue () const
	Answers the int value which the receiver represents.

virtual long long	longValue () const
	Answers the long value which the receiver represents.

Public Member Functions inherited from decaf::lang::Number
virtual	~Number ()

virtual unsigned char	byteValue () const
	Answers the byte value which the receiver represents.

virtual double	doubleValue () const =0
	Answers the double value which the receiver represents.

virtual float	floatValue () const =0
	Answers the float value which the receiver represents.

virtual int	intValue () const =0
	Answers the int value which the receiver represents.

virtual long long	longValue () const =0
	Answers the long value which the receiver represents.

virtual short	shortValue () const
	Answers the short value which the receiver represents.

Public Member Functions inherited from decaf::lang::Comparable< Character >
virtual	~Comparable ()

virtual int	compareTo (const Character &value) const=0
	Compares this object with the specified object for order.

virtual bool	equals (const Character &value) const=0

virtual bool	operator== (const Character &value) const=0
	Compares equality between this object and the one passed.

virtual bool	operator< (const Character &value) const=0
	Compares this object to another and returns true if this object is considered to be less than the one passed.

Public Member Functions inherited from decaf::lang::Comparable< char >
virtual	~Comparable ()

virtual int	compareTo (const char &value) const=0
	Compares this object with the specified object for order.

virtual bool	equals (const char &value) const=0

virtual bool	operator== (const char &value) const=0
	Compares equality between this object and the one passed.

virtual bool	operator< (const char &value) const=0
	Compares this object to another and returns true if this object is considered to be less than the one passed.

Static Public Member Functions
static Character	valueOf (char value)
	Returns a Character instance representing the specified char value.

static bool	isWhitespace (char c)
	Indicates whether or not the given character is considered whitespace.

static bool	isDigit (char c)
	Indicates whether or not the given character is a digit.

static bool	isLowerCase (char c)
	Indicates whether or not the given character is a lower case character.

static bool	isUpperCase (char c)
	Indicates whether or not the given character is a upper case character.

static bool	isLetter (char c)
	Indicates whether or not the given character is a letter.

static bool	isLetterOrDigit (char c)
	Indicates whether or not the given character is either a letter or a digit.

static bool	isISOControl (char c)
	Answers whether the character is an ISO control character, which is a char that lays in the range of 0 to 1f and 7f to 9f.

static int	digit (char c, int radix)
	Returns the numeric value of the character ch in the specified radix.

static char	toLowerCase (char value)
	Returns the lower case equivalent for the specified character if the character is an upper case letter.

static char	toUpperCase (char value)
	Returns the upper case equivalent for the specified character if the character is a lower case letter.

Static Public Attributes
static const int	MIN_RADIX
	The minimum radix available for conversion to and from strings.

static const int	MAX_RADIX
	The maximum radix available for conversion to and from strings.

static const char	MIN_VALUE
	The minimum value that a signed char can take on.

static const char	MAX_VALUE
	The maximum value that a signed char can take on.

static const int	SIZE
	The size of the primitive character in bits.

Constructor & Destructor Documentation

◆ Character()

decaf::lang::Character::Character ( char value )

Parameters

value - char to wrap.

Member Function Documentation

◆ byteValue()

virtual unsigned char decaf::lang::Character::byteValue ( ) const

inlinevirtual

Answers the byte value which the receiver represents.

Returns: int the value of the receiver.

Reimplemented from decaf::lang::Number.

◆ compareTo() [1/2]

virtual int decaf::lang::Character::compareTo ( const char & c ) const

inlinevirtual

Compares this Character instance with a char type.

Parameters

c	the char instance to be compared

Returns: zero if this object represents the same char value as the argument; a positive value if this object represents a value greater than the passed in value, and -1 if this object represents a value less than the passed in value.

Implements decaf::lang::Comparable< char >.

◆ compareTo() [2/2]

virtual int decaf::lang::Character::compareTo ( const Character & c ) const

inlinevirtual

Compares this Character instance with another.

Parameters

c	the Character instance to be compared

Returns: zero if this object represents the same char value as the argument; a positive value if this object represents a value greater than the passed in value, and -1 if this object represents a value less than the passed in value.

Implements decaf::lang::Comparable< Character >.

◆ digit()

static int decaf::lang::Character::digit	(	char	c,
		int	radix
	)

static

Returns the numeric value of the character ch in the specified radix.

If the radix is not in the range MIN_RADIX <= radix <= MAX_RADIX or if the value of ch is not a valid digit in the specified radix, -1 is returned. A character is a valid digit if at least one of the following is true:

The method isDigit is true of the character and the single-character decomposition is less than the specified radix. In this case the decimal digit value is returned.
The character is one of the uppercase Latin letters 'A' through 'Z' and its code is less than radix + 'A' - 10. In this case, ch - 'A' + 10 is returned.
The character is one of the lowercase Latin letters 'a' through 'z' and its code is less than radix + 'a' - 10. In this case, ch - 'a' + 10 is returned.

Parameters

c	the char to be converted
radix	the radix of the number

Returns: the numeric value of the number represented in the given radix

◆ doubleValue()

virtual double decaf::lang::Character::doubleValue ( ) const

inlinevirtual

Answers the double value which the receiver represents.

Returns: double the value of the receiver.

Implements decaf::lang::Number.

◆ equals() [1/2]

bool decaf::lang::Character::equals ( const char & c ) const

inlinevirtual

Returns: true if the two Characters have the same value.

Implements decaf::lang::Comparable< char >.

◆ equals() [2/2]

bool decaf::lang::Character::equals ( const Character & c ) const

inlinevirtual

Returns: true if the two Character Objects have the same value.

Implements decaf::lang::Comparable< Character >.

◆ floatValue()

virtual float decaf::lang::Character::floatValue ( ) const

inlinevirtual

Answers the float value which the receiver represents.

Returns: float the value of the receiver.

Implements decaf::lang::Number.

◆ intValue()

virtual int decaf::lang::Character::intValue ( ) const

inlinevirtual

Answers the int value which the receiver represents.

Returns: int the value of the receiver.

Implements decaf::lang::Number.

◆ isDigit()

static bool decaf::lang::Character::isDigit ( char c )

inlinestatic

Indicates whether or not the given character is a digit.

Parameters

c	The character whose value is being checked.

Returns: true if the character is a digit value.

◆ isISOControl()

static bool decaf::lang::Character::isISOControl ( char c )

inlinestatic

Answers whether the character is an ISO control character, which is a char that lays in the range of 0 to 1f and 7f to 9f.

Parameters

c	the character, including supplementary characters

Returns: true if the char is an ISO control character

◆ isLetter()

static bool decaf::lang::Character::isLetter ( char c )

inlinestatic

Indicates whether or not the given character is a letter.

Parameters

c	The character whose value is being checked.

Returns: true if the character is an ASCII letter value.

◆ isLetterOrDigit()

static bool decaf::lang::Character::isLetterOrDigit ( char c )

inlinestatic

Indicates whether or not the given character is either a letter or a digit.

Parameters

c	The character whose value is being checked.

Returns: true if the character is an ASCII letter or numeric value.

◆ isLowerCase()

static bool decaf::lang::Character::isLowerCase ( char c )

inlinestatic

Indicates whether or not the given character is a lower case character.

Parameters

c	The character whose value is being checked.

Returns: true if the character is a lower case ASCII value.

◆ isUpperCase()

static bool decaf::lang::Character::isUpperCase ( char c )

inlinestatic

Indicates whether or not the given character is a upper case character.

Parameters

c	The character whose value is being checked.

Returns: true if the character is a upper case ASCII value.

◆ isWhitespace()

static bool decaf::lang::Character::isWhitespace ( char c )

inlinestatic

Indicates whether or not the given character is considered whitespace.

Parameters

c	The character whose value is being checked.

Returns: true if the character is a whitespace value.

◆ longValue()

virtual long long decaf::lang::Character::longValue ( ) const

inlinevirtual

Answers the long value which the receiver represents.

Returns: long the value of the receiver.

Implements decaf::lang::Number.

◆ operator<() [1/2]

virtual bool decaf::lang::Character::operator< ( const char & c ) const

inlinevirtual

Compares this object to another and returns true if this object is considered to be less than the one passed.

This

Parameters

c	the value to be compared to this one.

Returns: true if this object is equal to the one passed.

Implements decaf::lang::Comparable< char >.

◆ operator<() [2/2]

virtual bool decaf::lang::Character::operator< ( const Character & c ) const

inlinevirtual

Compares this object to another and returns true if this object is considered to be less than the one passed.

Parameters

c	the value to be compared to this one.

Returns: true if this object is equal to the one passed.

Implements decaf::lang::Comparable< Character >.

◆ operator==() [1/2]

virtual bool decaf::lang::Character::operator== ( const char & c ) const

inlinevirtual

Compares equality between this object and the one passed.

Parameters

c	the value to be compared to this one.

Returns: true if this object is equal to the one passed.

Implements decaf::lang::Comparable< char >.

◆ operator==() [2/2]

virtual bool decaf::lang::Character::operator== ( const Character & c ) const

inlinevirtual

Compares equality between this object and the one passed.

Parameters

c	the value to be compared to this one.

Returns: true if this object is equal to the one passed.

Implements decaf::lang::Comparable< Character >.

◆ shortValue()

virtual short decaf::lang::Character::shortValue ( ) const

inlinevirtual

Answers the short value which the receiver represents.

Returns: int the value of the receiver.

Reimplemented from decaf::lang::Number.

◆ toLowerCase()

static char decaf::lang::Character::toLowerCase ( char value )

inlinestatic

Returns the lower case equivalent for the specified character if the character is an upper case letter.

Otherwise, the specified character is returned unchanged.

Parameters

value the character to convert if needed.

Returns: if value is an upper case character then its lower case counterpart, otherwise just returns value unchanged.

◆ toString()

std::string decaf::lang::Character::toString ( ) const

Returns: this Character Object as a String Representation

◆ toUpperCase()

static char decaf::lang::Character::toUpperCase ( char value )

inlinestatic

Returns the upper case equivalent for the specified character if the character is a lower case letter.

Otherwise, the specified character is returned unchanged.

Parameters

value the character to convert to upper case if needed.

Returns: if value is a lower case character then its upper case counterpart, otherwise just returns value unchanged.

◆ valueOf()

static Character decaf::lang::Character::valueOf ( char value )

inlinestatic

Returns a Character instance representing the specified char value.

Parameters

value the primitive char to wrap.

Returns: a new Character instance that wraps this value.

Field Documentation

◆ MAX_RADIX

const int decaf::lang::Character::MAX_RADIX

static

The maximum radix available for conversion to and from strings.

◆ MAX_VALUE

const char decaf::lang::Character::MAX_VALUE

static

The maximum value that a signed char can take on.

◆ MIN_RADIX

const int decaf::lang::Character::MIN_RADIX

static

The minimum radix available for conversion to and from strings.

◆ MIN_VALUE

const char decaf::lang::Character::MIN_VALUE

static

The minimum value that a signed char can take on.

◆ SIZE

const int decaf::lang::Character::SIZE

static

The size of the primitive character in bits.

The documentation for this class was generated from the following file:

src/main/decaf/lang/Character.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Constructor & Destructor Documentation

◆ Character()

Member Function Documentation

◆ byteValue()

◆ compareTo() [1/2]

◆ compareTo() [2/2]

◆ digit()

◆ doubleValue()

◆ equals() [1/2]

◆ equals() [2/2]

◆ floatValue()

◆ intValue()

◆ isDigit()

◆ isISOControl()

◆ isLetter()

◆ isLetterOrDigit()

◆ isLowerCase()

◆ isUpperCase()

◆ isWhitespace()

◆ longValue()

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ shortValue()

◆ toLowerCase()

◆ toString()

◆ toUpperCase()

◆ valueOf()

Field Documentation

◆ MAX_RADIX

◆ MAX_VALUE

◆ MIN_RADIX

◆ MIN_VALUE

◆ SIZE