org.ghost4j

Class Ghostscript

java.lang.Object

org.ghost4j.Ghostscript

public class Ghostscript
extends Object

Class representing the Ghostscript interpreter.

Author:

Gilles Grousset (gi.grousset@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_NAME_ENCODING Name of the system property used to set the encoding to use for stdin.

Method Summary

Methods

Modifier and Type	Method and Description
static void	deleteInstance() Deletes the singleton instance of the Ghostscript object.
void	exit() Exits Ghostscript interpreter.
DisplayCallback	getDisplayCallback() Gets the display callback set on the Ghostscript interpreter (may be null if not set).
static Ghostscript	getInstance() Singleton access method.
static GhostscriptRevision	getRevision() Gets Ghostscript revision data.
OutputStream	getStdErr() Gets the error output stream of the Ghostscript interpreter (may be null if not set).
InputStream	getStdIn() Gets the standard input stream of the Ghostscript interpreter (may be null if not set).
OutputStream	getStdOut() Gets the standard output stream of the Ghostscript interpreter (may be null if not set).
void	initialize(String[] args) Initializes Ghostscript interpreter.
void	runFile(String fileName) Sends file Ghostscript interpreter.
void	runString(String string) Sends command string to Ghostscript interpreter.
void	setDisplayCallback(DisplayCallback displayCallback) Sets a display callback for the Ghostscript interpreter.
void	setStdErr(OutputStream stdErr) Sets the error output stream of the Ghostscript interpreter.
void	setStdIn(InputStream stdIn) Sets the standard input stream of the Ghostscript interpreter.
void	setStdOut(OutputStream stdOut) Sets the standard output stream of the Ghostscript interpreter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_NAME_ENCODING

public static final String PROPERTY_NAME_ENCODING

Name of the system property used to set the encoding to use for stdin.

See Also:

Constant Field Values

Method Detail

getInstance

public static Ghostscript getInstance()

Singleton access method.

Returns:

The singleton instance.

getDisplayCallback

public DisplayCallback getDisplayCallback()

Gets the display callback set on the Ghostscript interpreter (may be null if not set).

Returns:

The DisplayCallback or null

setDisplayCallback

public void setDisplayCallback(DisplayCallback displayCallback)

Sets a display callback for the Ghostscript interpreter.

Parameters:

displayCallback - DisplayCallback object

getStdErr

public OutputStream getStdErr()

Gets the error output stream of the Ghostscript interpreter (may be null if not set).

Returns:

The OutputStream or null

setStdErr

public void setStdErr(OutputStream stdErr)

Sets the error output stream of the Ghostscript interpreter.

Parameters:

stdErr - OutputStream object

getStdOut

public OutputStream getStdOut()

Gets the standard output stream of the Ghostscript interpreter (may be null if not set).

Returns:

The OutputStream or null

setStdOut

public void setStdOut(OutputStream stdOut)

Sets the standard output stream of the Ghostscript interpreter.

Parameters:

stdOut - OutputStream object

getStdIn

public InputStream getStdIn()

Gets the standard input stream of the Ghostscript interpreter (may be null if not set).

Returns:

The InputStream or null

setStdIn

public void setStdIn(InputStream stdIn)

Sets the standard input stream of the Ghostscript interpreter.

Parameters:

stdIn - InputStream object

getRevision

public static GhostscriptRevision getRevision()

Gets Ghostscript revision data.

Returns:

Revision data.

initialize

public void initialize(String[] args)
                throws GhostscriptException

Initializes Ghostscript interpreter.

Parameters:

args - Interpreter parameters. Use the same as Ghostscript command line arguments.

Throws:

GhostscriptException

exit

public void exit()
          throws GhostscriptException

Exits Ghostscript interpreter. Must be called after initialize.

Throws:

GhostscriptException

runString

public void runString(String string)
               throws GhostscriptException

Sends command string to Ghostscript interpreter. Must be called after initialize method.

Parameters:

string - Command string

Throws:

GhostscriptException

runFile

public void runFile(String fileName)
             throws GhostscriptException

Sends file Ghostscript interpreter. Must be called after initialize method.

Parameters:

fileName - File name

Throws:

GhostscriptException

deleteInstance

public static void deleteInstance()
                           throws GhostscriptException

Deletes the singleton instance of the Ghostscript object. This ensures that the native Ghostscrit interpreter instance is deleted. This method must be called if Ghostscript is not used anymore or maybe reinitialized.

Throws:

GhostscriptException