Класс CharBuffer

public static CharBuffer allocate(int capacity)

Выделяет новый буфер char.

Положение нового буфера будет равно нулю, его предел — его емкость, метка будет неопределена, каждый его элемент будет инициализирован нулем, а порядок байтов — native order базового оборудования. Он будет иметь backing array, а его array offset будет равен нулю.

public static CharBuffer wrap(char[] array, int offset, int length)

Оборачивает массив char в буфер.

Новый буфер будет поддерживаться заданным массивом char; то есть изменения в буфере приведут к изменению массива и наоборот. Емкость нового буфера будет array.length, его положение — offset, его предел — offset + length, его метка будет неопределена, а порядок байтов — native order базового оборудования. Его backing array будет заданным массивом, а его array offset — нулём.

public static CharBuffer wrap(char[] array)

Оборачивает массив char в буфер.

Новый буфер будет поддерживаться заданным массивом char; то есть изменения в буфере приведут к изменению массива и наоборот. Емкость и предел нового буфера будут array.length, его положение будет нулём, его метка — неопределённой, а порядок байтов — native order базового оборудования. Его backing array будет заданным массивом, а его array offset — нулём.

public int read(CharBuffer target) throws IOException

Пытается считать символы в указанный буфер символов. Буфер используется как хранилище символов как есть: единственные изменения — результаты операции put. Никакое переключение или перемотка буфера не выполняются.

public static CharBuffer wrap(CharSequence csq, int start, int end)

Оборачивает последовательность символов в буфер.

Содержимое нового, только для чтения буфера будет содержанием заданной последовательности символов. Емкость буфера будет csq.length(), его положение — start, его предел — end, а его метка — неопределена.

public static CharBuffer wrap(CharSequence csq)

Оборачивает последовательность символов в буфер.

Содержимое нового, только для чтения буфера будет содержанием заданной последовательности символов. Емкость и предел нового буфера будут csq.length(), его положение — нулём, а его метка — неопределённой.

public abstract CharBuffer slice()

Создаёт новый буфер char, чьё содержимое является совместной подпоследовательностью содержимого этого буфера.

Содержимое нового буфера начнётся с текущего положения этого буфера. Изменения в содержимом этого буфера будут видны в новом буфере, и наоборот; значения положения, предела и метки двух буферов будут независимы.

Положение нового буфера будет нулём, его емкость и предел будут количеством оставшихся символов в этом буфере, его метка будет неопределённой, а порядок байтов будет идентичным порядку байтов этого буфера. Новый буфер будет прямым, если и только если этот буфер прямой, и он будет только для чтения, если и только если этот буфер только для чтения.

public abstract CharBuffer slice(int index, int length)

Создаёт новый буфер char, чьё содержимое является совместной подпоследовательностью содержимого этого буфера.

Содержимое нового буфера начнётся с позиции index в этом буфере и будет содержать length элементов. Изменения в содержимом этого буфера будут видны в новом буфере, и наоборот; значения положения, предела и метки двух буферов будут независимы.

Положение нового буфера будет нулём, его емкость и предел будут length, его метка будет неопределённой, а порядок байтов будет идентичным порядку байтов этого буфера. Новый буфер будет прямым, если и только если этот буфер прямой, и он будет только для чтения, если и только если этот буфер только для чтения.

public abstract CharBuffer duplicate()

Создаёт новый буфер char, который разделяет содержимое этого буфера.

Содержимое нового буфера будет таким же, как содержимое этого буфера. Изменения в содержимом этого буфера будут видны в новом буфере, и наоборот; значения положения, предела и метки двух буферов будут независимы.

Емкость, предел, положение, метка и порядок байтов нового буфера будут идентичны значениям этого буфера. Новый буфер будет прямым, если и только если этот буфер прямой, и он будет только для чтения, если и только если этот буфер только для чтения.

public abstract CharBuffer asReadOnlyBuffer()

Создаёт новый, только для чтения буфер char, который разделяет содержимое этого буфера.

