Class CharsetEncoderICU


  • public abstract class CharsetEncoderICU
    extends java.nio.charset.CharsetEncoder
    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 semantics of ICU4C.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.nio.charset.CoderResult encodeLoop​(java.nio.CharBuffer in, java.nio.ByteBuffer out)
      Encodes one or more chars.
      static int getMaxBytesForString​(int length, int maxCharSize)
      Calculates the size of a buffer for conversion from Unicode to a charset.
      protected java.nio.charset.CoderResult implFlush​(java.nio.ByteBuffer out)
      Flushes any characters saved in the converter's internal buffer and resets the converter.
      protected void implOnMalformedInput​(java.nio.charset.CodingErrorAction newAction)
      Sets the action to be taken if an illegal sequence is encountered
      protected void implOnUnmappableCharacter​(java.nio.charset.CodingErrorAction newAction)
      Sets the action to be taken if an illegal sequence is encountered
      protected void implReset()
      Resets the from Unicode mode of converter
      boolean isFallbackUsed()
      Is this Encoder allowed to use fallbacks?
      boolean isLegalReplacement​(byte[] repl)
      Overrides super class method
      float maxCharsPerByte()
      Returns the maxCharsPerByte value for the Charset that created this encoder.
      void setFallbackUsed​(boolean usesFallback)
      Sets whether this Encoder can use fallbacks?
      void setFromUCallback​(java.nio.charset.CoderResult err, CharsetCallback.Encoder newCallback, java.lang.Object newContext)
      Sets the callback encoder method and context to be used if an illegal sequence is encountered.
      void setFromUContext​(java.lang.Object newContext)
      Sets fromUContext used in callbacks.
      • Methods inherited from class java.nio.charset.CharsetEncoder

        averageBytesPerChar, canEncode, canEncode, charset, encode, encode, flush, implReplaceWith, malformedInputAction, maxBytesPerChar, onMalformedInput, onUnmappableCharacter, replacement, replaceWith, reset, unmappableCharacterAction
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • isFallbackUsed

        public boolean isFallbackUsed()
        Is this Encoder allowed to use fallbacks? A fallback mapping is a mapping that will convert a Unicode codepoint sequence to a byte sequence, but the encoded byte sequence will round trip convert to a different Unicode codepoint sequence.
        Returns:
        true if the converter uses fallback, false otherwise.
      • setFallbackUsed

        public void setFallbackUsed​(boolean usesFallback)
        Sets whether this Encoder can use fallbacks?
        Parameters:
        usesFallback - true if the user wants the converter to take advantage of the fallback mapping, false otherwise.
      • implOnMalformedInput

        protected void implOnMalformedInput​(java.nio.charset.CodingErrorAction newAction)
        Sets the action to be taken if an illegal sequence is encountered
        Overrides:
        implOnMalformedInput in class java.nio.charset.CharsetEncoder
        Parameters:
        newAction - action to be taken
        Throws:
        java.lang.IllegalArgumentException
      • implOnUnmappableCharacter

        protected void implOnUnmappableCharacter​(java.nio.charset.CodingErrorAction newAction)
        Sets the action to be taken if an illegal sequence is encountered
        Overrides:
        implOnUnmappableCharacter in class java.nio.charset.CharsetEncoder
        Parameters:
        newAction - action to be taken
        Throws:
        java.lang.IllegalArgumentException
      • setFromUCallback

        public final void setFromUCallback​(java.nio.charset.CoderResult err,
                                           CharsetCallback.Encoder newCallback,
                                           java.lang.Object newContext)
        Sets the callback encoder method and context to be used if an illegal sequence is encountered. 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
      • setFromUContext

        public final void setFromUContext​(java.lang.Object newContext)
        Sets fromUContext used in callbacks.
        Parameters:
        newContext - Object
        Throws:
        java.lang.IllegalArgumentException - The object is an illegal argument for UContext.
      • implFlush

        protected java.nio.charset.CoderResult implFlush​(java.nio.ByteBuffer out)
        Flushes any characters saved in the converter's internal buffer and resets the converter.
        Overrides:
        implFlush in class java.nio.charset.CharsetEncoder
        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 from Unicode mode of converter
        Overrides:
        implReset in class java.nio.charset.CharsetEncoder
      • encodeLoop

        protected java.nio.charset.CoderResult encodeLoop​(java.nio.CharBuffer in,
                                                          java.nio.ByteBuffer out)
        Encodes one or more chars. The default behaviour of the converter is stop and report if an error in input stream is encountered. To set different behaviour use @see CharsetEncoder.onMalformedInput()
        Specified by:
        encodeLoop in class java.nio.charset.CharsetEncoder
        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.
      • isLegalReplacement

        public boolean isLegalReplacement​(byte[] repl)
        Overrides super class method
        Overrides:
        isLegalReplacement in class java.nio.charset.CharsetEncoder
      • maxCharsPerByte

        public final float maxCharsPerByte()
        Returns the maxCharsPerByte value for the Charset that created this encoder.
        Returns:
        maxCharsPerByte
      • getMaxBytesForString

        public static int getMaxBytesForString​(int length,
                                               int maxCharSize)
        Calculates the size of a buffer for conversion from Unicode to a charset. The calculated size is guaranteed to be sufficient for this conversion. It takes into account initial and final non-character bytes that are output by some converters. It does not take into account callbacks which output more than one charset character sequence per call, like escape callbacks. The default (substitution) callback only outputs one charset character sequence.
        Parameters:
        length - Number of chars to be converted.
        maxCharSize - Return value from maxBytesPerChar for the converter that will be used.
        Returns:
        Size of a buffer that will be large enough to hold the output of bytes