Package com.adobe.internal.pdftoolkit.core.filter

Class CustomFilterRegistry

  • public class CustomFilterRegistry
extends java.lang.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 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 java.util.Collection<CustomEncodeFilter> getEncodeFilters()
        Returns the list of all registered encode filters
        Returns:
        Collection of encode filters

      • getDecodeFilters

        public java.util.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 java.io.OutputStream encode​(ASName filterName,
                                   java.io.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 java.util.List getRegisteredFilters()
        Returns list of all the registered filters
        Returns:
        list of registered filters

      • getDefaultDecodeFilters

        public static java.util.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 java.util.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