Класс ByteBuffer

Позиция нового буфера будет равна нулю, его предел — его емкости, метка будет неопределённой, каждый его элемент будет инициализирован нулём, а порядок байтов будет BIG_ENDIAN. Наличие backing array не определено.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Этот метод копирует 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));

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Вызов этого метода не изменяет и не отбрасывает значение метки.

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

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

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

После последовательности операций чтения канала или операций 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 при передаче данных из одного места в другое.

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

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

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

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

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

    buf.clear();          // Prepare buffer for use
    while (in.read(buf) >= 0 || buf.position != 0) {
        buf.flip();
        out.write(buf);
        buf.compact();    // In case of partial write
    }

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

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

Два байтовых буфера равны, если и только если

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

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

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

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

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

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

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

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

Возвращаемое значение неотрицательно и находится в диапазоне от 0 (включительно) до unitSize (исключительно), причём ноль указывает, что адрес байта с данным индексом выровнен по размеру единицы, а положительное значение — что адрес не выровнен по размеру единицы. Если адрес байта с данным индексом не выровнен по размеру единицы, возвращаемое значение показывает, на сколько следует скорректировать индекс для поиска байта с выровненным адресом. Конкретнее, индекс следует либо уменьшить на возвращаемое значение, если оно не больше index, либо увеличить на размер единицы минус возвращаемое значение. Таким образом, задано

    int value = alignmentOffset(index, unitSize)

    alignmentOffset(index - value, unitSize) == 0, value <= index

    alignmentOffset(index + (unitSize - value), unitSize) == 0

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

    nb.alignmentOffset(0, unitSize) == 0
    nb.alignmentOffset(nb.limit(), unitSize) == 0

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

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

Читает следующие два байта в текущей позиции буфера, формирует из них значение типа char в соответствии с текущим порядком байтов и увеличивает позицию на два.

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

Читает два байта по заданному индексу, формирует из них значение типа char в соответствии с текущим порядком байтов.

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

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

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

Читает следующие два байта в текущей позиции буфера, формирует из них значение типа short в соответствии с текущим порядком байтов и увеличивает позицию на два.

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

Читает два байта по заданному индексу, формирует из них значение типа short в соответствии с текущим порядком байтов.

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

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

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

Читает следующие четыре байта в текущей позиции буфера, формирует из них значение типа int в соответствии с текущим порядком байтов и увеличивает позицию на четыре.

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

Читает четыре байта по заданному индексу, формирует из них значение типа int в соответствии с текущим порядком байтов.

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

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

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

Читает следующие восемь байтов в текущей позиции этого буфера, объединяет их в значение типа long в соответствии с текущим порядком байтов, а затем увеличивает позицию на восемь.

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

Читает восемь байтов по заданному индексу, объединяет их в значение типа long в соответствии с текущим порядком байтов.

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

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

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

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

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

Читает четыре байта по заданному индексу, объединяет их в значение типа float в соответствии с текущим порядком байтов.

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

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

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

Читает следующие восемь байтов в текущей позиции этого буфера, объединяет их в значение типа double в соответствии с текущим порядком байтов, а затем увеличивает позицию на восемь.

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

Читает восемь байтов по заданному индексу, объединяет их в значение типа double в соответствии с текущим порядком байтов.

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

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

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