Класс 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 для тех, которые описывают недостаток данных или переполнение.

С момента:: 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()

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

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

© 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/nio/charset/CoderResult.html