Class CharsetDecoderICU


  • public abstract class CharsetDecoderICU
    extends CharsetDecoder
    An abstract class that provides framework methods of decoding operations for concrete subclasses. In the future this class will contain API that will implement converter sematics of ICU4C.
    • Field Detail

      • EXT_MAX_BYTES

        @Deprecated
        protected static final int EXT_MAX_BYTES
        Deprecated.
        This API is ICU internal only.
        Maximum number of indexed bytes
        See Also:
        Constant Field Values
    • Method Detail

      • setToUCallback

        public final void setToUCallback​(CoderResult err,
                                         CharsetCallback.Decoder newCallback,
                                         Object newContext)
        Sets the callback encoder method and context to be used if an illegal sequence is encounterd. You would normally call this twice to set both the malform and unmappable error. In this case, newContext should remain the same since using a different newContext each time will negate the last one used.
        Parameters:
        err - CoderResult
        newCallback - CharsetCallback.Encoder
        newContext - Object
      • implFlush

        protected final CoderResult implFlush​(CharBuffer out)
        Flushes any characters saved in the converter's internal buffer and resets the converter.
        Overrides:
        implFlush in class CharsetDecoder
        Parameters:
        out - action to be taken
        Returns:
        result of flushing action and completes the decoding all input. Returns CoderResult.UNDERFLOW if the action succeeds.
      • implReset

        protected void implReset()
        Resets the to Unicode mode of converter
        Overrides:
        implReset in class CharsetDecoder
      • decodeLoop

        protected CoderResult decodeLoop​(ByteBuffer in,
                                         CharBuffer out)
        Decodes one or more bytes. The default behaviour of the converter is stop and report if an error in input stream is encountered. To set different behaviour use @see CharsetDecoder.onMalformedInput() This method allows a buffer by buffer conversion of a data stream. The state of the conversion is saved between calls to convert. Among other things, this means multibyte input sequences can be split between calls. If a call to convert results in an Error, the conversion may be continued by calling convert again with suitably modified parameters.All conversions should be finished with a call to the flush method.
        Specified by:
        decodeLoop in class CharsetDecoder
        Parameters:
        in - buffer to decode
        out - buffer to populate with decoded result
        Returns:
        Result of decoding action. Returns CoderResult.UNDERFLOW if the decoding action succeeds or more input is needed for completing the decoding action.
      • maxBytesPerChar

        public final float maxBytesPerChar()
        Returns the maxBytesPerChar value for the Charset that created this decoder.
        Returns:
        maxBytesPerChar