PsServer (aXSL API)

```
public interface PsServer
```
Provides PostScript-related services to client applications.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PsSystemDict`	`getJava2dSystemDict(java.awt.Graphics2D graphics)` Returns a system dictionary which can draw on a Java2D graphic.
`PsSystemDict`	`getPdfSystemDict()` Returns a system dictionary suitable for writing into a PDF stream.
`CharSet`	`getPredefinedCharSet(CharSet.Predefined predefined)` Returns one of the predefined character sets.
`CharSet`	`getPredefinedCharSet(java.lang.String name)` Returns one of the predefined character sets.
`PsEncoding`	`getPredefinedEncoding(PsEncoding.Predefined predefinedVector)` Returns one of the predefined encodings.
`PsEncoding`	`getPredefinedEncoding(java.lang.String name)` Returns one of the predefined encodings.
`GlyphList`	`getPredefinedGlyphList(GlyphList.Predefined predefined)` Returns one of the predefined glyphs lists.
`PsSystemDict`	`getReadOnlySystemDict()` Returns a read-only system dictionary.
`CharSet`	`makeCharSet(java.lang.String name, char[] characterSet)` Creates a new CharSet that will contain only 16-bit characters.
`CharSet`	`makeCharSet(java.lang.String name, int[] characterSet)` Creates a new CharSet containing 16-bit codePoints, 32-bit code points, or both.
`Cmap04`	`makeCmap04(java.lang.String name, int expectedEntries)` Creates a new Cmap04 with a given name and expected size.
`Cmap12`	`makeCmap12(java.lang.String name, int expectedEntries)` Creates a new Cmap12 with a given name and expected size.
`java.io.InputStream`	`makeDecodeFilter(PsFilterType filterType, java.io.InputStream inputStream)` Creates a decode filter of a specified type.
`PsEncodeFilter`	`makeEncodeFilter(PsFilterType filterType, java.io.OutputStream outputStream)` Creates an encode filter of a specified type.
`PsEncoding`	`makeEncodingVector(java.lang.String name, char[] codePoints, char[] codePointIndexes)` Create a new EncodingVector instance and registers it for later use.
`PsInterpreter`	`makeInterpreter(PsInput psInput, PsSystemDict systemDict)` Returns an interpreter.
`PsInput`	`makePsInput(java.io.File inputFile)` Creates a `PsInput` instance from a File.
`CharSet`	`parseCharSet(java.lang.String name, java.io.InputStream inputStream)` Parse a character set from an input stream.
`PsEncoding`	`parseEncodingVector(java.lang.String name, java.io.InputStream inputStream, int columnNum, int radix, java.util.List<java.lang.String> glyphLists)` Parse an encoding vector from an input stream.
`GlyphList`	`parseGlyphList(java.lang.String name, java.io.InputStream inputStream)` Parse a glyph list from an input stream.

- Method Detail
  - makeDecodeFilter
```
java.io.InputStream makeDecodeFilter(PsFilterType filterType,
                                     java.io.InputStream inputStream)
```
    Creates a decode filter of a specified type.
    
    Parameters:
    
    filterType - The type of filter to be created.
    
    inputStream - The underlying input stream to be filtered.
    
    Returns:
    
    The newly-created filter.
  - makeEncodeFilter
```
PsEncodeFilter makeEncodeFilter(PsFilterType filterType,
                                java.io.OutputStream outputStream)
```
    Creates an encode filter of a specified type.
    
    Parameters:
    
    filterType - The type of filter to be created.
    
    outputStream - The underlying output stream to be filtered.
    
    Returns:
    
    The newly-created filter.
  - makePsInput
```
PsInput makePsInput(java.io.File inputFile)
             throws java.io.IOException
```
    Creates a PsInput instance from a File.
    
    Parameters:
    
    inputFile - The file to be processed as PostScript input.
    
    Returns:
    
    The newly-created PsInput.
    
    Throws:
    
    java.io.IOException - For errors opening the file.
  - getReadOnlySystemDict
```
PsSystemDict getReadOnlySystemDict()
                            throws PsException