Содержимое нового буфера будет таким же, как содержимое этого буфера. Изменения в содержимом этого буфера будут видны в новом буфере; однако сам новый буфер будет только для чтения и не позволит изменять совместное содержимое. Значения положения, предела и метки двух буферов будут независимы.

Емкость, предел, положение, метка и порядок байтов нового буфера будут идентичны значениям этого буфера.

Если этот буфер сам по себе только для чтения, то этот метод ведёт себя точно так же, как метод duplicate.

public abstract char get()

Относительный метод get. Считывает символ char в текущем положении буфера и затем увеличивает положение.

public abstract CharBuffer put(char c)

Относительный метод put (необязательная операция).

Записывает заданный символ char в этот буфер в текущем положении и затем увеличивает положение.

public abstract char get(int index)

Абсолютный метод получить. Читает символ по заданному индексу.

public abstract CharBuffer put(int index, char c)

Абсолютный метод вставить (дополнительная операция).

Записывает заданный символ в этот буфер по заданному индексу.

public CharBuffer get(char[] dst, int offset, int length)

Относительный метод получить для блочных операций.

Этот метод переносит символы из этого буфера в заданный массив назначения. Если оставшихся символов в буфере меньше, чем требуется для выполнения запроса, то есть, если length > remaining(), то символы не переносятся, и выбрасывается исключение BufferUnderflowException.

В противном случае, этот метод копирует length символов из этого буфера в заданный массив, начиная с текущей позиции этого буфера и по заданному смещению в массиве. Позиция этого буфера затем увеличивается на length.

Другими словами, вызов этого метода в форме src.get(dst, off, len) имеет точно такой же эффект, как цикл

     for (int i = off; i < off + len; i++)
         dst[i] = src.get();
 

за исключением того, что он сначала проверяет, достаточно ли символов в этом буфере, и потенциально может быть намного эффективнее.

public CharBuffer get(char[] dst)

Относительный метод получить для блочных операций.

Этот метод переносит символы из этого буфера в заданный массив назначения. Вызов этого метода в форме src.get(a) ведет себя точно так же, как вызов

     src.get(a, 0, a.length) 

public CharBuffer get(int index, char[] dst, int offset, int length)

Абсолютный метод получить для блочных операций.

Этот метод переносит length символов из этого буфера в заданный массив, начиная с заданного индекса в этом буфере и по заданному смещению в массиве. Позиция этого буфера не изменяется.

Вызов этого метода в форме src.get(index, dst, offset, length) имеет точно такой же эффект, как следующий цикл, за исключением того, что он сначала проверяет согласованность предоставленных параметров и потенциально намного эффективнее:

     for (int i = offset, j = index; i < offset + length; i++, j++)
         dst[i] = src.get(j);
 

public CharBuffer get(int index, char[] dst)

Абсолютный метод получить для блочных операций.

Этот метод переносит символы из этого буфера в заданный массив назначения. Позиция этого буфера не изменяется. Вызов этого метода в форме src.get(index, dst) ведет себя точно так же, как вызов:

     src.get(index, dst, 0, dst.length) 

public CharBuffer put(CharBuffer src)

Относительный метод вставить для блочных операций (дополнительная операция).

Этот метод переносит оставшиеся символы из заданного буфера источника в этот буфер. Если оставшихся символов в буфере источника больше, чем в этом буфере, то есть, если src.remaining() > remaining(), то символы не переносятся, и выбрасывается исключение BufferOverflowException.

В противном случае, этот метод копирует n = src.remaining() символов из заданного буфера в этот буфер, начиная с текущей позиции каждого буфера. Позиции обоих буферов затем увеличиваются на n.

Другими словами, вызов этого метода в форме dst.put(src) имеет точно такой же эффект, как цикл

     while (src.hasRemaining())
         dst.put(src.get()); 

за исключением того, что он сначала проверяет, достаточно ли места в этом буфере, и потенциально может быть намного эффективнее. Если этот буфер и буфер источника делят один и тот же массив или память, то результат будет таким, как если бы элементы источника сначала были скопированы во временное местоположение перед записью в этот буфер.

