Класс Buffer

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

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

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

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

Для каждого примитивного типа, отличного от boolean, существует один подкласс этого класса.

Передача данных

Каждый подкласс этого класса определяет два типа операций get и put:

Относительные операции считывают или записывают один или несколько элементов, начиная с текущей позиции, а затем увеличивают позицию на количество переданных элементов. Если запрошенная передача превышает предел, то относительная операция get вызывает исключение BufferUnderflowException, а относительная операция put вызывает исключение BufferOverflowException; в любом случае данные не передаются.

Абсолютные операции принимают явный индекс элемента и не влияют на позицию. Абсолютные операции get и put вызывают исключение IndexOutOfBoundsException, если значение аргумента индекса превышает предел.

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

Разметка и сброс

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

Инварианты

Для значений разметки, позиции, предела и ёмкости выполняется следующий инвариант:

0 <= разметка <= позиция <= предел <= ёмкость

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

Дополнительные операции

В дополнение к методам доступа к значениям позиции, предела и ёмкости, а также для разметки и сброса, этот класс также определяет следующие операции над буферами:

• clear() готовит буфер к новой последовательности операций чтения канала или относительной операции put: он устанавливает предел на ёмкость и позицию на ноль.

• flip() готовит буфер к новой последовательности операций записи канала или относительной операции get: он устанавливает предел на текущую позицию, а затем устанавливает позицию на ноль.

• rewind() готовит буфер к повторному считыванию содержащихся в нём данных: он оставляет предел неизменным и устанавливает позицию на ноль.

• Методы slice() и slice(index,length) создают подпоследовательность буфера: они оставляют предел и позицию неизменными.

• duplicate() создаёт поверхностную копию буфера: он оставляет предел и позицию неизменными.

Буферы только для чтения

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

Безопасность потоков

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

Цепочки вызовов

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

 b.flip();
 b.position(23);
 b.limit(42);

 b.flip().position(23).limit(42);