Appendable
, CharSequence
, Comparable<CharBuffer>
, Readable
public abstract sealed class CharBuffer extends Buffer implements Comparable<CharBuffer>, Appendable, CharSequence, Readable
This class defines four categories of operations upon char buffers:
Absolute and relative get
and put
methods that read and write single chars;
Absolute and relative bulk get
methods that transfer contiguous sequences of chars from this buffer into an array;
Absolute and relative bulk put
methods that transfer contiguous sequences of chars from a char array, a string, or some other char buffer into this buffer;
A method for compacting
a char buffer.
Char buffers can be created either by allocation
, which allocates space for the buffer's content, by wrapping
an existing char array or string into a buffer, or by creating a view of an existing byte buffer.
Like a byte buffer, a char buffer is either direct or non-direct. A char buffer created via the wrap
methods of this class will be non-direct. A char buffer created as a view of a byte buffer will be direct if, and only if, the byte buffer itself is direct. Whether or not a char buffer is direct may be determined by invoking the isDirect
method.
This class implements the CharSequence
interface so that character buffers may be used wherever character sequences are accepted, for example in the regular-expression package java.util.regex
. The methods defined by CharSequence
operate relative to the current position of the buffer when they are invoked.
Methods in this class that do not otherwise have a value to return are specified to return the buffer upon which they are invoked. This allows method invocations to be chained. The sequence of statements
cb.put("text/");
cb.put(subtype);
cb.put("; charset=");
cb.put(enc);
cb.put("text/").put(subtype).put("; charset=").put(enc);
Modifier and Type | Method | Description |
---|---|---|
static CharBuffer |
allocate |
Allocates a new char buffer. |
CharBuffer |
append |
Appends the specified char to this buffer (optional operation). |
CharBuffer |
append |
Appends the specified character sequence to this buffer (optional operation). |
CharBuffer |
append |
Appends a subsequence of the specified character sequence to this buffer (optional operation). |
final char[] |
array() |
Returns the char array that backs this buffer (optional operation). |
final int |
arrayOffset() |
Returns the offset within this buffer's backing array of the first element of the buffer (optional operation). |
abstract CharBuffer |
asReadOnlyBuffer() |
Creates a new, read-only char buffer that shares this buffer's content. |
final char |
charAt |
Reads the character at the given index relative to the current position. |
final CharBuffer |
clear() |
Clears this buffer. |
abstract CharBuffer |
compact() |
Compacts this buffer (optional operation). |
int |
compareTo |
Compares this buffer to another. |
abstract CharBuffer |
duplicate() |
Creates a new char buffer that shares this buffer's content. |
boolean |
equals |
Tells whether or not this buffer is equal to another object. |
final CharBuffer |
flip() |
Flips this buffer. |
abstract char |
get() |
Relative get method. |
CharBuffer |
get |
Relative bulk get method. |
CharBuffer |
get |
Relative bulk get method. |
abstract char |
get |
Absolute get method. |
CharBuffer |
get |
Absolute bulk get method. |
CharBuffer |
get |
Absolute bulk get method. |
final boolean |
hasArray() |
Tells whether or not this buffer is backed by an accessible char array. |
int |
hashCode() |
Returns the current hash code of this buffer. |
abstract boolean |
isDirect() |
Tells whether or not this char buffer is direct. |
final boolean |
isEmpty() |
Returns true if this character buffer is empty. |
final int |
length() |
Returns the length of this character buffer. |
final CharBuffer |
limit |
Sets this buffer's limit. |
final CharBuffer |
mark() |
Sets this buffer's mark at its position. |
int |
mismatch |
Finds and returns the relative index of the first mismatch between this buffer and a given buffer. |
abstract ByteOrder |
order() |
Retrieves this buffer's byte order. |
final CharBuffer |
position |
Sets this buffer's position. |
abstract CharBuffer |
put |
Relative put method (optional operation). |
final CharBuffer |
put |
Relative bulk put method (optional operation). |
CharBuffer |
put |
Relative bulk put method (optional operation). |
abstract CharBuffer |
put |
Absolute put method (optional operation). |
CharBuffer |
put |
Absolute bulk put method (optional operation). |
CharBuffer |
put |
Absolute bulk put method (optional operation). |
CharBuffer |
put |
Absolute bulk put method (optional operation). |
final CharBuffer |
put |
Relative bulk put method (optional operation). |
CharBuffer |
put |
Relative bulk put method (optional operation). |
CharBuffer |
put |
Relative bulk put method (optional operation). |
int |
read |
Attempts to read characters into the specified character buffer. |
final CharBuffer |
reset() |
Resets this buffer's position to the previously-marked position. |
final CharBuffer |
rewind() |
Rewinds this buffer. |
abstract CharBuffer |
slice() |
Creates a new char buffer whose content is a shared subsequence of this buffer's content. |
abstract CharBuffer |
slice |
Creates a new char buffer whose content is a shared subsequence of this buffer's content. |
abstract CharBuffer |
subSequence |
Creates a new character buffer that represents the specified subsequence of this buffer, relative to the current position. |
String |
toString() |
Returns a string containing the characters in this buffer. |
static CharBuffer |
wrap |
Wraps a char array into a buffer. |
static CharBuffer |
wrap |
Wraps a char array into a buffer. |
static CharBuffer |
wrap |
Wraps a character sequence into a buffer. |
static CharBuffer |
wrap |
Wraps a character sequence into a buffer. |
capacity, hasRemaining, isReadOnly, limit, position, remaining
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
chars, codePoints
public static CharBuffer allocate(int capacity)
The new buffer's position will be zero, its limit will be its capacity, its mark will be undefined, each of its elements will be initialized to zero, and its byte order will be the native order
of the underlying hardware. It will have a backing array
, and its array offset
will be zero.
capacity
- The new buffer's capacity, in charsIllegalArgumentException
- If the capacity
is a negative integerpublic static CharBuffer wrap(char[] array, int offset, int length)
The new buffer will be backed by the given char array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity will be array.length
, its position will be offset
, its limit will be offset + length
, its mark will be undefined, and its byte order will be the native order
of the underlying hardware. Its backing array
will be the given array, and its array offset
will be zero.
array
- The array that will back the new bufferoffset
- The offset of the subarray to be used; must be non-negative and no larger than array.length
. The new buffer's position will be set to this value.length
- The length of the subarray to be used; must be non-negative and no larger than array.length - offset
. The new buffer's limit will be set to offset + length
.IndexOutOfBoundsException
- If the preconditions on the offset
and length
parameters do not holdpublic static CharBuffer wrap(char[] array)
The new buffer will be backed by the given char array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity and limit will be array.length
, its position will be zero, its mark will be undefined, and its byte order will be the native order
of the underlying hardware. Its backing array
will be the given array, and its array offset
will be zero.
array
- The array that will back this bufferpublic int read(CharBuffer target) throws IOException
read
in interface Readable
target
- the buffer to read characters intoIOException
- if an I/O error occursReadOnlyBufferException
- if target is a read only bufferpublic static CharBuffer wrap(CharSequence csq, int start, int end)
The content of the new, read-only buffer will be the content of the given character sequence. The buffer's capacity will be csq.length()
, its position will be start
, its limit will be end
, and its mark will be undefined.
csq
- The character sequence from which the new character buffer is to be createdstart
- The index of the first character to be used; must be non-negative and no larger than csq.length()
. The new buffer's position will be set to this value.end
- The index of the character following the last character to be used; must be no smaller than start
and no larger than csq.length()
. The new buffer's limit will be set to this value.IndexOutOfBoundsException
- If the preconditions on the start
and end
parameters do not holdpublic static CharBuffer wrap(CharSequence csq)
The content of the new, read-only buffer will be the content of the given character sequence. The new buffer's capacity and limit will be csq.length()
, its position will be zero, and its mark will be undefined.
csq
- The character sequence from which the new character buffer is to be createdpublic abstract CharBuffer slice()
The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.
The new buffer's position will be zero, its capacity and its limit will be the number of chars remaining in this buffer, its mark will be undefined, and its byte order will be identical to that of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.
public abstract CharBuffer slice(int index, int length)
The content of the new buffer will start at position index
in this buffer, and will contain length
elements. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.
The new buffer's position will be zero, its capacity and its limit will be length
, its mark will be undefined, and its byte order will be identical to that of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.
slice
in class Buffer
index
- The position in this buffer at which the content of the new buffer will start; must be non-negative and no larger than limit()
length
- The number of elements the new buffer will contain; must be non-negative and no larger than limit() - index
IndexOutOfBoundsException
- If index
is negative or greater than limit()
, length
is negative, or length > limit() - index
public abstract CharBuffer duplicate()
The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.
The new buffer's capacity, limit, position, mark values, and byte order will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.
public abstract CharBuffer asReadOnlyBuffer()
The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.
The new buffer's capacity, limit, position, mark values, and byte order will be identical to those of this buffer.
If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate
method.
public abstract char get()
BufferUnderflowException
- If the buffer's current position is not smaller than its limitpublic abstract CharBuffer put(char c)
Writes the given char into this buffer at the current position, and then increments the position.
c
- The char to be writtenBufferOverflowException
- If this buffer's current position is not smaller than its limitReadOnlyBufferException
- If this buffer is read-onlypublic abstract char get(int index)
index
- The index from which the char will be readIndexOutOfBoundsException
- If index
is negative or not smaller than the buffer's limitpublic abstract CharBuffer put(int index, char c)
Writes the given char into this buffer at the given index.
index
- The index at which the char will be writtenc
- The char value to be writtenIndexOutOfBoundsException
- If index
is negative or not smaller than the buffer's limitReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer get(char[] dst, int offset, int length)
This method transfers chars from this buffer into the given destination array. If there are fewer chars remaining in the buffer than are required to satisfy the request, that is, if length
>
remaining()
, then no chars are transferred and a BufferUnderflowException
is thrown.
Otherwise, this method copies length
chars from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length
.
In other words, an invocation of this method of the form src.get(dst, off, len)
has exactly the same effect as the loop
for (int i = off; i < off + len; i++)
dst[i] = src.get();
dst
- The array into which chars are to be writtenoffset
- 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 chars to be written to the given array; must be non-negative and no larger than dst.length - offset
BufferUnderflowException
- If there are fewer than length
chars remaining in this bufferIndexOutOfBoundsException
- If the preconditions on the offset
and length
parameters do not holdpublic CharBuffer get(char[] dst)
This method transfers chars from this buffer into the given destination array. An invocation of this method of the form src.get(a)
behaves in exactly the same way as the invocation
src.get(a, 0, a.length)
dst
- The destination arrayBufferUnderflowException
- If there are fewer than length
chars remaining in this bufferpublic CharBuffer get(int index, char[] dst, int offset, int length)
This method transfers length
chars from this buffer into the given array, starting at the given index in this buffer and at the given offset in the array. The position of this buffer is unchanged.
An invocation of this method of the form src.get(index, dst, offset, length)
has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient:
for (int i = offset, j = index; i < offset + length; i++, j++)
dst[i] = src.get(j);
index
- The index in this buffer from which the first char will be read; must be non-negative and less than limit()
dst
- The destination arrayoffset
- The offset within the array of the first char to be written; must be non-negative and less than dst.length
length
- The number of chars to be written to the given array; must be non-negative and no larger than the smaller of limit() - index
and dst.length - offset
IndexOutOfBoundsException
- If the preconditions on the index
, offset
, and length
parameters do not holdpublic CharBuffer get(int index, char[] dst)
This method transfers chars from this buffer into the given destination array. The position of this buffer is unchanged. An invocation of this method of the form src.get(index, dst)
behaves in exactly the same way as the invocation:
src.get(index, dst, 0, dst.length)
index
- The index in this buffer from which the first char will be read; must be non-negative and less than limit()
dst
- The destination arrayIndexOutOfBoundsException
- If index
is negative, not smaller than limit()
, or limit() - index < dst.length
public CharBuffer put(CharBuffer src)
This method transfers the chars remaining in the given source buffer into this buffer. If there are more chars remaining in the source buffer than in this buffer, that is, if src.remaining()
>
remaining()
, then no chars are transferred and a BufferOverflowException
is thrown.
Otherwise, this method copies n = src.remaining()
chars from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.
In other words, an invocation of this method of the form dst.put(src)
has exactly the same effect as the loop
while (src.hasRemaining())
dst.put(src.get());
src
- The source buffer from which chars are to be read; must not be this bufferBufferOverflowException
- If there is insufficient space in this buffer for the remaining chars in the source bufferIllegalArgumentException
- If the source buffer is this bufferReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer put(int index, CharBuffer src, int offset, int length)
This method transfers length
chars into this buffer from the given source buffer, starting at the given offset
in the source buffer and the given index
in this buffer. The positions of both buffers are unchanged.
In other words, an invocation of this method of the form dst.put(index, src, offset, length)
has exactly the same effect as the loop
for (int i = offset, j = index; i < offset + length; i++, j++)
dst.put(j, src.get(i));
index
- The index in this buffer at which the first char will be written; must be non-negative and less than limit()
src
- The buffer from which chars are to be readoffset
- The index within the source buffer of the first char to be read; must be non-negative and less than src.limit()
length
- The number of chars to be read from the given buffer; must be non-negative and no larger than the smaller of limit() - index
and src.limit() - offset
IndexOutOfBoundsException
- If the preconditions on the index
, offset
, and length
parameters do not holdReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer put(char[] src, int offset, int length)
This method transfers chars into this buffer from the given source array. If there are more chars to be copied from the array than remain in this buffer, that is, if length
>
remaining()
, then no chars are transferred and a BufferOverflowException
is thrown.
Otherwise, this method copies length
chars from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length
.
In other words, an invocation of this method of the form dst.put(src, off, len)
has exactly the same effect as the loop
for (int i = off; i < off + len; i++)
dst.put(src[i]);
src
- The array from which chars are to be readoffset
- The offset within the array of the first char to be read; must be non-negative and no larger than src.length
length
- The number of chars to be read from the given array; must be non-negative and no larger than src.length - offset
BufferOverflowException
- If there is insufficient space in this bufferIndexOutOfBoundsException
- If the preconditions on the offset
and length
parameters do not holdReadOnlyBufferException
- If this buffer is read-onlypublic final CharBuffer put(char[] src)
This method transfers the entire content of the given source char array into this buffer. An invocation of this method of the form dst.put(a)
behaves in exactly the same way as the invocation
dst.put(a, 0, a.length)
src
- The source arrayBufferOverflowException
- If there is insufficient space in this bufferReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer put(int index, char[] src, int offset, int length)
This method transfers length
chars from the given array, starting at the given offset in the array and at the given index in this buffer. The position of this buffer is unchanged.
An invocation of this method of the form dst.put(index, src, offset, length)
has exactly the same effect as the following loop except that it first checks the consistency of the supplied parameters and it is potentially much more efficient:
for (int i = offset, j = index; i < offset + length; i++, j++)
dst.put(j, src[i]);
index
- The index in this buffer at which the first char will be written; must be non-negative and less than limit()
src
- The array from which chars are to be readoffset
- The offset within the array of the first char to be read; must be non-negative and less than src.length
length
- The number of chars to be read from the given array; must be non-negative and no larger than the smaller of limit() - index
and src.length - offset
IndexOutOfBoundsException
- If the preconditions on the index
, offset
, and length
parameters do not holdReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer put(int index, char[] src)
This method copies chars into this buffer from the given source array. The position of this buffer is unchanged. An invocation of this method of the form dst.put(index, src)
behaves in exactly the same way as the invocation:
dst.put(index, src, 0, src.length);
index
- The index in this buffer at which the first char will be written; must be non-negative and less than limit()
src
- The array from which chars are to be readIndexOutOfBoundsException
- If index
is negative, not smaller than limit()
, or limit() - index < src.length
ReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer put(String src, int start, int end)
This method transfers chars from the given string into this buffer. If there are more chars to be copied from the string than remain in this buffer, that is, if end - start
>
remaining()
, then no chars are transferred and a BufferOverflowException
is thrown.
Otherwise, this method copies n = end
- start
chars from the given string into this buffer, starting at the given start
index and at the current position of this buffer. The position of this buffer is then incremented by n.
In other words, an invocation of this method of the form dst.put(src, start, end)
has exactly the same effect as the loop
for (int i = start; i < end; i++)
dst.put(src.charAt(i));
src
- The string from which chars are to be readstart
- The offset within the string of the first char to be read; must be non-negative and no larger than string.length()
end
- The offset within the string of the last char to be read, plus one; must be non-negative and no larger than string.length()
BufferOverflowException
- If there is insufficient space in this bufferIndexOutOfBoundsException
- If the preconditions on the start
and end
parameters do not holdReadOnlyBufferException
- If this buffer is read-onlypublic final CharBuffer put(String src)
This method transfers the entire content of the given source string into this buffer. An invocation of this method of the form dst.put(s)
behaves in exactly the same way as the invocation
dst.put(s, 0, s.length())
src
- The source stringBufferOverflowException
- If there is insufficient space in this bufferReadOnlyBufferException
- If this buffer is read-onlypublic final boolean hasArray()
If this method returns true
then the array
and arrayOffset
methods may safely be invoked.
public final char[] array()
Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.
Invoke the hasArray
method before invoking this method in order to ensure that this buffer has an accessible backing array.
array
in class Buffer
ReadOnlyBufferException
- If this buffer is backed by an array but is read-onlyUnsupportedOperationException
- If this buffer is not backed by an accessible arraypublic final int arrayOffset()
If this buffer is backed by an array then buffer position p corresponds to array index p + arrayOffset()
.
Invoke the hasArray
method before invoking this method in order to ensure that this buffer has an accessible backing array.
arrayOffset
in class Buffer
ReadOnlyBufferException
- If this buffer is backed by an array but is read-onlyUnsupportedOperationException
- If this buffer is not backed by an accessible arraypublic final CharBuffer position(int newPosition)
public final CharBuffer limit(int newLimit)
public final CharBuffer mark()
public final CharBuffer reset()
Invoking this method neither changes nor discards the mark's value.
public final CharBuffer clear()
Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example:
buf.clear(); // Prepare buffer for reading
in.read(buf); // Read data
This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.
public final CharBuffer flip()
After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example:
buf.put(magic); // Prepend header
in.read(buf); // Read data into rest of buffer
buf.flip(); // Flip buffer
out.write(buf); // Write header + data to channel
This method is often used in conjunction with the compact
method when transferring data from one place to another.
public final CharBuffer rewind()
Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example:
out.write(buf); // Write remaining data
buf.rewind(); // Rewind buffer
buf.get(array); // Copy data into array
public abstract CharBuffer compact()
The chars between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the char at index p = position()
is copied to index zero, the char at index p + 1 is copied to index one, and so forth until the char at index limit()
- 1 is copied to index n = limit()
- 1
- p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.
The buffer's position is set to the number of chars copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.
ReadOnlyBufferException
- If this buffer is read-onlypublic abstract boolean isDirect()
public int hashCode()
The hash code of a char buffer depends only upon its remaining elements; that is, upon the elements from position()
up to, and including, the element at limit()
- 1
.
Because buffer hash codes are content-dependent, it is inadvisable to use buffers as keys in hash maps or similar data structures unless it is known that their contents will not change.
public boolean equals(Object ob)
Two char buffers are equal if, and only if,
They have the same element type,
They have the same number of remaining elements, and
The two sequences of remaining elements, considered independently of their starting positions, are pointwise equal.
A char buffer is not equal to any other type of object.
public int compareTo(CharBuffer that)
Two char buffers are compared by comparing their sequences of remaining elements lexicographically, without regard to the starting position of each sequence within its corresponding buffer. Pairs of char
elements are compared as if by invoking Character.compare(char,char)
.
A char buffer is not comparable to any other type of object.
compareTo
in interface Comparable<CharBuffer>
that
- the object to be compared.public int mismatch(CharBuffer that)
position
of each buffer and will be in the range of 0 (inclusive) up to the smaller of the remaining
elements in each buffer (exclusive). If the two buffers share a common prefix then the returned index is the length of the common prefix and it follows that there is a mismatch between the two buffers at that index within the respective buffers. If one buffer is a proper prefix of the other then the returned index is the smaller of the remaining elements in each buffer, and it follows that the index is only valid for the buffer with the larger number of remaining elements. Otherwise, there is no mismatch.
that
- The byte buffer to be tested for a mismatch with this bufferpublic String toString()
The first character of the resulting string will be the character at this buffer's position, while the last character will be the character at index limit()
- 1. Invoking this method does not change the buffer's position.
toString
in interface CharSequence
toString
in class Object
public final int length()
When viewed as a character sequence, the length of a character buffer is simply the number of characters between the position (inclusive) and the limit (exclusive); that is, it is equivalent to remaining()
.
length
in interface CharSequence
public final boolean isEmpty()
true
if this character buffer is empty.isEmpty
in interface CharSequence
true
if there are 0
remaining characters, otherwise false
public final char charAt(int index)
charAt
in interface CharSequence
index
- The index of the character to be read, relative to the position; must be non-negative and smaller than remaining()
position() + index
IndexOutOfBoundsException
- If the preconditions on index
do not holdpublic abstract CharBuffer subSequence(int start, int end)
The new buffer will share this buffer's content; that is, if the content of this buffer is mutable then modifications to one buffer will cause the other to be modified. The new buffer's capacity will be that of this buffer, its position will be position()
+ start
, its limit will be position()
+ end
, and its byte order will be identical to that of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.
subSequence
in interface CharSequence
start
- The index, relative to the current position, of the first character in the subsequence; must be non-negative and no larger than remaining()
end
- The index, relative to the current position, of the character following the last character in the subsequence; must be no smaller than start
and no larger than remaining()
IndexOutOfBoundsException
- If the preconditions on start
and end
do not holdpublic CharBuffer append(CharSequence csq)
An invocation of this method of the form dst.append(csq)
behaves in exactly the same way as the invocation
dst.put(csq.toString())
Depending on the specification of toString
for the character sequence csq
, the entire sequence may not be appended. For instance, invoking the toString
method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.
append
in interface Appendable
csq
- The character sequence to append. If csq
is null
, then the four characters "null"
are appended to this character buffer.BufferOverflowException
- If there is insufficient space in this bufferReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer append(CharSequence csq, int start, int end)
An invocation of this method of the form dst.append(csq, start,
end)
when csq
is not null
, behaves in exactly the same way as the invocation
dst.put(csq.subSequence(start, end).toString())
append
in interface Appendable
csq
- The character sequence from which a subsequence will be appended. If csq
is null
, then characters will be appended as if csq
contained the four characters "null"
.start
- The index of the first character in the subsequenceend
- The index of the character following the last character in the subsequenceBufferOverflowException
- If there is insufficient space in this bufferIndexOutOfBoundsException
- If start
or end
are negative, start
is greater than end
, or end
is greater than csq.length()
ReadOnlyBufferException
- If this buffer is read-onlypublic CharBuffer append(char c)
An invocation of this method of the form dst.append(c)
behaves in exactly the same way as the invocation
dst.put(c)
append
in interface Appendable
c
- The 16-bit char to appendBufferOverflowException
- If there is insufficient space in this bufferReadOnlyBufferException
- If this buffer is read-onlypublic abstract ByteOrder order()
The byte order of a char buffer created by allocation or by wrapping an existing char
array is the native order
of the underlying hardware. The byte order of a char buffer created as a view of a byte buffer is that of the byte buffer at the moment that the view is created.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/CharBuffer.html