com.adobe.internal.pdftoolkit.core.filter.spi

Interface CustomEncodeFilter

All Superinterfaces:

CustomFilter

public interface CustomEncodeFilter
extends CustomFilter

Declares the functionality needed for creating a custom encode filter.

Method Summary

Modifier and Type	Method and Description
OutputStream	encode(OutputStream dstStm, FilterParams filterParams) This method returns an output stream which is responsible for encoding all the bytes written to that stream in the future and also write those encoded bytes on the output stream passed here.
FilterParams	updateFilterParams(FilterParams fParams) Updates the filterParams based on capability of the custom encode filter

Methods inherited from interface com.adobe.internal.pdftoolkit.core.filter.spi.CustomFilter

getName

Method Detail

encode

OutputStream encode(OutputStream dstStm,
                    FilterParams filterParams)
             throws CustomFilterException

This method returns an output stream which is responsible for encoding all the bytes written to that stream in the future and also write those encoded bytes on the output stream passed here. All the parameters required while encoding are present in filterParams object.

Parameters:

dstStm -

filterParams -

Returns:

encoded bytes in an output stream.

Throws:

CustomFilterException

updateFilterParams

FilterParams updateFilterParams(FilterParams fParams)

Updates the filterParams based on capability of the custom encode filter

Parameters:

fParams -

Returns:

upadated FilterParams