```
    Returns a read-only system dictionary. This is useful for cases where no drawing should be done, but we wish to interpret the document and see the state of the various data structures. This was specifically designed for parsing Type 1 fonts and extracting information from them.
    
    Returns:
    
    A read-only system dictionary.
    
    Throws:
    
    PsException - If this operation is unsupported.
  - getPdfSystemDict
```
PsSystemDict getPdfSystemDict()
                       throws PsException
```
    Returns a system dictionary suitable for writing into a PDF stream.
    
    Returns:
    
    A PDF system dictionary.
    
    Throws:
    
    PsException - If this operation is unsupported.
  - getJava2dSystemDict
```
PsSystemDict getJava2dSystemDict(java.awt.Graphics2D graphics)
                          throws PsException
```
    Returns a system dictionary which can draw on a Java2D graphic.
    
    Parameters:
    
    graphics - The Java2D graphics instance.
    
    Returns:
    
    A Java2D system dictionary.
    
    Throws:
    
    PsException - If this operation is unsupported.
  - makeInterpreter
```
PsInterpreter makeInterpreter(PsInput psInput,
                              PsSystemDict systemDict)
                       throws PsException
```
    Returns an interpreter.
    
    Parameters:
    
    psInput - The input source to be interpreted.
    
    systemDict - The system dictionary.
    
    Returns:
    
    A new interpreter.
    
    Throws:
    
    PsException - For errors creating the interpreter.
  - getPredefinedEncoding
```
PsEncoding getPredefinedEncoding(java.lang.String name)
```
    Returns one of the predefined encodings.
    
    Parameters:
    
    name - The name of the predefined encoding to be returned.
    
    Returns:
    
    The predefined encoding if it can be found or created, or null otherwise.
    
    See Also:
    
    getPredefinedEncoding(PsEncoding.Predefined)
  - getPredefinedEncoding
```
PsEncoding getPredefinedEncoding(PsEncoding.Predefined predefinedVector)
```
    Returns one of the predefined encodings.
    
    Parameters:
    
    predefinedVector - The predefined encoding to be returned.
    
    Returns:
    
    The predefined encoding if it can be found or created, or null otherwise.
    
    See Also:
    
    getPredefinedEncoding(String)
  - makeEncodingVector
```
PsEncoding makeEncodingVector(java.lang.String name,
                              char[] codePoints,
                              char[] codePointIndexes)
```
    Create a new EncodingVector instance and registers it for later use.
    
    Parameters:
    
    name - The name of this encoding.
    
    codePoints - The array of Unicode code points supported by this encoding.
    
    codePointIndexes - The array of encoded indexes that is parallel to codePoints. codePointIndexes[n] should contain the encoded index that corresponds to the Unicode code point at codePoints[n].
    
    Returns:
    
    The newly-created implementation-specific EncodingVector instance.
  - parseEncodingVector
```
PsEncoding parseEncodingVector(java.lang.String name,
                               java.io.InputStream inputStream,
                               int columnNum,
                               int radix,
                               java.util.List<java.lang.String> glyphLists)
                        throws java.io.IOException,
                               PsException
```
    Parse an encoding vector from an input stream.
    
    Parameters:
    
    name - The name of the encoding vector to be parsed.
    
    inputStream - The input stream containing the raw encoding vector information.
    
    columnNum - The column number in the input file that should be read to get the encoded value for this encoding. Column number 1 is the first field after the glyph name, that is, field 2.
    
    radix - The radix of the numbering system (10 for decimal, 8 for octal, etc.).
    
    glyphLists - A space-separated list of glyph lists to be consulted when mapping glyph names to Unicode code points.
    
    Returns:
    
    The parsed encoding vector.
    
    Throws:
    
    java.io.IOException - For errors opening or reading the input stream.
    
    PsException - For errors parsing the encoding vector.
  - getPredefinedCharSet
```
CharSet getPredefinedCharSet(java.lang.String name)
```
    Returns one of the predefined character sets.
    
    Parameters:
    
    name - The name of the predefined character set to be returned.
    
    Returns:
    
    The predefined character set if it can be found or created, or null otherwise.
    
    See Also:
    
    getPredefinedCharSet(org.axsl.ps.CharSet.Predefined)
  - getPredefinedCharSet
```
CharSet getPredefinedCharSet(CharSet.Predefined predefined)
```
    Returns one of the predefined character sets.
    
    Parameters:
    
    predefined - The predefined character set to be returned.
    
    Returns:
    
    The predefined character set if it can be found or created, or null otherwise.
    
    See Also:
    
    getPredefinedCharSet(org.axsl.ps.CharSet.Predefined)
  - makeCharSet
```
CharSet makeCharSet(java.lang.String name,
                    int[] characterSet)
