com.sun.media.jai.codec
Class JPEGDecodeParam

java.lang.Object
  |
  +--com.sun.media.jai.codec.JPEGDecodeParam
All Implemented Interfaces:
Cloneable, ImageDecodeParam, Serializable

public class JPEGDecodeParam
extends Object
implements ImageDecodeParam

An instance of ImageDecodeParam for decoding images in the JPEG format.

This class allows for the specification of whether to decode the JPEG data into an image having a SampleModel which is a ComponentSampleModel or a subclass thereof. By default data are decoded into an image having a ComponentSampleModel.

This class is not a committed part of the JAI API. It may be removed or changed in future releases of JAI.

See Also:
Serialized Form

Constructor Summary
JPEGDecodeParam()
          Constructs a JPEGDecodeParam object with default parameter values.
 
Method Summary
 boolean getDecodeToCSM()
          Returns the value of the ComponentSampleModel flag which is by default true.
 void setDecodeToCSM(boolean decodeToCSM)
          Sets the data formatting flag to the value of the supplied parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JPEGDecodeParam

public JPEGDecodeParam()
Constructs a JPEGDecodeParam object with default parameter values.
Method Detail

setDecodeToCSM

public void setDecodeToCSM(boolean decodeToCSM)
Sets the data formatting flag to the value of the supplied parameter. If true the data will be decoded into an image which has a SampleModel which is a ComponentSampleModel. The default setting of this flag is true. If the flag is set to false then memory may be saved during decoding but the resulting image is not in that case guaranteed to have a ComponentSampleModel.
Parameters:
decodeToCSM - true if a ComponentSampleModel layout is preferred for the decoded image.

getDecodeToCSM

public boolean getDecodeToCSM()
Returns the value of the ComponentSampleModel flag which is by default true.