public CharBuffer put(int index, CharBuffer src, int offset, int length)

Абсолютный метод вставить для блочных операций (дополнительная операция).

Этот метод переносит length символов в этот буфер из заданного буфера источника, начиная с заданного offset в буфере источника и заданного index в этом буфере. Позиции обоих буферов не изменяются.

Другими словами, вызов этого метода в форме dst.put(index, src, offset, length) имеет точно такой же эффект, как цикл

 for (int i = offset, j = index; i < offset + length; i++, j++)
     dst.put(j, src.get(i));
 

за исключением того, что он сначала проверяет согласованность предоставленных параметров и потенциально намного эффективнее. Если этот буфер и буфер источника делят один и тот же массив или память, то результат будет таким, как если бы элементы источника сначала были скопированы во временное местоположение перед записью в этот буфер.

public CharBuffer put(char[] src, int offset, int length)

Метод put для относительного объёмного копирования (необязательная операция).

Этот метод копирует символы из заданного исходного массива в этот буфер. Если символов для копирования больше, чем остается места в этом буфере, то есть, если length > remaining(), то символы не копируются, и выбрасывается исключение BufferOverflowException.

В противном случае, этот метод копирует length символов из заданного массива в этот буфер, начиная с заданного смещения в массиве и с текущей позиции этого буфера. Позиция этого буфера затем увеличивается на length.

Другими словами, вызов этого метода в форме dst.put(src, off, len) имеет точно такой же эффект, как цикл

     for (int i = off; i < off + len; i++)
         dst.put(src[i]);
 

за исключением того, что он сначала проверяет достаточность места в этом буфере и потенциально является намного более эффективным.

public final CharBuffer put(char[] src)

Метод put для относительного объёмного копирования (необязательная операция).

Этот метод копирует всё содержимое заданного исходного массива символов в этот буфер. Вызов этого метода в форме dst.put(a) ведет себя точно так же, как вызов

     dst.put(a, 0, a.length) 

public CharBuffer put(int index, char[] src, int offset, int length)

Метод put для абсолютного объёмного копирования (необязательная операция).

Этот метод копирует length символов из заданного массива, начиная со заданного смещения в массиве и с заданного индекса в этом буфере. Позиция этого буфера остается неизменной.

Вызов этого метода в форме dst.put(index, src, offset, length) имеет точно такой же эффект, как следующий цикл, за исключением того, что он сначала проверяет согласованность предоставленных параметров и потенциально является намного более эффективным:

     for (int i = offset, j = index; i < offset + length; i++, j++)
         dst.put(j, src[i]);
 

public CharBuffer put(int index, char[] src)

Метод put для абсолютного объёмного копирования (необязательная операция).

Этот метод копирует символы из заданного исходного массива в этот буфер. Позиция этого буфера остается неизменной. Вызов этого метода в форме dst.put(index, src) ведет себя точно так же, как вызов:

     dst.put(index, src, 0, src.length); 

public CharBuffer put(String src, int start, int end)

Метод put для относительного объёмного копирования (необязательная операция).

Этот метод копирует символы из заданной строки в этот буфер. Если символов для копирования больше, чем остается места в этом буфере, то есть, если end - start > remaining(), то символы не копируются, и выбрасывается исключение BufferOverflowException.

В противном случае, этот метод копирует n = end - start символов из заданной строки в этот буфер, начиная с заданного start индекса и с текущей позиции этого буфера. Позиция этого буфера затем увеличивается на n.

Другими словами, вызов этого метода в форме dst.put(src, start, end) имеет точно такой же эффект, как цикл

     for (int i = start; i < end; i++)
         dst.put(src.charAt(i));
 

за исключением того, что он сначала проверяет достаточность места в этом буфере и потенциально является намного более эффективным.

public final CharBuffer put(String src)

Метод put для относительного объёмного копирования (необязательная операция).

Этот метод копирует всё содержимое заданной строки в этот буфер. Вызов этого метода в форме dst.put(s) ведет себя точно так же, как вызов

     dst.put(s, 0, s.length()) 

