Package org.apache.pdfbox.filter
Class DecodeResult
- java.lang.Object
-
- org.apache.pdfbox.filter.DecodeResult
-
public final class DecodeResult extends java.lang.ObjectThe 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.
-
-
Field Summary
Fields Modifier and Type Field Description private PDJPXColorSpacecolorSpaceprivate COSDictionaryparametersprivate java.awt.image.BufferedImagesmask
-
Constructor Summary
Constructors Constructor Description DecodeResult(COSDictionary parameters)DecodeResult(COSDictionary parameters, PDJPXColorSpace colorSpace)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DecodeResultcreateDefault()Return a default DecodeResult.PDJPXColorSpacegetJPXColorSpace()Returns the embedded JPX color space, if any.java.awt.image.BufferedImagegetJPXSMask()COSDictionarygetParameters()Returns the stream parameters, repaired using the embedded stream data.(package private) voidsetColorSpace(PDJPXColorSpace colorSpace)(package private) voidsetJPXSMask(java.awt.image.BufferedImage smask)
-
-
-
Field Detail
-
parameters
private final COSDictionary parameters
-
colorSpace
private PDJPXColorSpace colorSpace
-
smask
private java.awt.image.BufferedImage smask
-
-
Constructor Detail
-
DecodeResult
DecodeResult(COSDictionary parameters)
-
DecodeResult
DecodeResult(COSDictionary parameters, PDJPXColorSpace colorSpace)
-
-
Method Detail
-
createDefault
public static DecodeResult createDefault()
Return a default DecodeResult.- Returns:
- a default instance of DecodeResult
-
getParameters
public COSDictionary getParameters()
Returns the stream parameters, repaired using the embedded stream data.- Returns:
- the repaired stream parameters, or an empty dictionary
-
getJPXColorSpace
public PDJPXColorSpace getJPXColorSpace()
Returns the embedded JPX color space, if any.- Returns:
- the embedded JPX color space, or null if there is none.
-
setColorSpace
void setColorSpace(PDJPXColorSpace colorSpace)
-
setJPXSMask
void setJPXSMask(java.awt.image.BufferedImage smask)
-
getJPXSMask
public java.awt.image.BufferedImage getJPXSMask()
-
-