Class Encoding

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map<java.lang.Integer,​java.lang.String> codeToName
      This is a mapping from a character code to a character name.
      protected java.util.Map<java.lang.String,​java.lang.Integer> nameToCode
      This is a mapping from a character name to a character code.
      static java.lang.String NOTDEF
      Identifies a non-mapped character.
    • Constructor Summary

      Constructors 
      Constructor Description
      Encoding()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addCharacterEncoding​(int code, java.lang.String name)
      This will add a character encoding.
      java.lang.String getCharacter​(int code)
      This will get the character from the code.
      java.lang.String getCharacter​(java.lang.String name)
      This will get the character from the name.
      static java.lang.String getCharacterForName​(java.lang.String name)
      This will take a name and get the character code for that name.
      int getCode​(java.lang.String name)
      This will get the character code for the name.
      java.util.Map<java.lang.Integer,​java.lang.String> getCodeToNameMap()
      Returns an unmodifiable view of the Code2Name mapping.
      java.lang.String getName​(int code)
      This will take a character code and get the name from the code.
      java.lang.String getNameFromCharacter​(char c)
      This will take a character code and get the name from the code.
      java.util.Map<java.lang.String,​java.lang.Integer> getNameToCodeMap()
      Returns an unmodifiable view of the Name2Code mapping.
      boolean hasCodeForName​(java.lang.String name)
      Determines if the encoding has a mapping for the given name value.
      boolean hasNameForCode​(int code)
      Determines if the encoding has a mapping for the given code value.
      • Methods inherited from class java.lang.Object

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

      • NOTDEF

        public static final java.lang.String NOTDEF
        Identifies a non-mapped character.
        See Also:
        Constant Field Values
      • codeToName

        protected final java.util.Map<java.lang.Integer,​java.lang.String> codeToName
        This is a mapping from a character code to a character name.
      • nameToCode

        protected final java.util.Map<java.lang.String,​java.lang.Integer> nameToCode
        This is a mapping from a character name to a character code.
    • Constructor Detail

      • Encoding

        public Encoding()
    • Method Detail

      • getCodeToNameMap

        public java.util.Map<java.lang.Integer,​java.lang.String> getCodeToNameMap()
        Returns an unmodifiable view of the Code2Name mapping.
        Returns:
        the Code2Name map
      • getNameToCodeMap

        public java.util.Map<java.lang.String,​java.lang.Integer> getNameToCodeMap()
        Returns an unmodifiable view of the Name2Code mapping.
        Returns:
        the Name2Code map
      • addCharacterEncoding

        public void addCharacterEncoding​(int code,
                                         java.lang.String name)
        This will add a character encoding.
        Parameters:
        code - The character code that matches the character.
        name - The name of the character.
      • hasCodeForName

        public boolean hasCodeForName​(java.lang.String name)
        Determines if the encoding has a mapping for the given name value.
        Parameters:
        name - the source value for the mapping
        Returns:
        the mapped value
      • hasNameForCode

        public boolean hasNameForCode​(int code)
        Determines if the encoding has a mapping for the given code value.
        Parameters:
        code - the source value for the mapping
        Returns:
        the mapped value
      • getCode

        public int getCode​(java.lang.String name)
                    throws java.io.IOException
        This will get the character code for the name.
        Parameters:
        name - The name of the character.
        Returns:
        The code for the character.
        Throws:
        java.io.IOException - If there is no character code for the name.
      • getName

        public java.lang.String getName​(int code)
                                 throws java.io.IOException
        This will take a character code and get the name from the code.
        Parameters:
        code - The character code.
        Returns:
        The name of the character.
        Throws:
        java.io.IOException - If there is no name for the code.
      • getCharacterForName

        public static java.lang.String getCharacterForName​(java.lang.String name)
        This will take a name and get the character code for that name.
        Parameters:
        name - The name.
        Returns:
        The name of the character.
      • getNameFromCharacter

        public java.lang.String getNameFromCharacter​(char c)
                                              throws java.io.IOException
        This will take a character code and get the name from the code.
        Parameters:
        c - The character.
        Returns:
        The name of the character.
        Throws:
        java.io.IOException - If there is no name for the character.
      • getCharacter

        public java.lang.String getCharacter​(int code)
                                      throws java.io.IOException
        This will get the character from the code.
        Parameters:
        code - The character code.
        Returns:
        The printable character for the code.
        Throws:
        java.io.IOException - If there is not name for the character.
      • getCharacter

        public java.lang.String getCharacter​(java.lang.String name)
        This will get the character from the name.
        Parameters:
        name - The name of the character.
        Returns:
        The printable character for the code.