Spec-Zone.ru › OpenJDK 17

Класс Base64.Encoder

java.lang.Object
java.util.Base64.Encoder
Вложенный класс:
Base64
public static class Base64.Encoder extends Object
Этот класс реализует кодировщик для кодирования данных байтов с использованием схемы кодирования Base64, как указано в RFC 4648 и RFC 2045.

Экземпляры класса Base64.Encoder безопасны для использования в нескольких потоках.

Если не указано иное, передача null аргумента методу этого класса приведет к сбросу исключения NullPointerException.

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

C момента:
1.8
См. также:
  • Base64.Decoder

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

Модификатор и тип Метод Описание
byte[] encode(byte[] src)
Кодирует все байты из указанного массива байтов в новый выделенный массив байтов, используя схему кодирования Base64.
int encode(byte[] src, byte[] dst)
Кодирует все байты из указанного массива байтов, используя схему кодирования Base64, записывая полученные байты в заданный массив байтов, начиная с смещения 0.
ByteBuffer encode(ByteBuffer buffer)
Кодирует все оставшиеся байты из указанного буфера байтов в новый выделенный буфер ByteBuffer, используя схему кодирования Base64.
String encodeToString(byte[] src)
Кодирует указанный массив байтов в строку, используя схему кодирования Base64.
Base64.Encoder withoutPadding()
Возвращает экземпляр кодировщика, который кодирует эквивалентно этому, но без добавления символа заполнения в конце закодированных байтовых данных.
OutputStream wrap(OutputStream os)
Оборачивает потоки вывода для кодирования данных байтов, используя схему кодирования Base64.

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

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

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

encode

public byte[] encode(byte[] src)
Кодирует все байты из указанного массива байтов в новый выделенный массив байтов, используя схему кодирования Base64. Возвращаемый массив байтов имеет длину, равную длине результирующих байтов.
Параметры:
src - массив байтов для кодирования
Возвращает:
Новый выделенный массив байтов, содержащий результирующие закодированные байты.

encode

public int encode(byte[] src, byte[] dst)
Кодирует все байты из указанного массива байтов, используя схему кодирования Base64, записывая полученные байты в заданный массив байтов, начиная с смещения 0.

Ответственность вызывающего метода - убедиться, что массив выходных байтов dst имеет достаточно места для кодирования всех байтов из входного массива байтов. Если массив выходных байтов недостаточно велик, байты в него не будут записаны.

Параметры:
src - массив байтов для кодирования
dst - массив выходных байтов
Возвращает:
Количество байтов, записанных в массив выходных байтов
Исключения:
IllegalArgumentException - если dst не имеет достаточно места для кодирования всех входных байтов.

encodeToString

public String encodeToString(byte[] src)
Кодирует указанный массив байтов в строку, используя схему кодирования Base64.

Этот метод сначала кодирует все входные байты в массив байтов, закодированных в base64, а затем строит новую строку, используя закодированный массив байтов и кодировку ISO-8859-1.

Другими словами, вызов этого метода имеет точно такой же эффект, как вызов new String(encode(src), StandardCharsets.ISO_8859_1).

Параметры:
src - массив байтов для кодирования
Возвращает:
Строка, содержащая результирующие символы, закодированные в Base64

encode

public ByteBuffer encode(ByteBuffer buffer)
Кодирует все оставшиеся байты из указанного буфера байтов в новый выделенный буфер ByteBuffer, используя схему кодирования Base64. По возвращении позиция исходного буфера будет обновлена до его предела; его предел не будет изменен. Позиция возвращаемого буфера вывода будет равна нулю, а его предел будет равен количеству полученных закодированных байтов.
Параметры:
buffer - исходный ByteBuffer для кодирования
Возвращает:
Новый выделенный буфер байтов, содержащий закодированные байты.

wrap

public OutputStream wrap(OutputStream os)
Оборачивает поток вывода для кодирования данных байтов, используя схему кодирования Base64.

Рекомендуется немедленно закрыть возвращаемый поток вывода после использования, во время которого он будет сбрасывать все возможные оставшиеся байты в базовый поток вывода. Закрытие возвращаемого потока вывода закроет базовый поток вывода.

Параметры:
os - поток вывода.
Возвращает:
поток вывода для кодирования данных байтов в указанном формате Base64

withoutPadding

public Base64.Encoder withoutPadding()
Возвращает экземпляр кодировщика, который кодирует эквивалентно этому, но без добавления символа заполнения в конце закодированных байтовых данных.

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

Возвращает:
эквивалентный кодировщик, который кодирует без добавления символа заполнения в конце

© 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/util/Base64.Encoder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API