Класс ByteArrayOutputStream

java.lang.Object

java.io.OutputStream

java.io.ByteArrayOutputStream

Все реализуемые интерфейсы:: Closeable, Flushable, AutoCloseable

public class ByteArrayOutputStream extends OutputStream

Этот класс реализует поток вывода, в котором данные записываются в массив байтов. Буфер автоматически увеличивается по мере записи данных в него. Данные можно получить, используя toByteArray() и toString().

Закрытие ByteArrayOutputStream не оказывает никакого влияния. Методы этого класса могут быть вызваны после закрытия потока без генерации IOException.

С тех пор:: 1.0

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected byte[]`	`buf`	Буфер, в котором хранятся данные.
`protected int`	`count`	Количество допустимых байтов в буфере.

Краткое описание конструкторов

Конструктор	Описание
`ByteArrayOutputStream()`	Создаёт новый `ByteArrayOutputStream`.
`ByteArrayOutputStream(int size)`	Создаёт новый `ByteArrayOutputStream`, с ёмкостью буфера указанного размера в байтах.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`close()`	Закрытие `ByteArrayOutputStream` не оказывает никакого влияния.
`void`	`reset()`	Сбрасывает поле `count` этого `ByteArrayOutputStream` в ноль, так что все текущие накопленные данные в потоке вывода будут удалены.
`int`	`size()`	Возвращает текущий размер буфера.
`byte[]`	`toByteArray()`	Создаёт новый массив байтов.
`String`	`toString()`	Преобразует содержимое буфера в строку, декодируя байты с использованием кодировки символов по умолчанию платформы.
`String`	`toString(int hibyte)`	Устарело. Этот метод не правильно преобразует байты в символы.
`String`	`toString(String charsetName)`	Преобразует содержимое буфера в строку, декодируя байты с использованием указанной кодировки символов `charset`.
`String`	`toString(Charset charset)`	Преобразует содержимое буфера в строку, декодируя байты с использованием указанной кодировки символов `charset`.
`void`	`write(byte[] b, int off, int len)`	Записывает `len` байтов из указанного массива байтов, начиная с смещения `off`, в этот `ByteArrayOutputStream`.
`void`	`write(int b)`	Записывает указанный байт в этот `ByteArrayOutputStream`.
`void`	`writeBytes(byte[] b)`	Записывает всё содержимое указанного массива байтов в этот `ByteArrayOutputStream`.
`void`	`writeTo(OutputStream out)`	Записывает всё содержимое этого `ByteArrayOutputStream` в указанный поток вывода, как если бы вызывали метод write потока вывода, используя `out.write(buf, 0, count)`.

Методы, унаследованные от класса java.io.OutputStream

flush, nullOutputStream, write

Методы, унаследованные от класса java.lang.Object

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

Подробное описание полей

buf

protected byte[] buf

Буфер, в котором хранятся данные.

count

protected int count

Количество допустимых байтов в буфере.

Подробное описание конструкторов

ByteArrayOutputStream

public ByteArrayOutputStream()

Создаёт новый ByteArrayOutputStream. Емкость буфера изначально составляет 32 байта, но увеличивается при необходимости.

ByteArrayOutputStream

public ByteArrayOutputStream(int size)

Создаёт новый ByteArrayOutputStream, с емкостью буфера, указанной размером в байтах.

Параметры:: size - начальный размер.
Исключения:: IllegalArgumentException - если размер отрицательный.

Подробное описание методов

write

public void write(int b)

Записывает указанный байт в этот ByteArrayOutputStream.

Определено в:: write в классе OutputStream
Параметры:: b - байт для записи.

write

public void write(byte[] b, int off, int len)

Записывает len байтов из указанного массива байтов, начиная с смещения off в этот ByteArrayOutputStream.

Переопределяет:: write в классе OutputStream
Параметры:: b - данные.; off - начальное смещение в данных.; len - количество байтов для записи.
Исключения:: NullPointerException - если b равно null.; IndexOutOfBoundsException - если off отрицательно, len отрицательно или len больше чем b.length - off

writeBytes

public void writeBytes(byte[] b)

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

Примечание API:: Этот метод эквивалентен write(b, 0, b.length).
Параметры:: b - данные.
Исключения:: NullPointerException - если b равно null.
С:: 11

writeTo

public void writeTo(OutputStream out) throws IOException

Записывает полное содержимое этого ByteArrayOutputStream в указанный аргумент потока вывода, как если бы вызывался метод write потока вывода, используя out.write(buf, 0, count).

Параметры:: out - поток вывода, в который нужно записать данные.
Исключения:: NullPointerException - если out равно null.; IOException - если произошла ошибка ввода-вывода.

reset

public void reset()

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

См. также:

ByteArrayInputStream.count

toByteArray

public byte[] toByteArray()

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

Возвращает:

текущее содержимое этого потока вывода в виде массива байтов.

См. также:

size()

size

public int size()

Возвращает текущий размер буфера.

Возвращает:

значение поля count , которое является количеством допустимых байтов в этом потоке вывода.

См. также:

count

toString

public String toString()

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

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

Переопределяет:: toString в классе Object
Возвращает:: Строка, декодированная из содержимого буфера.
С:: 1.1

toString

public String toString(String charsetName) throws UnsupportedEncodingException

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

Этот метод эквивалентен #toString(charset) , принимающему charset.

Вызов этого метода в формате

 
      ByteArrayOutputStream b = ...
      b.toString("UTF-8")

ведёт себя точно так же, как выражение

 
      ByteArrayOutputStream b = ...
      b.toString(StandardCharsets.UTF_8)

Параметры:: charsetName - имя поддерживаемой charset
Возвращает:: Строка, декодированная из содержимого буфера.
Исключения:: UnsupportedEncodingException - Если указанная кодировка символов не поддерживается
С:: 1.1

toString

public String toString(Charset charset)

Преобразует содержимое буфера в строку, декодируя байты с использованием указанной charset. Длина новой String является функцией кодировки символов и, следовательно, может не быть равна длине массива байтов.

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

Параметры:: charset - кодировка символов для декодирования bytes
Возвращает:: Строка, декодированная из содержимого буфера.
С:: 10

toString

@Deprecated public String toString(int hibyte)

Устарело.

Этот метод не правильно преобразует байты в символы. С JDK 1.1, предпочтительным способом сделать это является использование метода toString(String charsetName) или toString(Charset charset) , принимающего имя кодировки или кодировку символов, или метод toString() , который использует кодировку символов по умолчанию платформы.

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


     c == (char)(((hibyte & 0xff) << 8) | (b & 0xff))

Параметры:

hibyte - старший байт каждого символа Unicode.

Возвращает:

текущее содержимое потока вывода в виде строки.

См. также:

size()
toString(String)
toString()

close

public void close() throws IOException

Закрытие ByteArrayOutputStream не имеет эффекта. Методы в этом классе могут быть вызваны после закрытия потока без создания ошибки IOException.

Определено в:: close в интерфейсе AutoCloseable
Определено в:: close в интерфейсе Closeable
Переопределяет:: close в классе OutputStream
Исключения:: IOException - если произошла ошибка ввода-вывода.

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/ByteArrayOutputStream.html