```
    Creates a new CharSet containing 16-bit codePoints, 32-bit code points, or both. If all code points in the character set are 16-bit (less than or equal to 0xFFFF), then makeCharSet(String, char[]) may also be used.
    
    Parameters:
    
    name - The name of this character set.
    
    characterSet - The array containing the code points in this character set.
    
    Returns:
    
    The newly-created implementation-specific CharSet instance.
    
    See Also:
    
    makeCharSet(String, char[])
  - makeCharSet
```
CharSet makeCharSet(java.lang.String name,
                    char[] characterSet)
```
    Creates a new CharSet that will contain only 16-bit characters. If there are any 32-bit code points in the character set, use makeCharSet(String, int[]) instead.
    
    Parameters:
    
    name - The name of the new character set.
    
    characterSet - The array of chars containing the code points in this character set.
    
    Returns:
    
    The newly-created implementation-specific CharSet instance.
    
    See Also:
    
    makeCharSet(String, int[])
  - parseCharSet
```
CharSet parseCharSet(java.lang.String name,
                     java.io.InputStream inputStream)
              throws java.io.IOException,
                     PsException
```
    Parse a character set from an input stream.
    
    Parameters:
    
    name - The name of the character set to be parsed.
    
    inputStream - The input stream containing the raw character set information.
    
    Returns:
    
    The parsed character set.
    
    Throws:
    
    java.io.IOException - For errors opening or reading the input stream.
    
    PsException - For errors parsing the character set.
  - getPredefinedGlyphList
```
GlyphList getPredefinedGlyphList(GlyphList.Predefined predefined)
```
    Returns one of the predefined glyphs lists.
    
    Parameters:
    
    predefined - The predefined glyph list to be returned.
    
    Returns:
    
    The predefined glyph list if it can be found or created, or null otherwise.
  - parseGlyphList
```
GlyphList parseGlyphList(java.lang.String name,
                         java.io.InputStream inputStream)
                  throws java.io.IOException,
                         PsException
```
    Parse a glyph list from an input stream.
    
    Parameters:
    
    name - The name of the glyph list to be parsed.
    
    inputStream - The input stream containing the raw glyph list information.
    
    Returns:
    
    The parsed glyph list.
    
    Throws:
    
    java.io.IOException - For errors opening or reading the input stream.
    
    PsException - For errors parsing the glyph list.
  - makeCmap04
```
Cmap04 makeCmap04(java.lang.String name,
                  int expectedEntries)
```
    Creates a new Cmap04 with a given name and expected size.
    
    Parameters:
    
    name - The name of this encoding.
    
    expectedEntries - The number of expected entries in this encoding. Setting this to the correct value gives the implementation an opportunity for more efficient processing.
    
    Returns:
    
    The newly-created implementation-specific Cmap04 instance.
  - makeCmap12
```
Cmap12 makeCmap12(java.lang.String name,
                  int expectedEntries)
```
    Creates a new Cmap12 with a given name and expected size.
    
    Parameters:
    
    name - The name of this encoding.
    
    expectedEntries - The number of expected entries in this encoding. Setting this to the correct value gives the implementation an opportunity for more efficient processing.
    
    Returns:
    
    The newly-created implementation-specific Cmap12 instance.

This documentation was created 2017-01-24 at 21:26 GMT by The aXSL Group and may be freely copied. See license for details.

Interface PsServer

Method Summary

Method Detail

makeDecodeFilter

makeEncodeFilter

makePsInput

getReadOnlySystemDict

getPdfSystemDict

getJava2dSystemDict

makeInterpreter

getPredefinedEncoding

getPredefinedEncoding

makeEncodingVector

parseEncodingVector

getPredefinedCharSet

getPredefinedCharSet

makeCharSet

makeCharSet

parseCharSet

getPredefinedGlyphList

parseGlyphList

makeCmap04

makeCmap12