java.lang.Object
java.lang.Enum<CharacterSetECI>
com.google.zxing.common.CharacterSetECI
All Implemented Interfaces:
Serializable, Comparable<CharacterSetECI>, java.lang.constant.Constable
public enum CharacterSetECIextends Enum<CharacterSetECI>
Encapsulates a Character Set ECI, according to "Extended Channel Interpretations" 5.3.1.1 of ISO 18004.

  • Enum Constant Details

  • Field Details

    • VALUE_TO_ECI

      private static final Map<Integer, CharacterSetECI> VALUE_TO_ECI
      ECI instances by their number.

    • NAME_TO_ECI

      private static final Map<String, CharacterSetECI> NAME_TO_ECI
      ECI instances by their name.

    • values

      private final int[] values
      The ECI numbers this instance answers to.

    • otherEncodingNames

      private final String[] otherEncodingNames
      Alternate encoding names for this ECI.

  • Constructor Details

    • CharacterSetECI

      private CharacterSetECI(int value)
      Registers an ECI under one number.
      Parameters:
      value - the ECI number

    • CharacterSetECI

      private CharacterSetECI(int value, String... otherEncodingNames)
      Registers an ECI under one number with alternate names.
      Parameters:
      value - the ECI number
      otherEncodingNames - alternate encoding names

    • CharacterSetECI

      private CharacterSetECI(int[] values, String... otherEncodingNames)
      Registers an ECI under several numbers.
      Parameters:
      values - the ECI numbers
      otherEncodingNames - alternate encoding names

  • Method Details

    • values

      public static CharacterSetECI[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CharacterSetECI valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Get the first ECI value.
      Returns:
      the first ECI value

    • getCharacterSetECIByValue

      public static CharacterSetECI getCharacterSetECIByValue(int value) throws FormatException
      Get CharacterSetECI by value.
      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(String name)
      Get CharacterSetECI by name.
      Parameters:
      name - character set ECI encoding name
      Returns:
      CharacterSetECI representing ECI for character encoding, or null if it is legal but unsupported