CMapParser (PDFBox reactor 2.0.10 API)

java.lang.Object
+
- org.apache.fontbox.cmap.CMapParser
+

+
+
+
```
public class CMapParser
+extends Object
```
+
Parses a CMap stream.
+
+
Author:
+
Ben Litchfield
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
CMapParser() +
Creates a new instance of CMapParser.
+
+

Constructors
Constructor and Description
`CMapParser()` + Creates a new instance of CMapParser. +

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected InputStream`	`getExternalCMap(String name)` + Returns an input stream containing the given "use" CMap. +
`CMap`	`parse(File file)` + Parse a CMAP file on the file system. +
`CMap`	`parse(InputStream input)` + This will parse the stream and create a cmap object. +
`CMap`	`parsePredefined(String name)` + Parses a predefined CMap. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    CMapParser
    +
```
public CMapParser()
```
    +
    Creates a new instance of CMapParser.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    parse
    +
```
public CMap parse(File file)
+           throws IOException
```
    +
    Parse a CMAP file on the file system.
    +
    +
    Parameters:
    +
    file - The file to parse.
    +
    Returns:
    +
    A parsed CMAP file.
    +
    Throws:
    +
    IOException - If there is an issue while parsing the CMAP.
    +
    +
  + + + +
  - +
    parsePredefined
    +
```
public CMap parsePredefined(String name)
+                     throws IOException
```
    +
    Parses a predefined CMap.
    +
    +
    Parameters:
    +
    name - CMap name.
    +
    Returns:
    +
    The parsed predefined CMap as a java object, never null.
    +
    Throws:
    +
    IOException - If the CMap could not be parsed.
    +
    +
  + + + +
  - +
    parse
    +
```
public CMap parse(InputStream input)
+           throws IOException
```
    +
    This will parse the stream and create a cmap object.
    +
    +
    Parameters:
    +
    input - The CMAP stream to parse.
    +
    Returns:
    +
    The parsed stream as a java object, never null.
    +
    Throws:
    +
    IOException - If there is an error parsing the stream.
    +
    +
  + + + +
  - +
    getExternalCMap
    +
```
protected InputStream getExternalCMap(String name)
+                               throws IOException
```
    +
    Returns an input stream containing the given "use" CMap.
    +
    +
    Parameters:
    +
    name - Name of the given "use" CMap resource.
    +
    Throws:
    +
    IOException - if the CMap resource doesn't exist or if there is an error opening its + stream.
    +
    +
  +
+

java.lang.Object
+
- org.apache.fontbox.cmap.CodespaceRange
+

+
+
+
```
public class CodespaceRange
+extends Object
```
+
This represents a single entry in the codespace range.
+
+
Author:
+
Ben Litchfield
+
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
CodespaceRange() +
Creates a new instance of CodespaceRange.
+
+

Constructors
Constructor and Description
`CodespaceRange()` + Creates a new instance of CodespaceRange. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCodeLength()` + Returns the length of the codes of the codespace. +
`byte[]`	`getEnd()` + Getter for property end. +
`byte[]`	`getStart()` + Getter for property start. +
`boolean`	`isFullMatch(byte[] code, + int codeLen)` + Returns true if the given code bytes match this codespace range. +
`boolean`	`matches(byte[] code)` + Returns true if the given code bytes match this codespace range. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    CodespaceRange
    +
```
public CodespaceRange()
```
    +
    Creates a new instance of CodespaceRange.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getCodeLength
    +
```
public int getCodeLength()
```
    +
    Returns the length of the codes of the codespace.
    +
    +
    Returns:
    +
    the code length
    +
    +
  + + + +
  - +
    getEnd
    +
```
public byte[] getEnd()
```
    +
    Getter for property end.
    +
    +
    Returns:
    +
    Value of property end.
    +
    +
  + + + +
  - +
    getStart
    +
```
public byte[] getStart()
```
    +
    Getter for property start.
    +
    +
    Returns:
    +
    Value of property start.
    +
    +
  + + + +
  - +
    matches
    +
```
public boolean matches(byte[] code)
```
    +
    Returns true if the given code bytes match this codespace range.
    +
  + + + +
  - +
    isFullMatch
    +
```
public boolean isFullMatch(byte[] code,
+                           int codeLen)
```
    +
    Returns true if the given code bytes match this codespace range.
    +
  +
+

+ + + + + + + + + + + + + + + + +

Packages that use CMap
Package	Description
org.apache.fontbox.cmap	+ This package holds classes that are necessary to parse cmap files. +
org.apache.pdfbox.pdmodel.font	+ Classes to deal with font functionality in a PDF Document. +

+ + +

Uses of CMap in org.apache.fontbox.cmap

