Spec-Zone .ru
спецификации, руководства, описания, API
|
public abstract class CharBuffer extends Buffer implements Comparable<CharBuffer>, Appendable, CharSequence, Readable
Этот class определяет четыре категории операций на буферы случайной работы:
Абсолютный и относительный добраться
и
поместить
методы, которые читают и пишут единственные случайные работы;
Родственник объем добирается
методы, которые передают непрерывные последовательности случайных работ от этого буфера в массив; и
Родственник объем помещается
методы, которые передают непрерывные последовательности случайных работ от массива случайной работы, строки, или некоторого другого буфера случайной работы в этот буфер; и
Методы для уплотнение
,
дублирование
, и
разрезание
буфер случайной работы.
Буферы случайной работы могут быть созданы любой выделение
, который выделяет место для контента буфера,
обертывание
существующий массив случайной работы или строка в буфер, или создавая представление существующего буфера байта.
Как буфер байта, буфер случайной работы является или прямым или непрямым. Буфер случайной работы, создаваемый через методы wrap этого class, будет непрямым. Буфер случайной работы, создаваемый как представление буфера байта, будет прямым, если, и только если, буфер самого байта является прямым. Является ли буфер случайной работы прямым, может быть определен, вызывая isDirect
метод.
Этот class реализует CharSequence
взаимодействуйте через интерфейс так, чтобы символьные буферы могли использоваться везде, где символьные последовательности принимаются, например в пакете регулярного выражения java.util.regex
.
Методы в этом class, у которых иначе нет значения, чтобы возвратиться, определяются, чтобы возвратить буфер, на который они вызываются. Это позволяет вызовам метода быть объединенными в цепочку. Последовательность операторов
может, например, быть заменен единственным операторомcb.put("text/"); cb.put(subtype); cb.put("; charset="); cb.put(enc);
cb.put("text/").put(subtype).put("; charset=").put(enc);
Модификатор и Тип | Метод и Описание |
---|---|
static CharBuffer |
allocate(int capacity)
Выделяет новый буфер случайной работы.
|
CharBuffer |
append(char c)
Добавляет указанную случайную работу к этому буферу (дополнительная работа).
|
CharBuffer |
append(CharSequence csq)
Добавляет указанную символьную последовательность к этому буферу (дополнительная работа).
|
CharBuffer |
append(CharSequence csq, int start, int end)
Добавляет подпоследовательность указанной символьной последовательности к этому буферу (дополнительная работа).
|
char[] |
array()
Возвращается случайная работа выстраивают, это поддерживает этот буфер (дополнительная работа).
|
int |
arrayOffset()
Возвращает смещение в пределах массива поддержки этого буфера первого элемента буфера (дополнительная работа).
|
abstract CharBuffer |
asReadOnlyBuffer()
Создает новый, буфер случайной работы только для чтения, который совместно использует контент этого буфера.
|
char |
charAt(int index)
Читает символ в данном индексируют относительно текущей позиции.
|
abstract CharBuffer |
compact()
Уплотняет этот буфер (дополнительная работа).
|
int |
compareTo(CharBuffer that)
Сравнивает этот буфер с другим.
|
abstract CharBuffer |
duplicate()
Создает новый буфер случайной работы, который совместно использует контент этого буфера.
|
boolean |
equals(Object ob)
Говорит, равен ли этот буфер другому объекту.
|
abstract char |
get()
Родственник получает метод.
|
CharBuffer |
get(char[] dst)
Относительный объем получает метод.
|
CharBuffer |
get(char[] dst, int offset, int length)
Относительный объем получает метод.
|
abstract char |
get(int index)
Абсолютный получают метод.
|
boolean |
hasArray()
Говорит, поддерживается ли этот буфер доступным массивом случайной работы.
|
int |
hashCode()
Возвращает текущий хэш-код этого буфера.
|
abstract boolean |
isDirect()
Говорит, является ли этот буфер случайной работы прямым.
|
int |
length()
Возвращает длину этого символьного буфера.
|
abstract ByteOrder |
order()
Получает порядок байтов этого буфера.
|
abstract CharBuffer |
put(char c)
Родственник помещенный метод (дополнительная работа).
|
CharBuffer |
put(char[] src)
Относительный объем помещенный метод (дополнительная работа).
|
CharBuffer |
put(char[] src, int offset, int length)
Относительный объем помещенный метод (дополнительная работа).
|
CharBuffer |
put(CharBuffer src)
Относительный объем помещенный метод (дополнительная работа).
|
abstract CharBuffer |
put(int index, char c)
Абсолютный помещенный метод (дополнительная работа).
|
CharBuffer |
put(String src)
Относительный объем помещенный метод (дополнительная работа).
|
CharBuffer |
put(String src, int start, int end)
Относительный объем помещенный метод (дополнительная работа).
|
int |
read(CharBuffer target)
Попытки считать символы в указанный символьный буфер.
|
abstract CharBuffer |
slice()
Создает новый буфер случайной работы, контент которого является совместно используемой подпоследовательностью контента этого буфера.
|
abstract CharBuffer |
subSequence(int start, int end)
Создает новый символьный буфер, который представляет указанную подпоследовательность этого буфера относительно текущей позиции.
|
Строка |
toString()
Возвращает строку, содержащую символы в этом буфере.
|
static CharBuffer |
wrap(char[] array)
Обертывает массив случайной работы в буфер.
|
static CharBuffer |
wrap(char[] array, int offset, int length)
Обертывает массив случайной работы в буфер.
|
static CharBuffer |
wrap(CharSequence csq)
Обертывает символьную последовательность в буфер.
|
static CharBuffer |
wrap(CharSequence csq, int start, int end)
Обертывает символьную последовательность в буфер.
|
capacity, clear, flip, hasRemaining, isReadOnly, limit, limit, mark, position, position, remaining, reset, rewind
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
chars, codePoints
public static CharBuffer allocate(int capacity)
Позиция нового буфера будет нулем, его предел будет его емкостью, ее метка будет неопределена, и каждый из ее элементов будет инициализирован, чтобы обнулить. У этого будет a поддержка массива
, и
массив смещается
будет нуль.
capacity
- Емкость нового буфера, в случайных работахIllegalArgumentException
- Если capacity является отрицательным целым числомpublic static CharBuffer wrap(char[] array, int offset, int length)
Новый буфер будет поддержан данным массивом случайной работы; то есть, модификации к буферу заставят массив быть измененным и наоборот. Емкостью нового буфера будет array.length, его позицией будет offset, его пределом будет offset + length, и его метка будет неопределена. поддержка массива
будет данный массив, и
массив смещается
будет нуль.
array
- Массив, который поддержит новый буферoffset
- Смещение подмассива, который будет использоваться; должно быть неотрицательным и не больше чем array.length. Позиция нового буфера будет установлена в это значение.length
- Длина подмассива, который будет использоваться; должно быть неотрицательным и не больше чем array.length - offset. Предел нового буфера будет установлен к offset + length.IndexOutOfBoundsException
- Если предварительные условия на offset и параметрах length не содержатpublic static CharBuffer wrap(char[] array)
Новый буфер будет поддержан данным массивом случайной работы; то есть, модификации к буферу заставят массив быть измененным и наоборот. Емкостью нового буфера и пределом будет array.length, его позиция будет нулем, и его метка будет неопределена. поддержка массива
будет данный массив, и
массив смещается
будет нуль.
array
- Массив, который поддержит этот буферpublic int read(CharBuffer target) throws IOException
read
в интерфейсе Readable
target
- буфер, чтобы считать символы вIOException
- если ошибка ввода-вывода происходитNullPointerException
- если цель является нулемReadOnlyBufferException
- если цель является буфером только для чтенияpublic static CharBuffer wrap(CharSequence csq, int start, int end)
Контент нового, буфера только для чтения будет контентом данной символьной последовательности. Емкостью буфера будет csq.length(), его позицией будет start, его пределом будет end, и его метка будет неопределена.
csq
- Символьная последовательность, из которой должен быть создан новый символьный буферstart
- Индексирование первого символа, который будет использоваться; должно быть неотрицательным и не больше чем csq.length(). Позиция нового буфера будет установлена в это значение.end
- Индексирование символа после последнего знака, который будет использоваться; должно быть не меньшим чем start и не больше чем csq.length(). Предел нового буфера будет установлен к этому значению.IndexOutOfBoundsException
- Если предварительные условия на start и параметрах end не содержатpublic static CharBuffer wrap(CharSequence csq)
Контент нового, буфера только для чтения будет контентом данной символьной последовательности. Емкостью нового буфера и пределом будет csq.length(), его позиция будет нулем, и его метка будет неопределена.
csq
- Символьная последовательность, из которой должен быть создан новый символьный буферpublic abstract CharBuffer slice()
Контент нового буфера запустится в текущей позиции этого буфера. Изменения к контенту этого буфера будут видимы в новом буфере, и наоборот; позиция этих двух буферов, предел, и значения метки будут независимы.
Позиция нового буфера будет нулем, его емкость и его предел будут числом случайных работ, остающихся в этом буфере, и его метка будет неопределена. Новый буфер будет прямым, если, и только если, этот буфер является прямым, и это будет только для чтения, если, и только если, этот буфер только для чтения.
public abstract CharBuffer duplicate()
Контент нового буфера будет контентом этого буфера. Изменения к контенту этого буфера будут видимы в новом буфере, и наоборот; позиция этих двух буферов, предел, и значения метки будут независимы.
Емкость нового буфера, предел, позиция, и значения метки будут идентичны таковым из этого буфера. Новый буфер будет прямым, если, и только если, этот буфер является прямым, и это будет только для чтения, если, и только если, этот буфер только для чтения.
public abstract CharBuffer asReadOnlyBuffer()
Контент нового буфера будет контентом этого буфера. Изменения к контенту этого буфера будут видимы в новом буфере; новый буфер непосредственно, однако, будет только для чтения и не будет позволять совместно используемому контенту быть измененным. Позиция этих двух буферов, предел, и значения метки будут независимы.
Емкость нового буфера, предел, позиция, и значения метки будут идентичны таковым из этого буфера.
Если этот буфер самостоятельно только для чтения тогда, этот метод ведет себя точно таким же образом как duplicate
метод.
public abstract char get()
BufferUnderflowException
- Если текущая позиция буфера не меньше чем ее пределpublic abstract CharBuffer put(char c)
Пишет данная случайная работа в этот буфер в текущей позиции, и затем постепенно увеличивает позицию.
c
- Случайная работа, которая будет записанаBufferOverflowException
- Если текущая позиция этого буфера не меньше чем ее пределReadOnlyBufferException
- Если этот буфер только для чтенияpublic abstract char get(int index)
index
- Индексирование, из которого будет считана случайная работаIndexOutOfBoundsException
- Если index отрицателен или не меньше чем предел буфераpublic abstract CharBuffer put(int index, char c)
Пишет, что данная случайная работа в этот буфер в данном индексирует.
index
- Индексирование, при котором будет записана случайная работаc
- Значение случайной работы, которое будет записаноIndexOutOfBoundsException
- Если index отрицателен или не меньше чем предел буфераReadOnlyBufferException
- Если этот буфер только для чтенияpublic CharBuffer get(char[] dst, int offset, int length)
Этот метод передает случайные работы от этого буфера в данный целевой массив. Если есть меньше случайных работ, остающихся в буфере, чем обязаны удовлетворять запрос, то есть, если length > remaining(), то никакие случайные работы не передаются и a BufferUnderflowException
бросается.
Иначе, этот метод копирует случайные работы length с этого буфера в данный массив, запускающийся в текущей позиции этого буфера и при данном смещении в массиве. Позиция этого буфера тогда постепенно увеличивается length.
Другими словами вызов этого метода формы src.get(dst, off, len) имеет точно тот же самый эффект как цикл
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.
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.lengthlength
- The maximum number of chars to be written to the given
array; must be non-negative and no larger than
dst.length - offsetBufferUnderflowException
- 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)
BufferUnderflowException
- If there are fewer than length chars
remaining in this bufferpublic 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());except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
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(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(a[i]);except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
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 array.lengthlength
- The number of chars to be read from the given array;
must be non-negative and no larger than
array.length - offsetBufferOverflowException
- 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)
BufferOverflowException
- If there is insufficient space in this bufferReadOnlyBufferException
- 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));except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.
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())
BufferOverflowException
- 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 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.
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
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.
equals
in class Object
ob
- The object to which this buffer is to be comparedObject.hashCode()
,
HashMap
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 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 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()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, 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.
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.
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b92