Class Encoding
java.lang.Object
org.apache.pdfbox.pdmodel.font.encoding.Encoding
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
BuiltInEncoding
,DictionaryEncoding
,MacExpertEncoding
,MacRomanEncoding
,StandardEncoding
,SymbolEncoding
,Type1Encoding
,WinAnsiEncoding
,ZapfDingbatsEncoding
A PostScript encoding vector, maps character codes to glyph names.
- Author:
- Ben Litchfield
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
This will add a character encoding.boolean
contains
(int code) Determines if the encoding has a mapping for the given code value.boolean
Determines if the encoding has a mapping for the given name value.Returns an unmodifiable view of the code -> name mapping.abstract String
Returns the name of this encoding.static Encoding
getInstance
(COSName name) This will get an encoding by name.getName
(int code) This will take a character code and get the name from the code.Returns an unmodifiable view of the name -> code mapping.protected void
This will add a character encoding.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.pdfbox.pdmodel.common.COSObjectable
getCOSObject
-
Field Details
-
CHAR_CODE
protected static final int CHAR_CODE- See Also:
-
CHAR_NAME
protected static final int CHAR_NAME- See Also:
-
codeToName
code-to-name map. Derived classes should not modify the map after class construction. -
inverted
name-to-code map. Derived classes should not modify the map after class construction.
-
-
Constructor Details
-
Encoding
public Encoding()
-
-
Method Details
-
getInstance
This will get an encoding by name. May return null.- Parameters:
name
- The name of the encoding to get.- Returns:
- The encoding that matches the name.
-
getCodeToNameMap
Returns an unmodifiable view of the code -> name mapping.- Returns:
- the code -> name map
-
getNameToCodeMap
Returns an unmodifiable view of the name -> code mapping. More than one name may map to the same code.- Returns:
- the name -> code map
-
add
This will add a character encoding. An already existing mapping is preserved when creating the reverse mapping. Should only be used during construction of the class.- Parameters:
code
- character codename
- PostScript glyph name- See Also:
-
overwrite
This will add a character encoding. An already existing mapping is overwritten when creating the reverse mapping.- Parameters:
code
- character codename
- PostScript glyph name- See Also:
-
contains
Determines if the encoding has a mapping for the given name value.- Parameters:
name
- PostScript glyph name
-
contains
public boolean contains(int code) Determines if the encoding has a mapping for the given code value.- Parameters:
code
- character code
-
getName
This will take a character code and get the name from the code.- Parameters:
code
- character code- Returns:
- PostScript glyph name
-
getEncodingName
Returns the name of this encoding.
-