Top Description Fields Constructors Methods
org.apache.pdfbox.filter

public final Class FilterFactory

extends Object
Class Inheritance
Imports
java.io.IOException, java.util.Collection, .HashMap, .Map, org.apache.pdfbox.cos.COSName
Factory for Filter classes.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final Map<COSName, Filter>
filters

public static final FilterFactory
INSTANCE

Singleton instance.

Constructor Summary

AccessConstructor and Description
private
FilterFactory()

Method Summary

Modifier and TypeMethod and Description
pack-priv Collection<Filter>
getAllFilters()

public Filter

Returns:

the filter that matches the name
getFilter(String
the name of the filter to retrieve
filterName)

Returns a filter instance given its name as a string.

public Filter

Returns:

the filter that matches the name
getFilter(COSName
the name of the filter to retrieve
filterName)

Returns a filter instance given its COSName.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

filtersback to summary
private final Map<COSName, Filter> filters
INSTANCEback to summary
public static final FilterFactory INSTANCE

Singleton instance.

Constructor Detail

FilterFactoryback to summary
private FilterFactory()

Method Detail

getAllFiltersback to summary
pack-priv Collection<Filter> getAllFilters()
getFilterback to summary
public Filter getFilter(String filterName) throws IOException

Returns a filter instance given its name as a string.

Parameters
filterName:String

the name of the filter to retrieve

Returns:Filter

the filter that matches the name

Exceptions
IOException:
if the filter name was invalid
getFilterback to summary
public Filter getFilter(COSName filterName) throws IOException

Returns a filter instance given its COSName.

Parameters
filterName:COSName

the name of the filter to retrieve

Returns:Filter

the filter that matches the name

Exceptions
IOException:
if the filter name was invalid