Класс CoderResult

java.lang.Object

java.nio.charset.CoderResult

public class CoderResult extends Object

Описание состояния результата кодирования.

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

Недостаток данных сообщается, когда больше нет входных данных для обработки или недостаточно входных данных и требуется дополнительный ввод. Это состояние представлено уникальным объектом результата UNDERFLOW, метод isUnderflow которого возвращает true.
Переполнение сообщается, когда в выходном буфере недостаточно места. Это состояние представлено уникальным объектом результата OVERFLOW, метод isOverflow которого возвращает true.
Ошибка неверного входного формата сообщается, когда последовательность входных единиц не является правильно сформированной. Такие ошибки описываются экземплярами этого класса, метод isMalformed которых возвращает true, а метод length — длину неверно сформированной последовательности. Существует один уникальный экземпляр этого класса для всех ошибок неверного входного формата заданной длины.
Ошибка неотображаемого символа сообщается, когда последовательность входных единиц обозначает символ, который не может быть представлен в выходном наборе символов. Такие ошибки описываются экземплярами этого класса, метод isUnmappable которых возвращает true, а метод length — длину входной последовательности, обозначающей неотображаемый символ. Существует один уникальный экземпляр этого класса для всех ошибок неотображаемого символа заданной длины.

Для удобства метод isError возвращает true для объектов результата, описывающих ошибки неверного входного формата и неотображаемого символа, но false для тех, которые описывают недостаток данных или переполнение.

Since:: 1.4

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

Модификатор и тип	Поле	Описание
`static final CoderResult`	`OVERFLOW`	Объект результата, указывающий на переполнение, означающее, что в выходном буфере недостаточно места.
`static final CoderResult`	`UNDERFLOW`	Объект результата, указывающий на недостаток данных, означающее, что либо входной буфер полностью потреблен, либо, если входной буфер еще не пуст, требуется дополнительный ввод.

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

Модификатор и тип	Метод	Описание
`boolean`	`isError()`	Указывает, описывает ли этот объект состояние ошибки.
`boolean`	`isMalformed()`	Указывает, описывает ли этот объект ошибку неверного входного формата.
`boolean`	`isOverflow()`	Указывает, описывает ли этот объект состояние переполнения.
`boolean`	`isUnderflow()`	Указывает, описывает ли этот объект состояние недостатка данных.
`boolean`	`isUnmappable()`	Указывает, описывает ли этот объект ошибку неотображаемого символа.
`int`	`length()`	Возвращает длину ошибочных входных данных, описываемых этим объектом (необязательная операция).
`static CoderResult`	`malformedForLength(int length)`	Статический фабричный метод, возвращающий уникальный объект, описывающий ошибку неверного входного формата заданной длины.
`void`	`throwException()`	Выбрасывает исключение, соответствующее результату, описываемому этим объектом.
`String`	`toString()`	Возвращает строку, описывающую этот результат кодирования.
`static CoderResult`	`unmappableForLength(int length)`	Статический фабричный метод, возвращающий уникальный объект результата, описывающий ошибку неотображаемого символа заданной длины.

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

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

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

UNDERFLOW

public static final CoderResult UNDERFLOW

Объект результата, указывающий на недостаток данных, означающее, что либо входной буфер полностью потреблен, либо, если входной буфер еще не пуст, требуется дополнительный ввод.

OVERFLOW

public static final CoderResult OVERFLOW

Объект результата, указывающий на переполнение, означающее, что в выходном буфере недостаточно места.

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

toString

public String toString()

Возвращает строку, описывающую этот результат кодирования.

Overrides:: toString в классе Object
Возвращает:: Строка описания

isUnderflow

public boolean isUnderflow()

Указывает, описывает ли этот объект состояние недостатка данных.

Возвращает:: true, если и только если этот объект обозначает недостаток данных

isOverflow

public boolean isOverflow()

Указывает, описывает ли этот объект состояние переполнения.

Возвращает:: true, если и только если этот объект обозначает переполнение

isError

public boolean isError()

Указывает, описывает ли этот объект состояние ошибки.

Возвращает:: true, если и только если этот объект обозначает ошибку неверного входного формата или ошибку неотображаемого символа

isMalformed

public boolean isMalformed()

Указывает, описывает ли этот объект ошибку неверного входного формата.

Возвращает:: true, если и только если этот объект обозначает ошибку неверного входного формата

isUnmappable

public boolean isUnmappable()

Указывает, описывает ли этот объект ошибку неотображаемого символа.

Возвращает:: true, если и только если этот объект обозначает ошибку неотображаемого символа

length

public int length()

Возвращает длину ошибочных входных данных, описываемых этим объектом (необязательная операция).

Возвращает:: Длину ошибочных входных данных, положительное целое число
Исключения:: UnsupportedOperationException - Если этот объект не описывает состояние ошибки, то есть, если метод isError не возвращает true

malformedForLength

public static CoderResult malformedForLength(int length)

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

Параметры:: length - Заданная длина
Возвращает:: Запрашиваемый объект результата кодирования

unmappableForLength

public static CoderResult unmappableForLength(int length)

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

Параметры:: length - Заданная длина
Возвращает:: Запрашиваемый объект результата кодирования

throwException

public void throwException() throws CharacterCodingException

Выбрасывает исключение, соответствующее результату, описываемому этим объектом.

Исключения:: BufferUnderflowException - Если этот объект является UNDERFLOW; BufferOverflowException - Если этот объект является OVERFLOW; MalformedInputException - Если этот объект представляет ошибку неверного входного формата; значение длины исключения будет равно длине этого объекта; UnmappableCharacterException - Если этот объект представляет ошибку неотображаемого символа; значение длины исключения будет равно длине этого объекта; CharacterCodingException - MalformedInputException, если этот объект представляет ошибку неверного входного формата; UnmappableCharacterException, если этот объект представляет ошибку неотображаемого символа

© 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://download.java.net/java/early_access/jdk24/docs/api/java.base/java/nio/charset/CoderResult.html