Package org.apache.pdfbox.filter
Class DecodeResult
- java.lang.Object
-
- org.apache.pdfbox.filter.DecodeResult
-
public final class DecodeResult extends java.lang.Object
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.
-
-
Field Summary
Fields Modifier and Type Field Description private PDJPXColorSpace
colorSpace
static DecodeResult
DEFAULT
Default decode result.private COSDictionary
parameters
-
Constructor Summary
Constructors Constructor Description DecodeResult(COSDictionary parameters)
DecodeResult(COSDictionary parameters, PDJPXColorSpace colorSpace)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PDJPXColorSpace
getJPXColorSpace()
Returns the embedded JPX color space, if any.COSDictionary
getParameters()
Returns the stream parameters, repaired using the embedded stream data.(package private) void
setColorSpace(PDJPXColorSpace colorSpace)
-
-
-
Field Detail
-
DEFAULT
public static final DecodeResult DEFAULT
Default decode result.
-
parameters
private final COSDictionary parameters
-
colorSpace
private PDJPXColorSpace colorSpace
-
-
Constructor Detail
-
DecodeResult
DecodeResult(COSDictionary parameters)
-
DecodeResult
DecodeResult(COSDictionary parameters, PDJPXColorSpace colorSpace)
-
-
Method Detail
-
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)
-
-