Класс Buffer

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

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

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

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

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

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

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

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

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

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

Установка отметки и сброс

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

Инварианты

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

0 <= mark <= position <= limit <= capacity

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

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

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

• 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);