public final boolean hasArray()

Определяет, поддерживается ли этот буфер массивом символов с доступом.

Если этот метод возвращает true то методы array и arrayOffset могут быть безопасно вызваны.

public final char[] array()

Возвращает массив символов, поддерживающий этот буфер (необязательная операция).

Изменения в содержимом этого буфера приведут к изменению содержимого возвращаемого массива, и наоборот.

Вызовите метод hasArray перед вызовом этого метода, чтобы убедиться, что этот буфер имеет доступный поддерживающий массив.

public final int arrayOffset()

Возвращает смещение в поддерживающем массиве этого буфера первого элемента буфера (необязательная операция).

Если этот буфер поддерживается массивом, то позиция буфера p соответствует индексу массива p + arrayOffset().

Вызовите метод hasArray перед вызовом этого метода, чтобы убедиться, что этот буфер имеет доступный поддерживающий массив.

public final CharBuffer position(int newPosition)

Устанавливает позицию этого буфера. Если метка определена и больше новой позиции, то она отбрасывается.

public final CharBuffer limit(int newLimit)

Устанавливает предел этого буфера. Если позиция больше нового предела, то она устанавливается на новый предел. Если метка определена и больше нового предела, то она отбрасывается.

public final CharBuffer mark()

Устанавливает метку этого буфера в его текущей позиции.

public final CharBuffer reset()

Сбрасывает позицию этого буфера до позиции, отмеченной ранее.

Вызов этого метода не изменяет и не удаляет значение метки.

public final CharBuffer clear()

Очищает этот буфер. Позиция устанавливается в ноль, предел устанавливается в емкость, а метка удаляется.

Вызовите этот метод перед использованием последовательности операций чтения канала или операций put для заполнения этого буфера. Например:

 buf.clear();     // Prepare buffer for reading
 in.read(buf);    // Read data

Этот метод на самом деле не стирает данные в буфере, но он назван так, как будто это делает, потому что он чаще всего используется в ситуациях, в которых это может быть и нужно.

public final CharBuffer flip()

Переворачивает этот буфер. Предел устанавливается в текущую позицию, а затем позиция устанавливается в ноль. Если метка определена, она удаляется.

После последовательности операций чтения канала или операций put вызовите этот метод, чтобы подготовиться к последовательности операций записи канала или относительных операций get. Например:

 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

Этот метод часто используется совместно с методом compact, когда данные передаются из одного места в другое.

public final CharBuffer rewind()

Перематывает этот буфер. Позиция устанавливается в ноль, а метка удаляется.

Вызовите этот метод перед последовательностью операций записи канала или операций get, предположив, что предел уже установлен должным образом. Например:

 out.write(buf);    // Write remaining data
 buf.rewind();      // Rewind buffer
 buf.get(array);    // Copy data into array

public abstract CharBuffer compact()

Сжимает этот буфер (дополнительная операция).

Символы между текущей позицией буфера и его пределом, если таковые имеются, копируются в начало буфера. То есть символ с индексом p = position() копируется в индекс ноль, символ с индексом p + 1 копируется в индекс один и так далее, пока символ с индексом limit() - 1 не будет скопирован в индекс n = limit() - 1 - p. Позиция буфера затем устанавливается в n+1, а его предел — в его емкость. Метка, если определена, удаляется.

Позиция буфера устанавливается в число скопированных символов, а не в ноль, чтобы вызов этого метода можно было немедленно последовать вызовом другого относительного метода put.

public abstract boolean isDirect()

Указывает, является ли этот буфер символов прямым.

public int hashCode()

Возвращает текущий хэш-код этого буфера.

Хэш-код буфера символов зависит только от его оставшихся элементов; то есть от элементов с position() до, и включая, элемент с индексом limit() - 1.

Поскольку хэш-коды буферов зависят от содержимого, не рекомендуется использовать буферы в качестве ключей в хэш-картах или подобных структурах данных, если неизвестно, что их содержимое не изменится.

public boolean equals(Object ob)

Указывает, равен ли этот буфер другому объекту.

