javolution.text

Class CharArray

java.lang.Object

javolution.text.CharArray

All Implemented Interfaces:

CharSequence, Comparable<CharSequence>

public final class CharArray
extends Object
implements CharSequence, Comparable<CharSequence>

A CharSequence backed up by a char array. Instances of this class are typically used/reused to provide CharSequence views over existing character buffers.

Instances of this classes have the following properties:

• They support equality or lexical comparison with any CharSequence (e.g. String).
• They have the same hashcode than String and can be used to retrieve data from maps for which the keys are String instances.
• They support fast conversions to primitive types (e.g. Boolean, int).

Version:

5.3, January 10, 2007

Author:

Jean-Marie Dautelle

Constructor Summary

Constructors

Constructor and Description
CharArray() Default constructor (empty character array).
CharArray(int capacity) Creates a character array of specified default capacity.
CharArray(String string) Creates a character array from the specified String.

Method Summary

Methods

Modifier and Type	Method and Description
char[]	array() Returns the underlying array.
char	charAt(int index)
int	compareTo(CharSequence seq) Compares this character array with the specified character sequence lexicographically.
boolean	equals(CharArray that) Compares this character array against the specified CharArray.
boolean	equals(Object that) Compares this character sequence against the specified object (String or CharSequence).
boolean	equals(String str) Compares this character array against the specified String.
void	getChars(int start, int end, char[] dest, int destPos)
int	hashCode() Returns the hash code for this CharArray.
int	indexOf(char c) Returns the index within this character sequence of the first occurrence of the specified character searching forward.
int	indexOf(CharSequence csq) Returns the index within this character sequence of the first occurrence of the specified characters sequence searching forward.
int	length() Returns the length of this character sequence.
int	offset() Returns the offset of the first character in the underlying array.
CharArray	setArray(char[] array, int offset, int length) Sets the underlying array of this CharArray.
CharSequence	subSequence(int start, int end)
boolean	toBoolean() Returns the boolean represented by this character array.
double	toDouble() Returns the double represented by this character array.
float	toFloat() Returns the float represented by this character array.
int	toInt() Returns the decimal int represented by this character array.
int	toInt(int radix) Returns the int represented by this character array in the specified radix.
long	toLong() Returns the decimal long represented by this character array.
long	toLong(int radix) Returns the decimal long represented by this character array in the specified radix.
String	toString() Returns the String corresponding to this character sequence.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CharArray

public CharArray()

Default constructor (empty character array).

CharArray

public CharArray(int capacity)

Creates a character array of specified default capacity.

Parameters:

capacity - the backing array default capacity.

CharArray

public CharArray(String string)

Creates a character array from the specified String.

Parameters:

string - the string source.

Method Detail

array

public char[] array()

Returns the underlying array.

Returns:

the underlying array.

length

public int length()

Returns the length of this character sequence.

Specified by:

length in interface CharSequence

Returns:

the number of characters (16-bits Unicode).

offset

public int offset()

Returns the offset of the first character in the underlying array.

Returns:

the offset of the first character.

setArray

public CharArray setArray(char[] array,
                 int offset,
                 int length)

Sets the underlying array of this CharArray.

Parameters:

offset - the new offset.

array - the new underlying array.

length - the new length.

Returns:

this

indexOf

public final int indexOf(CharSequence csq)

Returns the index within this character sequence of the first occurrence of the specified characters sequence searching forward.

Parameters:

csq - a character sequence searched for.

Returns:

the index of the specified character sequence in the range [0, length()[ or -1 if the character sequence is not found.

indexOf

public final int indexOf(char c)

Returns the index within this character sequence of the first occurrence of the specified character searching forward.

Parameters:

c - the character to search for.

Returns:

the indext of the specified character in the range [0, length()[ or -1 if the character is not found.

toString

public String toString()

Returns the String corresponding to this character sequence. The String returned is always allocated on the heap and can safely be referenced elsewhere.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

the java.lang.String for this character sequence.

hashCode

public int hashCode()

Returns the hash code for this CharArray.

Note: Returns the same hashCode as java.lang.String (consistent with equals(java.lang.Object))

Overrides:

hashCode in class Object

Returns:

the hash code value.

equals

public boolean equals(Object that)

Compares this character sequence against the specified object (String or CharSequence).

Overrides:

equals in class Object

Parameters:

that - the object to compare with.

Returns:

true if both objects represent the same sequence; false otherwise.

equals

public boolean equals(CharArray that)

Compares this character array against the specified CharArray.

Parameters:

that - the character array to compare with.

Returns:

true if both objects represent the same sequence; false otherwise.

equals

public boolean equals(String str)

Compares this character array against the specified String. In case of equality, the CharArray keeps a reference to the String for future comparisons.

Parameters:

str - the string to compare with.

Returns:

true if both objects represent the same sequence; false otherwise.

compareTo

public int compareTo(CharSequence seq)

Compares this character array with the specified character sequence lexicographically.

Specified by:

compareTo in interface Comparable<CharSequence>

Parameters:

seq - the character sequence to be compared.

Returns:

Equalities.LEXICAL.compare(this, seq)

Throws:

ClassCastException - if the specifed object is not a CharSequence.

toBoolean

public boolean toBoolean()

Returns the boolean represented by this character array.

Returns:

the corresponding boolean value.

Throws:

NumberFormatException - if this character sequence does not contain a parsable boolean.

toInt

public int toInt()

Returns the decimal int represented by this character array.

Returns:

toInt(10)

Throws:

NumberFormatException - if this character sequence does not contain a parsable int.

toInt

public int toInt(int radix)

Returns the int represented by this character array in the specified radix.

Parameters:

radix - the radix (e.g. 16 for hexadecimal).

Returns:

the corresponding int value.

Throws:

NumberFormatException - if this character sequence does not contain a parsable int.

toLong

public long toLong()

Returns the decimal long represented by this character array.

Returns:

the corresponding long value.

Throws:

NumberFormatException - if this character sequence does not contain a parsable long.

toLong

public long toLong(int radix)

Returns the decimal long represented by this character array in the specified radix.

Parameters:

radix - the radix (e.g. 16 for hexadecimal).

Returns:

the corresponding long value.

Throws:

NumberFormatException - if this character sequence does not contain a parsable long.

toFloat

public float toFloat()

Returns the float represented by this character array.

Returns:

the corresponding float value.

Throws:

NumberFormatException - if this character sequence does not contain a parsable float.

toDouble

public double toDouble()

Returns the double represented by this character array.

Returns:

the corresponding double value.

Throws:

NumberFormatException - if this character sequence does not contain a parsable double.

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                       int end)

Specified by:

subSequence in interface CharSequence

getChars

public void getChars(int start,
            int end,
            char[] dest,
            int destPos)