+ + + + + + + + + + + + + + + + + + + + +

Methods in org.apache.fontbox.cmap that return CMap
Modifier and Type	Method and Description
`CMap`	CMapParser.`parse(File file)` + Parse a CMAP file on the file system. +
`CMap`	CMapParser.`parse(InputStream input)` + This will parse the stream and create a cmap object. +
`CMap`	CMapParser.`parsePredefined(String name)` + Parses a predefined CMap. +

+ + +

Uses of CMap in org.apache.pdfbox.pdmodel.font

+ + + + + + + + + + + + + + + + + + + + +

Methods in org.apache.pdfbox.pdmodel.font that return CMap
Modifier and Type	Method and Description
`CMap`	PDType0Font.`getCMap()` + Returns the font's CMap. +
`CMap`	PDType0Font.`getCMapUCS2()` + Returns the font's UCS2 CMap, only present this font uses a predefined CMap. +
`protected CMap`	PDFont.`readCMap(COSBase base)` + Reads a CMap given a COS Stream or Name. +

org.apache.fontbox.cmap

org.apache.fontbox.cmap (PDFBox reactor 2.0.10 API)

+ + + + + + + + + + + + + + + + + + + + +
Class Summary
Class Description
CMap +
This class represents a CMap file.
+
CMapParser +
Parses a CMap stream.
+
CodespaceRange +
This represents a single entry in the codespace range.
+
+

Class Summary
Class	Description
CMap	+ This class represents a CMap file. +
CMapParser	+ Parses a CMap stream. +
CodespaceRange	+ This represents a single entry in the codespace range. +

+ + + +

Package org.apache.fontbox.cmap Description

This package holds classes that are necessary to parse cmap files.

org.apache.fontbox.cmap Class Hierarchy (PDFBox reactor 2.0.10 API)

Class Hierarchy

java.lang.Object +
- org.apache.fontbox.cmap.CMap
- org.apache.fontbox.cmap.CMapParser
- org.apache.fontbox.cmap.CodespaceRange
+

Uses of Package org.apache.fontbox.cmap (PDFBox reactor 2.0.10 API)

+ + + + + + + + + + + + + + + + +

Packages that use org.apache.fontbox.cmap
Package	Description
org.apache.fontbox.cmap	+ This package holds classes that are necessary to parse cmap files. +
org.apache.pdfbox.pdmodel.font	+ Classes to deal with font functionality in a PDF Document. +

+ + + + + + + + + + + + +
Classes in org.apache.fontbox.cmap used by org.apache.fontbox.cmap
Class and Description
CMap +
This class represents a CMap file.
+
+
+ + + + + + + + + + + + +
Classes in org.apache.fontbox.cmap used by org.apache.pdfbox.pdmodel.font
Class and Description
CMap +
This class represents a CMap file.
+
+

Class CMapParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CMapParser

Method Detail

parse

parsePredefined

parse

getExternalCMap

Class CodespaceRange

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodespaceRange

Method Detail

getCodeLength

getEnd

getStart

matches

isFullMatch

Uses of Class
org.apache.fontbox.cmap.CMap

Uses of CMap in org.apache.fontbox.cmap

Uses of CMap in org.apache.pdfbox.pdmodel.font

Uses of Class
org.apache.fontbox.cmap.CMapParser

Uses of Class
org.apache.fontbox.cmap.CodespaceRange

org.apache.fontbox.cmap

Classes

Package org.apache.fontbox.cmap

Package org.apache.fontbox.cmap Description

Hierarchy For Package org.apache.fontbox.cmap

Class Hierarchy

Uses of Package
org.apache.fontbox.cmap

Class CMapParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CMapParser

Method Detail

parse

parsePredefined

parse

getExternalCMap

Class CodespaceRange

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodespaceRange

Method Detail

getCodeLength

getEnd

getStart

matches

isFullMatch

Uses of Classorg.apache.fontbox.cmap.CMap

Uses of CMap in org.apache.fontbox.cmap

Uses of CMap in org.apache.pdfbox.pdmodel.font

Uses of Classorg.apache.fontbox.cmap.CMapParser

Uses of Classorg.apache.fontbox.cmap.CodespaceRange

org.apache.fontbox.cmap

Classes

Package org.apache.fontbox.cmap

Package org.apache.fontbox.cmap Description

Hierarchy For Package org.apache.fontbox.cmap

Class Hierarchy

Uses of Packageorg.apache.fontbox.cmap

Uses of Class
org.apache.fontbox.cmap.CMap

Uses of Class
org.apache.fontbox.cmap.CMapParser

Uses of Class
org.apache.fontbox.cmap.CodespaceRange

Uses of Package
org.apache.fontbox.cmap