Spec-Zone.ru › OpenJDK 25

Класс 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.

Начиная с:
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)
Кодирует указанный массив байтов в String, используя схему кодирования Base64.
Base64.Encoder withoutPadding()
Возвращает экземпляр кодировщика, который выполняет кодирование так же, как этот кодировщик, но не добавляет символ заполнения в конец закодированных байтовых данных.
OutputStream wrap(OutputStream os)
Оборачивает выходной поток для кодирования байтовых данных с использованием схемы кодирования Base64.

Методы, объявленные в классе 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)
Кодирует указанный массив байтов в String, используя схему кодирования Base64.

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

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

Параметры:
src — массив байтов для кодирования
Возвращает:
String, содержащую полученные символы, закодированные в 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()
Возвращает экземпляр кодировщика, который выполняет кодирование так же, как этот кодировщик, но не добавляет символ заполнения в конец закодированных байтовых данных.

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

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

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.base/java/util/Base64.Encoder.html

Spec-Zone.ru

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