Package org.apache.pdfbox.filter

Class FilterManager

  • public class FilterManager
extends java.lang.Object
    This will contain manage all the different types of filters that are available.
    Version:
    $Revision: 1.13 $
    Author:
    Ben Litchfield

    • Constructor Summary

      Constructors 
      Constructor Description
      FilterManager()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addFilter​(COSName filterName, Filter filter)
      This will add an available filter.
      Filter getFilter​(java.lang.String filterName)
      This will get a filter by name.
      Filter getFilter​(COSName filterName)
      This will get a filter by name.
      java.util.Collection<Filter> getFilters()
      This will get all of the filters that are available in the system.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FilterManager

        public FilterManager()
        Constructor.

    • Method Detail

      • getFilters

        public java.util.Collection<Filter> getFilters()
        This will get all of the filters that are available in the system.
        Returns:
        All available filters in the system.

      • addFilter

        public void addFilter​(COSName filterName,
                      Filter filter)
        This will add an available filter.
        Parameters:
        filterName - The name of the filter.
        filter - The filter to use.

      • getFilter

        public Filter getFilter​(COSName filterName)
                 throws java.io.IOException
        This will get a filter by name.
        Parameters:
        filterName - The name of the filter to retrieve.
        Returns:
        The filter that matches the name.
        Throws:
        java.io.IOException - If the filter could not be found.

      • getFilter

        public Filter getFilter​(java.lang.String filterName)
                 throws java.io.IOException
        This will get a filter by name.
        Parameters:
        filterName - The name of the filter to retrieve.
        Returns:
        The filter that matches the name.
        Throws:
        java.io.IOException - If the filter could not be found.