Spec-Zone.ru › OpenJDK 27

Класс 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
Модификатор и тип Метод Описание
protected Object clone()
Создаёт и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли другой объект этому объекту.
protected void finalize()
Устарело, подлежит удалению: этот элемент API будет удалён в одной из будущих версий.
Финализация устарела и будет удалена в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
String toString()
Возвращает строковое представление объекта.
final void wait()
Переводит текущий поток в состояние ожидания до пробуждения, обычно вследствие вызова notify или interrupt.
final void wait(long timeoutMillis)
Переводит текущий поток в состояние ожидания до пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Переводит текущий поток в состояние ожидания до пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

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, 2026, 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.

Spec-Zone.ru

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