java.nio

Буфер класса

java.lang. Объект

java.nio. Буфер

Прямые Известные Подклассы:

ByteBuffer, CharBuffer, DoubleBuffer, FloatBuffer, IntBuffer, LongBuffer, ShortBuffer

public abstract class Buffer
extends Object

Контейнер для данных определенного типа примитива.

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

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

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

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

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

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

Каждый подкласс этого класса определяет две категории, получают и помещают операции:

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

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

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

Отмечание и сброс

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

Инварианты

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

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

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

Очистка, зеркально отражая, и перемотка

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

• clear() делает буфер готовым к новой последовательности считанных из канала или родственника помещенные операции: Это устанавливает предел к емкости и позиции, чтобы обнулить.

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

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

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

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

Потокобезопасность

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

Объединение в цепочку вызова

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

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

может быть заменен единственным, более компактным оператором

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

С тех пор:

1.4

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
abstract Object	array() Возвращает массив, который поддерживает этот буфер (дополнительная работа).
abstract int	arrayOffset() Возвращает смещение в пределах массива поддержки этого буфера первого элемента буфера (дополнительная работа).
int	capacity() Возвраты емкость этого буфера.
Буфер	clear() Очищает этот буфер.
Буфер	flip() Зеркальные отражения этот буфер.
abstract boolean	hasArray() Говорит, поддерживается ли этот буфер доступным массивом.
boolean	hasRemaining() Говорит, есть ли какие-либо элементы между текущей позицией и пределом.
abstract boolean	isDirect() Говорит, является ли этот буфер прямым.
abstract boolean	isReadOnly() Говорит, только для чтения ли этот буфер.
int	limit() Возвраты предел этого буфера.
Буфер	limit(int newLimit) Устанавливает предел этого буфера.
Буфер	mark() Наборы метка этого буфера в ее позиции.
int	position() Возвраты позиция этого буфера.
Буфер	position(int newPosition) Наборы позиция этого буфера.
int	remaining() Возвращает число элементов между текущей позицией и пределом.
Буфер	reset() Сбросы позиция этого буфера к ранее отмеченной позиции.
Буфер	rewind() Перемотки этот буфер.

Методы java.lang унаследованный от класса. Объект

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Деталь метода

емкость

public final int capacity()

Возвраты емкость этого буфера.

Возвраты:

Емкость этого буфера

позиция

public final int position()

Возвраты позиция этого буфера.

Возвраты:

Позиция этого буфера

позиция

public final Buffer position(int newPosition)

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

Параметры:

newPosition - Новое значение позиции; должно быть неотрицательным и не больше чем текущий предел

Возвраты:

Этот буфер

Броски:

IllegalArgumentException - Если предварительные условия на newPosition не содержат

предел

public final int limit()

Возвраты предел этого буфера.

Возвраты:

Предел этого буфера

предел

public final Buffer limit(int newLimit)

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

Параметры:

newLimit - Новое предельное значение; должно быть неотрицательным и не больше чем емкость этого буфера

Возвраты:

Этот буфер

Броски:

IllegalArgumentException - Если предварительные условия на newLimit не содержат

метка

public final Buffer mark()

Наборы метка этого буфера в ее позиции.

Возвраты:

Этот буфер

сброс

public final Buffer reset()

Сбросы позиция этого буфера к ранее отмеченной позиции.

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

Возвраты:

Этот буфер

Броски:

InvalidMarkException - Если метка не была установлена

очистить

public final Buffer clear()

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

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

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

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

Возвраты:

Этот буфер

зеркальное отражение

public final Buffer flip()

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

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

 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 Buffer rewind()

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

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

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

Возвраты:

Этот буфер

оставление

public final int remaining()

Возвращает число элементов между текущей позицией и пределом.

Возвраты:

Число элементов, остающееся в этом буфере

hasRemaining

public final boolean hasRemaining()

Говорит, есть ли какие-либо элементы между текущей позицией и пределом.

Возвраты:

true, если, и только если, есть по крайней мере один элемент, остающийся в этом буфере

isReadOnly

public abstract boolean isReadOnly()

Говорит, только для чтения ли этот буфер.

Возвраты:

true, если, и только если, этот буфер только для чтения

hasArray

public abstract boolean hasArray()

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

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

Возвраты:

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

С тех пор:

1.6

массив

public abstract Object array()

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

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

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

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

Возвраты:

Массив это поддерживает этот буфер

Броски:

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

UnsupportedOperationException - Если этот буфер не поддерживается доступным массивом

С тех пор:

1.6

arrayOffset

public abstract int arrayOffset()

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

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

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

Возвраты:

Смещение в пределах массива этого буфера первого элемента буфера

Броски:

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

UnsupportedOperationException - Если этот буфер не поддерживается доступным массивом

С тех пор:

1.6

isDirect

public abstract boolean isDirect()

Говорит, является ли этот буфер прямым.

Возвраты:

true, если, и только если, этот буфер является прямым

С тех пор:

1.6