Класс CoderResult

java.lang.Object

java.nio.charset.CoderResult

public final class CoderResult extends Object

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

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

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

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

Начиная с:: 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)`	Статический фабричный метод, возвращающий уникальный объект результата, описывающий ошибку неотображаемого символа заданной длины.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

UNDERFLOW

public static final CoderResult UNDERFLOW

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

OVERFLOW

public static final CoderResult OVERFLOW

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

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

toString

public String toString()

Возвращает строку с описанием результата кодировщика.

Переопределяет:: 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.