Класс CoderResult

public class CoderResult
extends Object

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

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

• Недостаток данных (Underflow) сообщается, когда больше нет входных данных для обработки, или недостаточно входных данных и требуется дополнительный ввод. Это условие представлено уникальным объектом результата UNDERFLOW, чей метод isUnderflow возвращает true.

• Переполнение (Overflow) сообщается, когда в выходном буфере недостаточно места. Это условие представлено уникальным объектом результата OVERFLOW, чей метод isOverflow возвращает true.

• Ошибка неправильного входного формата (malformed-input error) сообщается, когда последовательность входных единиц не является правильно сформированной. Такие ошибки описываются экземплярами этого класса, чей метод isMalformed возвращает true и чей метод length возвращает длину некорректной последовательности. Существует единственный экземпляр этого класса для всех ошибок некорректного входного формата данной длины.

• Ошибка непреобразуемого символа (unmappable-character error) сообщается, когда последовательность входных единиц обозначает символ, который не может быть представлен в выходном наборе символов. Такие ошибки описываются экземплярами этого класса, чей метод isUnmappable возвращает true и чей метод length возвращает длину входной последовательности, обозначающей непреобразуемый символ. Существует единственный экземпляр этого класса для всех ошибок непреобразуемого символа данной длины.

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

Поля

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