/* * Copyright (c) 2000, 2008, Oracle and/or its affiliates. All rights reserved. * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. * * * * * * * * * * * * * * * * * * * * */ // -- This file was mechanically generated: Do not edit! -- // package java.nio; import java.io.IOException; /** * A char buffer. * *
This class defines four categories of operations upon * char buffers: * *
Absolute and relative {@link #get() get} and
* {@link #put(char) put} methods that read and write
* single chars;
Relative {@link #get(char[]) bulk get}
* methods that transfer contiguous sequences of chars from this buffer
* into an array; and
Relative {@link #put(char[]) bulk put}
* methods that transfer contiguous sequences of chars from a
* char array, a string, or some other char
* buffer into this buffer; and
Methods for {@link #compact compacting}, {@link
* #duplicate duplicating}, and {@link #slice
* slicing} a char buffer.
Char buffers can be created either by {@link #allocate
* allocation 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 {@link
* #isDirect isDirect} method. This class implements the {@link CharSequence} interface so that
* character buffers may be used wherever character sequences are accepted, for
* example in the regular-expression package {@link java.util.regex}.
* 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
*
* The new buffer's position will be zero, its limit will be its
* capacity, its mark will be undefined, and each of its elements will be
* initialized to zero. It will have a {@link #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 will be
* array.length, its position will be offset, its limit
* will be offset + length, and its mark will be undefined. Its
* {@link #array }, which allocates space for the buffer's
*
*
* content, by {@link #wrap(char[]) wrapping} an existing
* char array or string into a buffer, or by creating a
* view of an existing byte buffer.
*
*
*
*
* backing array
*
* can, for example, be replaced by the single statement
*
*
* cb.put("text/");
* cb.put(subtype);
* cb.put("; charset=");
* cb.put(enc);
*
*
*
* @author Mark Reinhold
* @author JSR-51 Expert Group
* @since 1.4
*/
public abstract class CharBuffer
extends Buffer
implements Comparable
* cb.put("text/").put(subtype).put("; charset=").put(enc);}, and its {@link #arrayOffset array
* offset} will be zero.
*
* @param capacity
* The new buffer's capacity, in chars
*
* @return The new char buffer
*
* @throws IllegalArgumentException
* If the capacity is a negative integer
*/
public static CharBuffer allocate(int capacity) {
if (capacity < 0)
throw new IllegalArgumentException();
return new HeapCharBuffer(capacity, capacity);
}
/**
* Wraps a char array into a buffer.
*
* backing array} will be the given array, and
* its {@link #arrayOffset array offset} will be zero.
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, and its mark will be
* undefined. Its {@link #array backing array} will be the
* given array, and its {@link #arrayOffset array offset} will
* be zero.
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.
* * @param csq * The character sequence from which the new character buffer is to * be created * * @param start * 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. * * @param 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. * * @return The new character buffer * * @throws IndexOutOfBoundsException * If the preconditions on the start and end * parameters do not hold */ public static CharBuffer wrap(CharSequence csq, int start, int end) { try { return new StringCharBuffer(csq, start, end); } catch (IllegalArgumentException x) { throw new IndexOutOfBoundsException(); } } /** * Wraps a character sequence into a buffer. * *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.
* * @param csq * The character sequence from which the new character buffer is to * be created * * @return The new character buffer */ public static CharBuffer wrap(CharSequence csq) { return wrap(csq, 0, csq.length()); } /** * Creates a new char buffer whose content is a shared subsequence of * this buffer's content. * *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, and its mark * will be undefined. 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.
* * @return The new char buffer */ public abstract CharBuffer slice(); /** * Creates a new char buffer that shares this buffer's content. * *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, and mark values 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.
* * @return The new char buffer */ public abstract CharBuffer duplicate(); /** * Creates a new, read-only char buffer that shares this buffer's * content. * *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, and mark values 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 {@link #duplicate duplicate} method.
* * @return The new, read-only char buffer */ public abstract CharBuffer asReadOnlyBuffer(); // -- Singleton get/put methods -- /** * Relative get method. Reads the char at this buffer's * current position, and then increments the position. * * @return The char at the buffer's current position * * @throws BufferUnderflowException * If the buffer's current position is not smaller than its limit */ public abstract char get(); /** * Relative put method (optional operation). * *Writes the given char into this buffer at the current * position, and then increments the position.
* * @param c * The char to be written * * @return This buffer * * @throws BufferOverflowException * If this buffer's current position is not smaller than its limit * * @throws ReadOnlyBufferException * If this buffer is read-only */ public abstract CharBuffer put(char c); /** * Absolute get method. Reads the char at the given * index. * * @param index * The index from which the char will be read * * @return The char at the given index * * @throws IndexOutOfBoundsException * If index is negative * or not smaller than the buffer's limit */ public abstract char get(int index); /** * Absolute put method (optional operation). * *Writes the given char into this buffer at the given * index.
* * @param index * The index at which the char will be written * * @param c * The char value to be written * * @return This buffer * * @throws IndexOutOfBoundsException * If index is negative * or not smaller than the buffer's limit * * @throws ReadOnlyBufferException * If this buffer is read-only */ public abstract CharBuffer put(int index, char c); // -- Bulk get operations -- /** * Relative bulk get method. * *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 {@link 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();
*
* except that it first checks that there are sufficient chars in
* this buffer and it is potentially much more efficient.
*
* @param dst
* The array into which chars are to be written
*
* @param offset
* The offset within the array of the first char to be
* written; must be non-negative and no larger than
* dst.length
*
* @param length
* The maximum number of chars to be written to the given
* array; must be non-negative and no larger than
* dst.length - offset
*
* @return This buffer
*
* @throws BufferUnderflowException
* If there are fewer than length chars
* remaining in this buffer
*
* @throws IndexOutOfBoundsException
* If the preconditions on the offset and length
* parameters do not hold
*/
public CharBuffer get(char[] dst, int offset, int length) {
checkBounds(offset, length, dst.length);
if (length > remaining())
throw new BufferUnderflowException();
int end = offset + length;
for (int i = offset; i < end; i++)
dst[i] = get();
return this;
}
/**
* Relative bulk get method.
*
* 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)
*
* @return This buffer
*
* @throws BufferUnderflowException
* If there are fewer than length chars
* remaining in this buffer
*/
public CharBuffer get(char[] dst) {
return get(dst, 0, dst.length);
}
// -- Bulk put operations --
/**
* Relative bulk put method (optional operation).
*
* 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 {@link * 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());
*
* except that it first checks that there is sufficient space in this
* buffer and it is potentially much more efficient.
*
* @param src
* The source buffer from which chars are to be read;
* must not be this buffer
*
* @return This buffer
*
* @throws BufferOverflowException
* If there is insufficient space in this buffer
* for the remaining chars in the source buffer
*
* @throws IllegalArgumentException
* If the source buffer is this buffer
*
* @throws ReadOnlyBufferException
* If this buffer is read-only
*/
public CharBuffer put(CharBuffer src) {
if (src == this)
throw new IllegalArgumentException();
int n = src.remaining();
if (n > remaining())
throw new BufferOverflowException();
for (int i = 0; i < n; i++)
put(src.get());
return this;
}
/**
* Relative bulk put method (optional operation).
*
* 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 {@link 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(a[i]);
*
* except that it first checks that there is sufficient space in this
* buffer and it is potentially much more efficient.
*
* @param src
* The array from which chars are to be read
*
* @param offset
* The offset within the array of the first char to be read;
* must be non-negative and no larger than array.length
*
* @param length
* The number of chars to be read from the given array;
* must be non-negative and no larger than
* array.length - offset
*
* @return This buffer
*
* @throws BufferOverflowException
* If there is insufficient space in this buffer
*
* @throws IndexOutOfBoundsException
* If the preconditions on the offset and length
* parameters do not hold
*
* @throws ReadOnlyBufferException
* If this buffer is read-only
*/
public CharBuffer put(char[] src, int offset, int length) {
checkBounds(offset, length, src.length);
if (length > remaining())
throw new BufferOverflowException();
int end = offset + length;
for (int i = offset; i < end; i++)
this.put(src[i]);
return this;
}
/**
* Relative bulk put method (optional operation).
*
* 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)
*
* @return This buffer
*
* @throws BufferOverflowException
* If there is insufficient space in this buffer
*
* @throws ReadOnlyBufferException
* If this buffer is read-only
*/
public final CharBuffer put(char[] src) {
return put(src, 0, src.length);
}
/**
* Relative bulk put method (optional operation).
*
* 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 {@link * 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));
*
* except that it first checks that there is sufficient space in this
* buffer and it is potentially much more efficient.
*
* @param src
* The string from which chars are to be read
*
* @param start
* The offset within the string of the first char to be read;
* must be non-negative and no larger than
* string.length()
*
* @param 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()
*
* @return This buffer
*
* @throws BufferOverflowException
* If there is insufficient space in this buffer
*
* @throws IndexOutOfBoundsException
* If the preconditions on the start and end
* parameters do not hold
*
* @throws ReadOnlyBufferException
* If this buffer is read-only
*/
public CharBuffer put(String src, int start, int end) {
checkBounds(start, end - start, src.length());
for (int i = start; i < end; i++)
this.put(src.charAt(i));
return this;
}
/**
* Relative bulk put method (optional operation).
*
* 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())
*
* @return This buffer
*
* @throws BufferOverflowException
* If there is insufficient space in this buffer
*
* @throws ReadOnlyBufferException
* If this buffer is read-only
*/
public final CharBuffer put(String src) {
return put(src, 0, src.length());
}
// -- Other stuff --
/**
* Tells whether or not this buffer is backed by an accessible char
* array.
*
* If this method returns true then the {@link #array() array} * and {@link #arrayOffset() arrayOffset} methods may safely be invoked. *
* * @return true if, and only if, this buffer * is backed by an array and is not read-only */ public final boolean hasArray() { return (hb != null) && !isReadOnly; } /** * Returns the char array that backs this * buffer (optional operation). * *Modifications to this buffer's content will cause the returned * array's content to be modified, and vice versa. * *
Invoke the {@link #hasArray hasArray} method before invoking this * method in order to ensure that this buffer has an accessible backing * array.
* * @return The array that backs this buffer * * @throws ReadOnlyBufferException * If this buffer is backed by an array but is read-only * * @throws UnsupportedOperationException * If this buffer is not backed by an accessible array */ public final char[] array() { if (hb == null) throw new UnsupportedOperationException(); if (isReadOnly) throw new ReadOnlyBufferException(); return hb; } /** * Returns the offset within this buffer's backing array of the first * element of the buffer (optional operation). * *If this buffer is backed by an array then buffer position p * corresponds to array index p + arrayOffset(). * *
Invoke the {@link #hasArray hasArray} method before invoking this * method in order to ensure that this buffer has an accessible backing * array.
* * @return The offset within this buffer's array * of the first element of the buffer * * @throws ReadOnlyBufferException * If this buffer is backed by an array but is read-only * * @throws UnsupportedOperationException * If this buffer is not backed by an accessible array */ public final int arrayOffset() { if (hb == null) throw new UnsupportedOperationException(); if (isReadOnly) throw new ReadOnlyBufferException(); return offset; } /** * Compacts this buffer (optional operation). * *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.
* * * @return This buffer * * @throws ReadOnlyBufferException * If this buffer is read-only */ public abstract CharBuffer compact(); /** * Tells whether or not this char buffer is direct. * * @return true if, and only if, this buffer is direct */ public abstract boolean isDirect(); /** * Returns the current hash code of this buffer. * *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.
* * @return The current hash code of this buffer */ public int hashCode() { int h = 1; int p = position(); for (int i = limit() - 1; i >= p; i--) h = 31 * h + (int)get(i); return h; } /** * Tells whether or not this buffer is equal to another object. * *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.
* * @param ob The object to which this buffer is to be compared * * @return true if, and only if, this buffer is equal to the * given object */ public boolean equals(Object ob) { if (this == ob) return true; if (!(ob instanceof CharBuffer)) return false; CharBuffer that = (CharBuffer)ob; if (this.remaining() != that.remaining()) return false; int p = this.position(); for (int i = this.limit() - 1, j = that.limit() - 1; i >= p; i--, j--) if (!equals(this.get(i), that.get(j))) return false; return true; } private static boolean equals(char x, char y) { return x == y; } /** * Compares this buffer to another. * *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 {@code char} elements are compared as if by invoking * {@link Character#compare(char,char)}. * *
A char buffer is not comparable to any other type of object. * * @return A negative integer, zero, or a positive integer as this buffer * is less than, equal to, or greater than the given buffer */ public int compareTo(CharBuffer that) { int n = this.position() + Math.min(this.remaining(), that.remaining()); for (int i = this.position(), j = that.position(); i < n; i++, j++) { int cmp = compare(this.get(i), that.get(j)); if (cmp != 0) return cmp; } return this.remaining() - that.remaining(); } private static int compare(char x, char y) { return Character.compare(x, y); } // -- Other char stuff -- /** * Returns a string containing the characters in this buffer. * *
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.
* * @return The specified string */ public String toString() { return toString(position(), limit()); } abstract String toString(int start, int end); // package-private // --- Methods to support CharSequence --- /** * Returns the length of this character buffer. * *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().
* * @return The length of this character buffer */ public final int length() { return remaining(); } /** * Reads the character at the given index relative to the current * position. * * @param index * The index of the character to be read, relative to the position; * must be non-negative and smaller than remaining() * * @return The character at index * position() + index * * @throws IndexOutOfBoundsException * If the preconditions on index do not hold */ public final char charAt(int index) { return get(position() + checkIndex(index, 1)); } /** * Creates a new character buffer that represents the specified subsequence * of this buffer, relative to the current position. * *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, and its limit will be * position() + end. 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.
* * @param start * The index, relative to the current position, of the first * character in the subsequence; must be non-negative and no larger * than remaining() * * @param 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() * * @return The new character buffer * * @throws IndexOutOfBoundsException * If the preconditions on start and end * do not hold */ public abstract CharBuffer subSequence(int start, int end); // --- Methods to support Appendable --- /** * Appends the specified character sequence to this * buffer (optional operation). * *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 {@link CharBuffer#toString() * toString} method of a character buffer will return a subsequence whose * content depends upon the buffer's position and limit. * * @param csq * The character sequence to append. If csq is * null, then the four characters "null" are * appended to this character buffer. * * @return This buffer * * @throws BufferOverflowException * If there is insufficient space in this buffer * * @throws ReadOnlyBufferException * If this buffer is read-only * * @since 1.5 */ public CharBuffer append(CharSequence csq) { if (csq == null) return put("null"); else return put(csq.toString()); } /** * Appends a subsequence of the specified character sequence to this * buffer (optional operation). * *
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())
*
* @param 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".
*
* @return This buffer
*
* @throws BufferOverflowException
* If there is insufficient space in this buffer
*
* @throws IndexOutOfBoundsException
* If start or end are negative, start
* is greater than end, or end is greater than
* csq.length()
*
* @throws ReadOnlyBufferException
* If this buffer is read-only
*
* @since 1.5
*/
public CharBuffer append(CharSequence csq, int start, int end) {
CharSequence cs = (csq == null ? "null" : csq);
return put(cs.subSequence(start, end).toString());
}
/**
* Appends the specified char to this
* buffer (optional operation).
*
* An invocation of this method of the form dst.append(c) * behaves in exactly the same way as the invocation * *
* dst.put(c)
*
* @param c
* The 16-bit char to append
*
* @return This buffer
*
* @throws BufferOverflowException
* If there is insufficient space in this buffer
*
* @throws ReadOnlyBufferException
* If this buffer is read-only
*
* @since 1.5
*/
public CharBuffer append(char c) {
return put(c);
}
// -- Other byte stuff: Access to binary data --
/**
* Retrieves this buffer's byte order.
*
* The byte order of a char buffer created by allocation or by
* wrapping an existing char array is the {@link
* ByteOrder#nativeOrder 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.