public final Class DecodeResult

Class Inheritance

extends Object

java.lang.Object
org.apache.pdfbox.filter.DecodeResult

Imports

java.awt.image.BufferedImage, org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace

The result of a filter decode operation. Allows information such as color space to be extracted from image streams, and for stream parameters to be repaired during reading.

Author: John Hewson

Field Summary

Modifier and Type	Field and Description
private PDJPXColorSpace	colorSpace
private final COSDictionary	parameters
private BufferedImage	smask

Constructor Summary

Access	Constructor and Description
pack-priv	DecodeResult(COSDictionary parameters)
pack-priv	DecodeResult(COSDictionary parameters, PDJPXColorSpace colorSpace)

Method Summary

Modifier and Type	Method and Description
public static DecodeResult	Returns: a default instance of DecodeResult createDefault() Return a default DecodeResult.
public PDJPXColorSpace	Returns: the embedded JPX color space, or null if there is none. getJPXColorSpace() Returns the embedded JPX color space, if any.
public BufferedImage	getJPXSMask()
public COSDictionary	Returns: the repaired stream parameters, or an empty dictionary getParameters() Returns the stream parameters, repaired using the embedded stream data.
pack-priv void	setColorSpace(PDJPXColorSpace colorSpace)
pack-priv void	setJPXSMask(BufferedImage smask)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

colorSpace	back to summary
private PDJPXColorSpace colorSpace

parameters	back to summary
private final COSDictionary parameters

smask	back to summary
private BufferedImage smask

Constructor Detail

DecodeResult	back to summary
pack-priv DecodeResult(COSDictionary parameters)

DecodeResult	back to summary
pack-priv DecodeResult(COSDictionary parameters, PDJPXColorSpace colorSpace)

Method Detail

createDefault	back to summary
public static DecodeResult createDefault() Return a default DecodeResult. Returns:DecodeResult a default instance of DecodeResult

createDefault

back to summary

public static DecodeResult createDefault()

Return a default DecodeResult.

Returns:DecodeResult: a default instance of DecodeResult

getJPXColorSpace	back to summary
public PDJPXColorSpace getJPXColorSpace() Returns the embedded JPX color space, if any. Returns:PDJPXColorSpace the embedded JPX color space, or null if there is none.

getJPXColorSpace

back to summary

public PDJPXColorSpace getJPXColorSpace()

Returns the embedded JPX color space, if any.

Returns:PDJPXColorSpace: the embedded JPX color space, or null if there is none.

getJPXSMask	back to summary
public BufferedImage getJPXSMask()

getParameters	back to summary
public COSDictionary getParameters() Returns the stream parameters, repaired using the embedded stream data. Returns:COSDictionary the repaired stream parameters, or an empty dictionary

getParameters

back to summary

public COSDictionary getParameters()

Returns the stream parameters, repaired using the embedded stream data.

Returns:COSDictionary: the repaired stream parameters, or an empty dictionary

setColorSpace	back to summary
pack-priv void setColorSpace(PDJPXColorSpace colorSpace)

setJPXSMask	back to summary
pack-priv void setJPXSMask(BufferedImage smask)