Class CharBuffer

public static CharBuffer allocate(int capacity)

Allocates a new CharBuffer object with a given capacity.

public final char[] array()

Returns the char array that backs this buffer.

Throws:

ReadOnlyBufferException - If this buffer is read-only.

UnsupportedOperationException - If this buffer is not backed by an accessible array.

public final int arrayOffset()

Returns the offset within this buffer's backing array of the first element.

Throws:

ReadOnlyBufferException - If this buffer is read-only.

UnsupportedOperationException - If this buffer is not backed by an accessible array.

public CharBuffer asReadOnlyBuffer()

Creates a new read-only CharBuffer that shares this buffer's content.

public final char charAt(int index)

Returns the character at position() + index.

Specified by:

charAt in interface CharSequence

Throws:

IndexOutOfBoundsException - If index is negative not smaller than remaining().

public CharBuffer compact()

Compacts this buffer.

Throws:

ReadOnlyBufferException - If this buffer is read-only.

public int compareTo(Object obj)

Compares two CharBuffer objects.

Specified by:

compareTo in interface Comparable

Throws:

ClassCastException - If obj is not an object derived from CharBuffer.

public CharBuffer duplicate()

Creates a new CharBuffer that shares this buffer's content.

public boolean equals(Object obj)

Checks if this buffer is equal to obj.

Overrides:

equals in interface Object

public char get()

Reads the char at this buffer's current position, and then increments the position.

Throws:

BufferUnderflowException - If there are no remaining chars in this buffer.

public CharBuffer get(char[] dst)

This method transfers chars from this buffer into the given destination array.

Parameters:

dst - The byte array to write into.

Throws:

BufferUnderflowException - If there are fewer than dst.length chars remaining in this buffer.

public CharBuffer get(char[] dst,
                      int offset,
                      int length)

This method transfers chars from this buffer into the given destination array. Before the transfer, it checks if there are fewer than length chars remaining in this buffer.

Parameters:

dst - The destination array

offset - The offset within the array of the first char to be written; must be non-negative and no larger than dst.length.

length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset.

Throws:

BufferUnderflowException - If there are fewer than length chars remaining in this buffer.

IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold.

public char get(int index)

Absolute get method.

Throws:

IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit.

public final boolean hasArray()

Tells whether ot not this buffer is backed by an accessible char array.

public int hashCode()

Calculates a hash code for this buffer. This is done with int arithmetic, where ** represents exponentiation, by this formula:
s[position()] + 31 + (s[position()+1] + 30)*31**1 + ... + (s[limit()-1]+30)*31**(limit()-1). Where s is the buffer data. Note that the hashcode is dependent on buffer content, and therefore is not useful if the buffer content may change.

Overrides:

hashCode in interface Object

public boolean isDirect()

Tells wether or not this buffer is direct.

public final int length()

Returns the length of the remaining chars in this buffer.

Specified by:

length in interface CharSequence

public ByteOrder order()

Returns the byte order of this buffer.

public CharBuffer put(char b)

Writes the char at this buffer's current position, and then increments the position.

Throws:

BufferOverflowException - If there no remaining chars in this buffer.

ReadOnlyBufferException - If this buffer is read-only.

public final CharBuffer put(char[] src)

Writes the content of the the char array src into the buffer.

Parameters:

src - The array to copy into the buffer.

Throws:

BufferOverflowException - If there is insufficient space in this buffer for the remaining chars in the source array.

ReadOnlyBufferException - If this buffer is read-only.

public CharBuffer put(char[] src,
                      int offset,
                      int length)

Writes the content of the the char array src into the buffer. Before the transfer, it checks if there is fewer than length space remaining in this buffer.

Parameters:

src - The array to copy into the buffer.

offset - The offset within the array of the first byte to be read; must be non-negative and no larger than src.length.

length - The number of bytes to be read from the given array; must be non-negative and no larger than src.length - offset.

Throws:

BufferOverflowException - If there is insufficient space in this buffer for the remaining chars in the source array.

IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold

ReadOnlyBufferException - If this buffer is read-only.

public CharBuffer put(int index,
                      char b)

Absolute put method.

Throws:

IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit.

ReadOnlyBufferException - If this buffer is read-only.

public final CharBuffer put(String str)

Relative put method.

Throws:

BufferOverflowException - If there is insufficient space in this buffer.

ReadOnlyBufferException - If this buffer is read-only.

public CharBuffer put(String str,
                      int start,
                      int length)

Relative put method.

Throws:

BufferOverflowException - If there is insufficient space in this buffer.

IndexOutOfBoundsException - If the preconditions on the start and end parameters do not hold.

ReadOnlyBufferException - If this buffer is read-only.

public CharBuffer put(CharBuffer src)

Writes the content of the the CharBUFFER src into the buffer. Before the transfer, it checks if there is fewer than src.remaining() space remaining in this buffer.

Parameters:

src - The source data.

Throws:

BufferOverflowException - If there is insufficient space in this buffer for the remaining chars in the source buffer.

IllegalArgumentException - If the source buffer is this buffer.

ReadOnlyBufferException - If this buffer is read-only.

public CharBuffer slice()

Creates a new CharBuffer whose content is a shared subsequence of this buffer's content.

public CharSequence subSequence(int start,
                                int length)

Creates a new character buffer that represents the specified subsequence of this buffer, relative to the current position.

Specified by:

subSequence in interface CharSequence

Throws:

IndexOutOfBoundsException - If the preconditions on start and end do not hold.

public String toString()

Returns the remaining content of the buffer as a string.

Specified by:

toString in interface CharSequence

Overrides:

toString in interface Object

public static final CharBuffer wrap(char[] array)

Wraps a char array into a CharBuffer object.

Parameters:

array - the array to wrap

Returns:

a new CharBuffer object

public static final CharBuffer wrap(char[] array,
                                    int offset,
                                    int length)

Wraps a char array into a CharBuffer object.

Parameters:

array - the array to wrap

offset - the offset of the region in the array to wrap

length - the length of the region in the array to wrap

Returns:

a new CharBuffer object

Throws:

IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold

public static final CharBuffer wrap(CharSequence seq)

Wraps a character sequence into a CharBuffer object.

Parameters:

seq - the sequence to wrap

Returns:

a new CharBuffer object

public static final CharBuffer wrap(CharSequence seq,
                                    int start,
                                    int end)

Wraps a character sequence into a CharBuffer object.

Parameters:

seq - the sequence to wrap

start - the index of the first character to wrap

end - the index of the first character not to wrap

Returns:

a new CharBuffer object

Throws:

IndexOutOfBoundsException - If the preconditions on the offset and length parameters do not hold