Класс CharsetDecoder

Этот метод вызывает метод implReplaceWith, передавая ему новую строку замены после проверки её допустимости.

Реализация этого метода по умолчанию ничего не делает. Этот метод следует переопределить в декодерах, которым требуется получать уведомления об изменениях строки замены.

Этот метод вызывает метод implOnMalformedInput, передавая ему новое действие.

Реализация этого метода по умолчанию ничего не делает. Этот метод следует переопределить в декодерах, которым требуется получать уведомления об изменениях действия при некорректном вводе.

Этот метод вызывает метод implOnUnmappableCharacter, передавая ему новое действие.

Реализация этого метода по умолчанию ничего не делает. Этот метод следует переопределить в декодерах, которым требуется получать уведомления об изменениях действия при ошибке отображения символа.

Чтение из буферов и запись в них начинаются с их текущих позиций. Будет прочитано не более in.remaining() байтов и записано не более out.remaining() символов. Позиции буферов будут сдвинуты с учётом прочитанных байтов и записанных символов, но их отметки и пределы не изменятся.

Помимо чтения байтов из входного буфера и записи символов в выходной буфер, этот метод возвращает объект CoderResult, описывающий причину завершения:

• CoderResult.UNDERFLOW означает, что декодирована максимально возможная часть входного буфера. Если дальнейших входных данных нет, вызывающий код может перейти к следующему шагу операции декодирования. В противном случае этот метод следует вызвать снова, передав дополнительные входные данные.

• CoderResult.OVERFLOW означает, что в выходном буфере недостаточно места для декодирования дополнительных байтов. Этот метод следует вызвать снова с выходным буфером, в котором больше свободного места для символов. Обычно для этого из выходного буфера извлекают декодированные символы.

• Результат ошибки некорректного ввода означает, что обнаружена ошибка некорректного ввода. Некорректные байты начинаются с текущей (возможно, увеличенной) позиции входного буфера; их количество можно определить, вызвав метод length объекта результата. Этот случай применим только в том случае, если для действия при некорректном вводе этого декодера задано значение CodingErrorAction.REPORT; в противном случае некорректный ввод будет проигнорирован или заменён согласно заданному действию.

• Результат ошибки отображения символа означает, что обнаружена ошибка отображения символа. Байты, декодирующие неотображаемый символ, начинаются с текущей (возможно, увеличенной) позиции входного буфера; их количество можно определить, вызвав метод length объекта результата. Этот случай применим только в том случае, если для действия при ошибке отображения этого декодера задано значение CodingErrorAction.REPORT; в противном случае неотображаемый символ будет проигнорирован или заменён согласно заданному действию.

Параметр endOfInput указывает, может ли вызывающий код предоставить дополнительные входные данные помимо содержащихся в заданном входном буфере. Если дополнительные входные данные могут быть предоставлены, вызывающий код должен передать для этого параметра false; если дополнительные входные данные предоставить невозможно, следует передать true. Передать false при одном вызове, а позднее выяснить, что дополнительных входных данных нет, не является ошибкой; на практике это случается довольно часто. Однако крайне важно, чтобы при последнем вызове этого метода в последовательности вызовов всегда передавалось true, чтобы любые оставшиеся недекодированные входные данные считались некорректными.

Этот метод работает, вызывая метод decodeLoop, интерпретируя его результаты, обрабатывая ошибки и при необходимости вызывая его повторно.

Некоторые декодеры поддерживают внутреннее состояние и после чтения всей входной последовательности могут записать в выходной буфер дополнительные символы.

Все дополнительные данные записываются в выходной буфер начиная с его текущей позиции. Будет записано не более out.remaining() символов. Позиция буфера будет соответствующим образом сдвинута, но его отметка и предел не изменятся.

Если этот метод завершается успешно, он возвращает CoderResult.UNDERFLOW. Если в выходном буфере недостаточно места, он возвращает CoderResult.OVERFLOW. В этом случае для завершения текущей операции декодирования необходимо вызвать этот метод снова с выходным буфером, в котором больше места.

Если этот декодер уже сброшен, вызов этого метода не оказывает никакого эффекта.

Для выполнения операции сброса этот метод вызывает метод implFlush.

Реализация этого метода по умолчанию ничего не делает и всегда возвращает CoderResult.UNDERFLOW. Этот метод следует переопределить в декодерах, которым может потребоваться записать завершающие символы в выходной буфер после чтения всей входной последовательности.

Этот метод сбрасывает состояние, не зависящее от набора символов, а также вызывает метод implReset для выполнения действий сброса, специфичных для набора символов.

Реализация этого метода по умолчанию ничего не делает. Этот метод следует переопределить в декодерах, поддерживающих внутреннее состояние.

Этот метод реализует основной цикл декодирования, обрабатывая максимально возможное количество байтов до тех пор, пока не закончатся входные данные, место в выходном буфере или не возникнет ошибка декодирования. Этот метод вызывается методом decode, который интерпретирует результат и выполняет восстановление после ошибок.

Чтение из буферов и запись в них начинаются с их текущих позиций. Будет прочитано не более in.remaining() байтов и записано не более out.remaining() символов. Позиции буферов будут сдвинуты с учётом прочитанных байтов и записанных символов, но их отметки и пределы не изменятся.

Этот метод возвращает объект CoderResult, описывающий причину завершения, так же как и метод decode. Большинство реализаций этого метода обрабатывают ошибки декодирования, возвращая соответствующий объект результата для интерпретации методом decode. Оптимизированная реализация может вместо этого проверять соответствующее действие при ошибке и самостоятельно выполнять его.

Реализация этого метода может выполнять произвольный предварительный просмотр входных данных, возвращая CoderResult.UNDERFLOW до получения достаточного количества входных данных.

Этот метод выполняет полную операцию декодирования: он сбрасывает этот декодер, затем декодирует байты из заданного байтового буфера и, наконец, сбрасывает буфер декодера. Поэтому этот метод не следует вызывать, если операция декодирования уже выполняется.

Реализация этого метода по умолчанию всегда возвращает false; декодеры с автоматическим определением набора символов должны переопределить его так, чтобы он возвращал true.

Если этот декодер реализует автоматическое определение набора символов, то в определённый момент во время операции декодирования этот метод может начать возвращать true, указывая на то, что во входной последовательности байтов обнаружен конкретный набор символов. После этого можно вызвать метод detectedCharset, чтобы получить обнаруженный набор символов.

Возвращаемое этим методом значение false не означает, что декодирование байтов ещё не началось. Некоторые декодеры с автоматическим определением способны декодировать часть или даже всю входную последовательность байтов, не определив конкретный набор символов.

Реализация этого метода по умолчанию всегда вызывает исключение UnsupportedOperationException; декодеры с автоматическим определением должны переопределить его так, чтобы он возвращал true после определения входного набора символов.

Если этот декодер реализует автоматическое определение набора символов, то после обнаружения фактического набора символов этот метод возвращает его. После этого метод возвращает одно и то же значение до конца текущей операции декодирования. Если для определения фактического набора символов прочитано недостаточно входных байтов, этот метод вызывает исключение IllegalStateException.

Реализация этого метода по умолчанию всегда вызывает исключение UnsupportedOperationException; декодеры с автоматическим определением должны переопределить его, чтобы возвращать соответствующее значение.