Enum CharacterSetECI

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CharacterSetECI>

    public enum CharacterSetECI
    extends java.lang.Enum<CharacterSetECI>
    Encapsulates a Character Set ECI, according to "Extended Channel Interpretations" 5.3.1.1 of ISO 18004.
    • Field Detail

      • VALUE_TO_ECI

        private static final java.util.Map<java.lang.Integer,​CharacterSetECI> VALUE_TO_ECI
      • NAME_TO_ECI

        private static final java.util.Map<java.lang.String,​CharacterSetECI> NAME_TO_ECI
      • values

        private final int[] values
      • otherEncodingNames

        private final java.lang.String[] otherEncodingNames
    • Constructor Detail

      • CharacterSetECI

        private CharacterSetECI​(int value)
      • CharacterSetECI

        private CharacterSetECI​(int value,
                                java.lang.String... otherEncodingNames)
      • CharacterSetECI

        private CharacterSetECI​(int[] values,
                                java.lang.String... otherEncodingNames)
    • Method Detail

      • values

        public static CharacterSetECI[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (CharacterSetECI c : CharacterSetECI.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CharacterSetECI valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getValue

        public int getValue()
      • getCharset

        public java.nio.charset.Charset getCharset()
      • getCharacterSetECI

        public static CharacterSetECI getCharacterSetECI​(java.nio.charset.Charset charset)
        Parameters:
        charset - Java character set object
        Returns:
        CharacterSetECI representing ECI for character encoding, or null if it is legal but unsupported
      • getCharacterSetECIByValue

        public static CharacterSetECI getCharacterSetECIByValue​(int value)
                                                         throws FormatException
        Parameters:
        value - character set ECI value
        Returns:
        CharacterSetECI representing ECI of given value, or null if it is legal but unsupported
        Throws:
        FormatException - if ECI value is invalid
      • getCharacterSetECIByName

        public static CharacterSetECI getCharacterSetECIByName​(java.lang.String name)
        Parameters:
        name - character set ECI encoding name
        Returns:
        CharacterSetECI representing ECI for character encoding, or null if it is legal but unsupported