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

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

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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/nio/charset/CoderResult.html