java.nio

Class CharBuffer

Implemented Interfaces:
Appendable, CharSequence, Comparable<T>, Readable

public abstract class CharBuffer
extends Buffer
implements Comparable<T>, CharSequence, Readable, Appendable

Since:
1.4

Method Summary

static CharBuffer
allocate(int capacity)
Allocates a new CharBuffer object with a given capacity.
CharBuffer
append(char c)
CharBuffer
append(CharSequence cs)
CharBuffer
append(CharSequence cs, int start, int end)
char[]
array()
Returns the char array that backs this buffer.
int
arrayOffset()
Returns the offset within this buffer's backing array of the first element.
abstract CharBuffer
asReadOnlyBuffer()
Creates a new read-only CharBuffer that shares this buffer's content.
char
charAt(int index)
Returns the character at position() + index.
abstract CharBuffer
compact()
Compacts this buffer.
int
compareTo(CharBuffer other)
Compares two CharBuffer objects.
abstract CharBuffer
duplicate()
Creates a new CharBuffer that shares this buffer's content.
boolean
equals(Object obj)
Checks if this buffer is equal to obj.
abstract char
get()
Reads the char at this buffer's current position, and then increments the position.
CharBuffer
get(char[] dst)
This method transfers chars from this buffer into the given destination array.
CharBuffer
get(char[] dst, int offset, int length)
This method transfers chars from this buffer into the given destination array.
abstract char
get(int index)
Absolute get method.
boolean
hasArray()
Tells whether ot not this buffer is backed by an accessible char array.
int
hashCode()
Calculates a hash code for this buffer.
abstract boolean
isDirect()
Tells wether or not this buffer is direct.
int
length()
Returns the length of the remaining chars in this buffer.
abstract ByteOrder
order()
Returns the byte order of this buffer.
abstract CharBuffer
put(char b)
Writes the char at this buffer's current position, and then increments the position.
CharBuffer
put(char[] src)
Writes the content of the the char array src into the buffer.
CharBuffer
put(char[] src, int offset, int length)
Writes the content of the the char array src into the buffer.
abstract CharBuffer
put(int index, char b)
Absolute put method.
CharBuffer
put(String str)
Relative put method.
CharBuffer
put(String str, int start, int length)
Relative put method.
CharBuffer
put(CharBuffer src)
Writes the content of the the CharBUFFER src into the buffer.
int
read(CharBuffer buffer)
abstract CharBuffer
slice()
Creates a new CharBuffer whose content is a shared subsequence of this buffer's content.
abstract CharSequence
subSequence(int start, int length)
Creates a new character buffer that represents the specified subsequence of this buffer, relative to the current position.
String
toString()
Returns the remaining content of the buffer as a string.
static CharBuffer
wrap(char[] array)
Wraps a char array into a CharBuffer object.
static CharBuffer
wrap(char[] array, int offset, int length)
Wraps a char array into a CharBuffer object.
static CharBuffer
wrap(CharSequence seq)
Wraps a character sequence into a CharBuffer object.
static CharBuffer
wrap(CharSequence seq, int start, int end)
Wraps a character sequence into a CharBuffer object.

Methods inherited from class java.nio.Buffer

array, arrayOffset, capacity, clear, flip, hasArray, hasRemaining, isDirect, isReadOnly, limit, limit, mark, position, position, remaining, reset, rewind

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

allocate

public static CharBuffer allocate(int capacity)
Allocates a new CharBuffer object with a given capacity.

append

public CharBuffer append(char c)
Specified by:
append in interface Appendable
Since:
1.5

append

public CharBuffer append(CharSequence cs)
Specified by:
append in interface Appendable
Since:
1.5

append

public CharBuffer append(CharSequence cs,
                         int start,
                         int end)
Specified by:
append in interface Appendable
Since:
1.5

array

public final char[] array()
Returns the char array that backs this buffer.
Overrides:
array in interface Buffer
Throws:
ReadOnlyBufferException - If this buffer is read-only.
UnsupportedOperationException - If this buffer is not backed by an accessible array.

arrayOffset

public final int arrayOffset()
Returns the offset within this buffer's backing array of the first element.
Overrides:
arrayOffset in interface Buffer
Throws:
ReadOnlyBufferException - If this buffer is read-only.
UnsupportedOperationException - If this buffer is not backed by an accessible array.

asReadOnlyBuffer

public abstract CharBuffer asReadOnlyBuffer()
Creates a new read-only CharBuffer that shares this buffer's content.

charAt

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().

compact

public abstract CharBuffer compact()
Compacts this buffer.
Throws:
ReadOnlyBufferException - If this buffer is read-only.

compareTo

public int compareTo(CharBuffer other)
Compares two CharBuffer objects.
Throws:
ClassCastException - If obj is not an object derived from CharBuffer.

duplicate

public abstract CharBuffer duplicate()
Creates a new CharBuffer that shares this buffer's content.

equals

public boolean equals(Object obj)
Checks if this buffer is equal to obj.
Overrides:
equals in interface Object

get

public abstract 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.

get

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.

get

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.

get

public abstract char get(int index)
Absolute get method.
Throws:
IndexOutOfBoundsException - If index is negative or not smaller than the buffer's limit.

hasArray

public final boolean hasArray()
Tells whether ot not this buffer is backed by an accessible char array.
Overrides:
hasArray in interface Buffer

hashCode

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

isDirect

public abstract boolean isDirect()
Tells wether or not this buffer is direct.
Overrides:
isDirect in interface Buffer

length

public final int length()
Returns the length of the remaining chars in this buffer.
Specified by:
length in interface CharSequence

order

public abstract ByteOrder order()
Returns the byte order of this buffer.

put

public abstract 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.

put

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.

put

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.

put

public abstract 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.

put

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.

put

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.

put

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.

read

public int read(CharBuffer buffer)
            throws IOException
Specified by:
read in interface Readable
Since:
1.5

slice

public abstract CharBuffer slice()
Creates a new CharBuffer whose content is a shared subsequence of this buffer's content.

subSequence

public abstract 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.

toString

public String toString()
Returns the remaining content of the buffer as a string.
Specified by:
toString in interface CharSequence
Overrides:
toString in interface Object

wrap

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

wrap

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

wrap

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

wrap

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

CharBuffer.java -- Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.