com.adobe.internal.pdftoolkit.core.filter

Class CustomFilterRegistry

java.lang.Object

com.adobe.internal.pdftoolkit.core.filter.CustomFilterRegistry

public class CustomFilterRegistry
extends Object

A registry that enables clients to register their custom stream filters with us. The filters will be used when encoding and decoding the CosStreams containing relevant content.

Constructor Summary

Constructors

Constructor and Description
CustomFilterRegistry()

Method Summary

Modifier and Type	Method and Description
OutputStream	encode(ASName filterName, OutputStream dstStm, FilterParams params) Encode the stream using the filters registered for encode.
Collection<CustomDecodeFilter>	getDecodeFilters() Returns the list of all registered decode filters
static List	getDefaultDecodeFilters() Returns a list of filter names representing decode filters present in Gibson
static List	getDefaultEncodeFilters() Returns a list of filter names representing encode filters present in Gibson
Collection<CustomEncodeFilter>	getEncodeFilters() Returns the list of all registered encode filters
CustomDecodeFilter	getRegisteredDecodeFilterByName(ASName filterName) searches registered custom decode filter by name and returns it, if present.
CustomEncodeFilter	getRegisteredEncodeFilterByName(ASName filterName) searches registered custom encode filter by name and returns it, if present.
List	getRegisteredFilters() Returns list of all the registered filters
boolean	isDecodeFilterRegistered(ASName filterName) Checks if a custom decode filter is registered
boolean	isEncodeFilterRegistered(ASName filterName) Checks if a custom encode filter is registered
void	registerDecodeFilter(CustomDecodeFilter filter) Register your custom decode filter implementation
void	registerEncodeFilter(CustomEncodeFilter filter) Register your custom encode filter implementation
void	registerFilter(CustomFilter customFilter) Register the given filter with the registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFilterRegistry

public CustomFilterRegistry()

Method Detail

registerFilter

public void registerFilter(CustomFilter customFilter)

Register the given filter with the registry.

Parameters:

customFilter -

isEncodeFilterRegistered

public boolean isEncodeFilterRegistered(ASName filterName)

Checks if a custom encode filter is registered

Parameters:

filterName -

Returns:

true if a custom encode filter is registered

isDecodeFilterRegistered

public boolean isDecodeFilterRegistered(ASName filterName)

Checks if a custom decode filter is registered

Parameters:

filterName -

Returns:

true if a custom decode filter is registered

getEncodeFilters

public Collection<CustomEncodeFilter> getEncodeFilters()

Returns the list of all registered encode filters

Returns:

Collection of encode filters

getDecodeFilters

public Collection<CustomDecodeFilter> getDecodeFilters()

Returns the list of all registered decode filters

Returns:

Collection of decode filters

registerEncodeFilter

public void registerEncodeFilter(CustomEncodeFilter filter)

Register your custom encode filter implementation

Parameters:

filter -

registerDecodeFilter

public void registerDecodeFilter(CustomDecodeFilter filter)

Register your custom decode filter implementation

Parameters:

filter -

encode

public OutputStream encode(ASName filterName,
                           OutputStream dstStm,
                           FilterParams params)
                    throws CustomFilterException

Encode the stream using the filters registered for encode.

Parameters:

filterName -

dstStm -

params -

Returns:

InputStream containing the decoded bytes.

Throws:

CustomFilterException

getRegisteredFilters

public List getRegisteredFilters()

Returns list of all the registered filters

Returns:

list of registered filters

getDefaultDecodeFilters

public static List getDefaultDecodeFilters()

Returns a list of filter names representing decode filters present in Gibson

Returns:

list of decode filters present in Gibson by default.

getDefaultEncodeFilters

public static List getDefaultEncodeFilters()

Returns a list of filter names representing encode filters present in Gibson

Returns:

list of encode filters present in Gibson by default.

getRegisteredDecodeFilterByName

public CustomDecodeFilter getRegisteredDecodeFilterByName(ASName filterName)

searches registered custom decode filter by name and returns it, if present.

Parameters:

filterName -

Returns:

CustomDecodeFilter

getRegisteredEncodeFilterByName

public CustomEncodeFilter getRegisteredEncodeFilterByName(ASName filterName)

searches registered custom encode filter by name and returns it, if present.

Parameters:

filterName -

Returns:

CustomEncodeFilter