| java.lang.Object
 java.nio.Buffer
java.nio.CharBuffer
All known Subclasses: java.nio.CharArrayBuffer, java.nio.CharToByteBufferAdapter, java.nio.CharSequenceAdapter,
| Constructor Summary | |
| | CharBuffer(int capacity)
Constructs a CharBuffer with given capacity. |
| Method Summary | |
| public static CharBuffer | allocate(int capacity)
Creates a char buffer based on a new allocated char array. | | public CharBuffer | append(char c)
| | public CharBuffer | append(CharSequence csq)
| | public CharBuffer | append(CharSequence csq, int start, int end)
| | final public char[] | array()
Returns the char array which this buffer is based on, if there's one. | | final public int | arrayOffset()
Returns the offset of the char array which this buffer is based on, if
there's one. | | abstract public CharBuffer | asReadOnlyBuffer()
Returns a readonly buffer that shares content with this buffer.
The returned buffer is guaranteed to be a new instance, even this buffer
is readonly itself. | | final public char | charAt(int index)
Returns the character located at the specified index in the buffer. | | abstract public CharBuffer | compact()
Compacts this char buffer.
The remaining chars will be moved to the head of the
buffer, staring from position zero. | | public int | compareTo(CharBuffer otherBuffer)
Compare the remaining chars of this buffer to another
char buffer's remaining chars. | | abstract public CharBuffer | duplicate()
Returns a duplicated buffer that shares content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same
as this buffer. | | public boolean | equals(Object other)
Tests whether this char buffer equals to another object.
If other is not a char buffer, then false is returned.
Two char buffers are equals if, and only if, their remaining
chars are exactly the same. | | abstract public char | get()
Returns the char at the current position and increase the position by 1. | | public CharBuffer | get(char[] dest)
Reads chars from the current position into the specified
char array and increase the position by the number of chars
read. | | public CharBuffer | get(char[] dest, int off, int len)
Reads chars from the current position into the specified
char array, starting from the specified offset, and increase the position
by the number of chars read. | | abstract public char | get(int index)
Returns a char at the specified index, and the position is not changed. | | final public boolean | hasArray()
Returns whether this buffer is based on a char array and is read/write. | | public int | hashCode()
Hash code is calculated from the remaining chars. | | abstract public boolean | isDirect()
Returns true if this buffer is direct. | | final public int | length()
Returns the number of remaining chars. | | abstract public ByteOrder | order()
Returns the byte order used by this buffer when converting
chars from/to bytes. | | abstract char[] | protectedArray()
Child class implements this method to realize array(). | | abstract int | protectedArrayOffset()
Child class implements this method to realize arrayOffset(). | | abstract boolean | protectedHasArray()
Child class implements this method to realize hasArray(). | | abstract public CharBuffer | put(char c)
Writes the given char to the current position and increase the position
by 1. | | final public CharBuffer | put(char[] src)
Writes chars in the given char array to the current
position and increase the position by the number of chars
written. | | public CharBuffer | put(char[] src, int off, int len)
Writes chars in the given char array, starting from the
specified offset, to the current position and increase the position by
the number of chars written. | | public CharBuffer | put(CharBuffer src)
Writes all the remaining chars of the src
char buffer to this buffer's current position, and increase both buffers'
position by the number of chars copied. | | abstract public CharBuffer | put(int index, char c)
Write a char to the specified index of this buffer and the position is
not changed. | | final public CharBuffer | put(String str)
Write all chars of the give string to the current
position of this buffer, and increase the position by the length of
string. | | public CharBuffer | put(String str, int start, int end)
Write chars of the given string to the current position
of this buffer, and increase the position by the number of
chars written. | | public int | read(CharBuffer target)
| | abstract public CharBuffer | slice()
Returns a sliced buffer that shares content with this buffer.
The sliced buffer's capacity will be this buffer's
remaining(), and its zero position will correspond to
this buffer's current position. | | abstract public CharSequence | subSequence(int start, int end)
Returns a new char buffer represents a sub-sequence of this buffer's
current remaining content.
The new buffer's position will be position() + start,
limit will be position() + end, capacity will be same as
this buffer. | | public String | toString()
Returns a string represents the current remaining chars
of this buffer. | | public static CharBuffer | wrap(char[] array)
Creates a new char buffer by wrapping the given char array. | | public static CharBuffer | wrap(char[] array, int start, int len)
Creates new a char buffer by wrapping the given char array. | | public static CharBuffer | wrap(CharSequence chseq)
Creates a new char buffer by wrapping the given char sequence. | | public static CharBuffer | wrap(CharSequence chseq, int start, int end)
Creates a new char buffer by wrapping the given char sequence. |
| CharBuffer | | CharBuffer(int capacity)(Code) | | Constructs a CharBuffer with given capacity.
Parameters:
capacity - The capacity of the buffer |
| allocate | | public static CharBuffer allocate(int capacity)(Code) | | Creates a char buffer based on a new allocated char array.
Parameters:
capacity - The capacity of the new buffer The created char buffer
throws:
IllegalArgumentException - If capacity is less than zero |
| array | | final public char[] array()(Code) | | Returns the char array which this buffer is based on, if there's one.
The char array which this buffer is based on
exception:
ReadOnlyBufferException - If this buffer is based on an array, but it is readonly
exception:
UnsupportedOperationException - If this buffer is not based on an array |
| arrayOffset | | final public int arrayOffset()(Code) | | Returns the offset of the char array which this buffer is based on, if
there's one.
The offset is the index of the array corresponds to the zero position of
the buffer.
The offset of the char array which this buffer is based on
exception:
ReadOnlyBufferException - If this buffer is based on an array, but it is readonly
exception:
UnsupportedOperationException - If this buffer is not based on an array |
| asReadOnlyBuffer | | abstract public CharBuffer asReadOnlyBuffer()(Code) | | Returns a readonly buffer that shares content with this buffer.
The returned buffer is guaranteed to be a new instance, even this buffer
is readonly itself. The new buffer's position, limit, capacity and mark
are the same as this buffer.
The new buffer shares content with this buffer, which means this buffer's
change of content will be visible to the new buffer. The two buffer's
position, limit and mark are independent.
A readonly version of this buffer. |
| charAt | | final public char charAt(int index)(Code) | | Returns the character located at the specified index in the buffer. The
index value is referenced from the current buffer position.
Parameters:
index - The index referenced from the current buffer position. It mustnot be less than zero but less than the value obtained from acall to remaining() the character located at the specified index (referenced from thecurrent position) in the buffer.
exception:
IndexOutOfBoundsException - If the index is invalid |
| compact | | abstract public CharBuffer compact()(Code) | | Compacts this char buffer.
The remaining chars will be moved to the head of the
buffer, staring from position zero. Then the position is set to
remaining(); the limit is set to capacity; the mark is
cleared.
This buffer
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| compareTo | | public int compareTo(CharBuffer otherBuffer)(Code) | | Compare the remaining chars of this buffer to another
char buffer's remaining chars.
Parameters:
otherBuffer - Another char buffer a negative value if this is less than other; 0 ifthis equals to other; a positive value if this isgreater than other
exception:
ClassCastException - If other is not a char buffer |
| duplicate | | abstract public CharBuffer duplicate()(Code) | | Returns a duplicated buffer that shares content with this buffer.
The duplicated buffer's position, limit, capacity and mark are the same
as this buffer. The duplicated buffer's readonly property and byte order
are same as this buffer too.
The new buffer shares content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
A duplicated buffer that shares content with this buffer. |
| equals | | public boolean equals(Object other)(Code) | | Tests whether this char buffer equals to another object.
If other is not a char buffer, then false is returned.
Two char buffers are equals if, and only if, their remaining
chars are exactly the same. Position, limit, capacity and
mark are not considered.
Parameters:
other - the object to be compared against Whether this char buffer equals to another object. |
| get | | abstract public char get()(Code) | | Returns the char at the current position and increase the position by 1.
The char at the current position.
exception:
BufferUnderflowException - If the position is equal or greater than limit |
| get | | public CharBuffer get(char[] dest)(Code) | | Reads chars from the current position into the specified
char array and increase the position by the number of chars
read.
Calling this method has the same effect as
get(dest, 0, dest.length).
Parameters:
dest - The destination char array This buffer
exception:
BufferUnderflowException - if dest.length is greater thanremaining() |
| get | | public CharBuffer get(char[] dest, int off, int len)(Code) | | Reads chars from the current position into the specified
char array, starting from the specified offset, and increase the position
by the number of chars read.
Parameters:
dest - The target char array
Parameters:
off - The offset of the char array, must be no less than zero and nogreater than dest.length
Parameters:
len - The number of chars to read, must be no lessthan zero and no greater than dest.length - off This buffer
exception:
IndexOutOfBoundsException - If either off or len isinvalid
exception:
BufferUnderflowException - If len is greater thanremaining() |
| get | | abstract public char get(int index)(Code) | | Returns a char at the specified index, and the position is not changed.
Parameters:
index - The index, must be no less than zero and less than limit A char at the specified index.
exception:
IndexOutOfBoundsException - If index is invalid |
| hasArray | | final public boolean hasArray()(Code) | | Returns whether this buffer is based on a char array and is read/write.
If this buffer is readonly, then false is returned.
Whether this buffer is based on a char array and is read/write. |
| hashCode | | public int hashCode()(Code) | | Hash code is calculated from the remaining chars.
Position, limit, capacity and mark don't affect the hash code.
The hash code calculated from the remaining chars. |
| isDirect | | abstract public boolean isDirect()(Code) | | Returns true if this buffer is direct.
A direct buffer will try its best to take advantage of native memory APIs
and it may not stay in java heap, thus not affected by GC.
A char buffer is direct, if it is based on a byte buffer and the byte
buffer is direct.
True if this buffer is direct. |
| length | | final public int length()(Code) | | Returns the number of remaining chars.
The number of remaining chars. |
| order | | abstract public ByteOrder order()(Code) | | Returns the byte order used by this buffer when converting
chars from/to bytes.
If this buffer is not based on a byte buffer, then always return the
platform's native byte order.
The byte order used by this buffer when convertingchars from/to bytes. |
| protectedArray | | abstract char[] protectedArray()(Code) | | Child class implements this method to realize array().
see array() |
| protectedArrayOffset | | abstract int protectedArrayOffset()(Code) | | Child class implements this method to realize arrayOffset().
see arrayOffset() |
| protectedHasArray | | abstract boolean protectedHasArray()(Code) | | Child class implements this method to realize hasArray().
see hasArray() |
| put | | abstract public CharBuffer put(char c)(Code) | | Writes the given char to the current position and increase the position
by 1.
Parameters:
c - The char to write This buffer
exception:
BufferOverflowException - If position is equal or greater than limit
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | final public CharBuffer put(char[] src)(Code) | | Writes chars in the given char array to the current
position and increase the position by the number of chars
written.
Calling this method has the same effect as
put(src, 0, src.length).
Parameters:
src - The source char array This buffer
exception:
BufferOverflowException - If remaining() is less thansrc.length
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | public CharBuffer put(char[] src, int off, int len)(Code) | | Writes chars in the given char array, starting from the
specified offset, to the current position and increase the position by
the number of chars written.
Parameters:
src - The source char array
Parameters:
off - The offset of char array, must be no less than zero and nogreater than src.length
Parameters:
len - The number of chars to write, must be no lessthan zero and no greater than src.length - off This buffer
exception:
BufferOverflowException - If remaining() is less thanlen
exception:
IndexOutOfBoundsException - If either off or len isinvalid
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | public CharBuffer put(CharBuffer src)(Code) | | Writes all the remaining chars of the src
char buffer to this buffer's current position, and increase both buffers'
position by the number of chars copied.
Parameters:
src - The source char buffer This buffer
exception:
BufferOverflowException - If src.remaining() is greater than thisbuffer's remaining()
exception:
IllegalArgumentException - If src is this buffer
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | abstract public CharBuffer put(int index, char c)(Code) | | Write a char to the specified index of this buffer and the position is
not changed.
Parameters:
index - The index, must be no less than zero and less than the limit
Parameters:
c - The char to write This buffer
exception:
IndexOutOfBoundsException - If index is invalid
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | final public CharBuffer put(String str)(Code) | | Write all chars of the give string to the current
position of this buffer, and increase the position by the length of
string.
Calling this method has the same effect as
put(str, 0, str.length()).
Parameters:
str - The string to write This buffer
exception:
BufferOverflowException - If remaining() is less than the length ofstring
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| put | | public CharBuffer put(String str, int start, int end)(Code) | | Write chars of the given string to the current position
of this buffer, and increase the position by the number of
chars written.
Parameters:
str - The string to write
Parameters:
start - The first char to write, must be no less than zero and nogreater than str.length()
Parameters:
end - The last char to write (excluding), must be less thanstart and no greater thanstr.length() This buffer
exception:
BufferOverflowException - If remaining is less thanend - start
exception:
IndexOutOfBoundsException - If either start or end isinvalid
exception:
ReadOnlyBufferException - If no changes may be made to the contents of this buffer |
| slice | | abstract public CharBuffer slice()(Code) | | Returns a sliced buffer that shares content with this buffer.
The sliced buffer's capacity will be this buffer's
remaining(), and its zero position will correspond to
this buffer's current position. The new buffer's position will be 0,
limit will be its capacity, and its mark is unset. The new buffer's
readonly property and byte order are same as this buffer.
The new buffer shares content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
A sliced buffer that shares content with this buffer. |
| subSequence | | abstract public CharSequence subSequence(int start, int end)(Code) | | Returns a new char buffer represents a sub-sequence of this buffer's
current remaining content.
The new buffer's position will be position() + start,
limit will be position() + end, capacity will be same as
this buffer. The new buffer's readonly property and byte order are same
as this buffer.
The new buffer shares content with this buffer, which means either
buffer's change of content will be visible to the other. The two buffer's
position, limit and mark are independent.
Parameters:
start - The start index of the sub-sequence, referenced from thecurrent buffer position. Must not be less than zero and notgreater than the value obtained from a call toremaining().
Parameters:
end - The end index of the sub-sequence, referenced from the currentbuffer position. Must not be less than startand not be greater than the value obtained from a call toremaining() A new char buffer represents a sub-sequence of this buffer'scurrent remaining content.
exception:
IndexOutOfBoundsException - If either start or end isinvalid |
| toString | | public String toString()(Code) | | Returns a string represents the current remaining chars
of this buffer.
A string represents the current remaining charsof this buffer. |
| wrap | | public static CharBuffer wrap(char[] array)(Code) | | Creates a new char buffer by wrapping the given char array.
Calling this method has the same effect as
wrap(array, 0, array.length).
Parameters:
array - The char array which the new buffer will be based on The created char buffer |
| wrap | | public static CharBuffer wrap(char[] array, int start, int len)(Code) | | Creates new a char buffer by wrapping the given char array.
The new buffer's position will be start, limit will be
start + len, capacity will be the length of the array.
Parameters:
array - The char array which the new buffer will be based on
Parameters:
start - The start index, must be no less than zero and no greater thanarray.length
Parameters:
len - The length, must be no less than zero and no greater thanarray.length - start The created char buffer
exception:
IndexOutOfBoundsException - If either start or len isinvalid |
| wrap | | public static CharBuffer wrap(CharSequence chseq)(Code) | | Creates a new char buffer by wrapping the given char sequence.
Calling this method has the same effect as
wrap(chseq, 0, chseq.length()).
Parameters:
chseq - The char sequence which the new buffer will be based on The created char buffer |
| wrap | | public static CharBuffer wrap(CharSequence chseq, int start, int end)(Code) | | Creates a new char buffer by wrapping the given char sequence.
The new buffer's position will be start, limit will be
end, capacity will be the length of the char sequence.
The new buffer is readonly.
Parameters:
chseq - The char sequence which the new buffer will be based on
Parameters:
start - The start index, must be no less than zero and no greater thanchseq.length()
Parameters:
end - The end index, must be no less than start andno greater than chseq.length() The created char buffer
exception:
IndexOutOfBoundsException - If either start or end isinvalid |
|
|