org.axsl.ps

Class PsEncodeFilter

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.axsl.ps.PsEncodeFilter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public abstract class PsEncodeFilter
extends java.io.FilterOutputStream

A PostScript filter object.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
PsEncodeFilter(java.io.OutputStream out) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getDecodeName() Return the PostScript name of the filter that should be used to decode content encoded by this filter.
abstract java.lang.String	getDecodeParms() Return a parameter dictionary for this filter, or null if there is none.
abstract java.lang.String	getName() Return a PostScript name representation of the filter, e.g.
abstract void	setDecodeParms(java.lang.String decodeParms) Sets the decode parameters for this filter.
abstract void	setInactive() Sets this filter to a state where it acts as a null filter, simply passing the data through as received.
abstract void	setLineLength(int lineLength) Sets the length of the output line that should be written during encoding.

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

PsEncodeFilter

public PsEncodeFilter(java.io.OutputStream out)

Constructor.

Parameters:

out - The output stream being wrapped.

Method Detail

getName

public abstract java.lang.String getName()

Return a PostScript name representation of the filter, e.g. /FlateEncode.

Returns:

A PostScript name representation of the filter.

getDecodeName

public abstract java.lang.String getDecodeName()

Return the PostScript name of the filter that should be used to decode content encoded by this filter. For example, if this filter is "/FlateEncode", this method should return "/FlateDecode".

Returns:

The name of the decode filter.

setDecodeParms

public abstract void setDecodeParms(java.lang.String decodeParms)

Sets the decode parameters for this filter.

Parameters:

decodeParms - The new decode parameters.

getDecodeParms

public abstract java.lang.String getDecodeParms()

Return a parameter dictionary for this filter, or null if there is none.

Returns:

The parameter dictionary for this filter.

setInactive

public abstract void setInactive()

Sets this filter to a state where it acts as a null filter, simply passing the data through as received. This is useful in cases where the filter needs to exist as a marker, but should not be applied. One example is the case where the raw data has already been filtered, but the filter needs to be created anyway to signal to something downstream that it needs to be unfiltered.

setLineLength

public abstract void setLineLength(int lineLength)

Sets the length of the output line that should be written during encoding. This only applies to some filter types, such as that for PsFilterType.ASCII_HEX, and will be ignored by other filter types.

Parameters:

lineLength - The length, in ASCII characters, of the filter output lines.