Два буфера символов равны тогда и только тогда, когда

1. У них одинаковый тип элементов,

2. У них одинаковое количество оставшихся элементов, и

3. Две последовательности оставшихся элементов, рассматриваемые независимо от своих начальных позиций, точечно равны.

Буфер символов не равен ни одному другому типу объекта.

public int compareTo(CharBuffer that)

Сравнивает этот буфер с другим.

Два буфера символов сравниваются путём лексикографического сравнения их последовательностей оставшихся элементов без учёта начальной позиции каждой последовательности в соответствующем буфере. Пары char элементов сравниваются, как будто вызывается Character.compare(char,char).

Буфер символов не сравним ни с каким другим типом объекта.

public int mismatch(CharBuffer that)

Находит и возвращает относительный индекс первого несовпадения между этим буфером и заданным буфером. Индекс относится к position каждого буфера и будет в диапазоне от 0 (включительно) до меньшего из remaining элементов в каждом буфере (исключительно).

Если два буфера имеют общую префиксную часть, возвращаемый индекс — это длина общей префиксной части, и это следует из того, что между двумя буферами есть несовпадение в этом индексе в пределах соответствующих буферов. Если один буфер является правильным префиксом другого, то возвращаемый индекс — это меньшее из оставшихся элементов в каждом буфере, и следует, что индекс допустим только для буфера с большим количеством оставшихся элементов. В противном случае несовпадений нет.

public String toString()

Возвращает строку, содержащую символы в этом буфере.

Первый символ полученной строки будет символом в позиции этого буфера, а последний символ будет символом с индексом limit() - 1. Вызов этого метода не изменяет позицию буфера.

public final int length()

Возвращает длину этого буфера символов.

При рассмотрении как последовательности символов, длина буфера символов просто является числом символов между позицией (включительно) и пределом (исключительно); то есть, она эквивалентна remaining().

public final boolean isEmpty()

Возвращает true, если этот буфер символов пустой.

public final char charAt(int index)

Читает символ по заданному индексу относительно текущей позиции.

public abstract CharBuffer subSequence(int start, int end)

Создаёт новый буфер символов, представляющий указанную подпоследовательность этого буфера, относительно текущей позиции.

Новый буфер будет совместно использовать содержимое этого буфера; то есть, если содержимое этого буфера изменяемо, то изменения в одном буфере приведут к изменениям в другом. Ёмкость нового буфера будет равна ёмкости этого буфера, его позиция будет position() + start, его предел будет position() + end, а порядок байтов будет идентичен порядку байтов этого буфера. Новый буфер будет прямым тогда и только тогда, когда этот буфер является прямым, и он будет только для чтения тогда и только тогда, когда этот буфер является только для чтения.

public CharBuffer append(CharSequence csq)

Добавляет указанную последовательность символов в этот буфер (необязательная операция).

Вызов этого метода в формате dst.append(csq) ведет себя точно так же, как вызов

     dst.put(csq.toString()) 

В зависимости от спецификации toString для последовательности символов csq, вся последовательность может не быть добавлена. Например, вызов метода toString буфера символов вернёт подпоследовательность, содержимое которой зависит от позиции и предела буфера.

public CharBuffer append(CharSequence csq, int start, int end)

Добавляет подпоследовательность указанной последовательности символов в этот буфер (необязательная операция).

Вызов этого метода в формате dst.append(csq, start, end) при csq не являющимся null, ведет себя точно так же, как вызов

     dst.put(csq.subSequence(start, end).toString()) 

public CharBuffer append(char c)

Добавляет указанный символ в этот буфер (необязательная операция).

Вызов этого метода в формате dst.append(c) ведет себя точно так же, как вызов

     dst.put(c) 

public abstract ByteOrder order()

Возвращает порядок байтов этого буфера.

Порядок байтов буфера символов, созданного путём выделения памяти или оборачивания существующего char массива, — это native order базового оборудования. Порядок байтов буфера символов, созданного как вид буфера байтов, — это порядок байтов буфера байтов в момент создания вида.