javax.media.jai.operator
Class StreamDescriptor

java.lang.Object
  extended byjavax.media.jai.OperationDescriptorImpl
      extended byjavax.media.jai.operator.StreamDescriptor
All Implemented Interfaces:
OperationDescriptor, RegistryElementDescriptor, Serializable

public class StreamDescriptor
extends OperationDescriptorImpl

An OperationDescriptor describing the "Stream" operation.

The Stream operation produces an image by decoding data from a SeekableStream. The allowable formats are those registered with the com.sun.media.jai.codec.ImageCodec class.

The allowable formats are those registered with the com.sun.media.jai.codec.ImageCodec class.

The second parameter contains an instance of ImageDecodeParam to be used during the decoding. It may be set to null in order to perform default decoding, or equivalently may be omitted.

The classes in the com.sun.media.jai.codec package are not a committed part of the JAI API. Future releases of JAI will make use of new classes in their place. This class will change accordingly.

Resource List
Name Value
GlobalName stream
LocalName stream
Vendor com.sun.media.jai
Description Reads an image from a SeekableStream.
DocURL http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/StreamDescriptor.html
Version 1.0
arg0Desc The SeekableStream to read from.
arg1Desc The ImageDecodeParam to use.

Parameter List
Name Class Type Default Value
stream com.sun.media.jai.codec.SeekableStream NO_PARAMETER_DEFAULT
param com.sun.media.jai.codec.ImageDecodeParam null

See Also:
OperationDescriptor, Serialized Form

Field Summary
 
Fields inherited from class javax.media.jai.OperationDescriptorImpl
sourceNames, supportedModes
 
Fields inherited from interface javax.media.jai.OperationDescriptor
NO_PARAMETER_DEFAULT
 
Constructor Summary
StreamDescriptor()
          Constructor.
 
Method Summary
static RenderedOp create(SeekableStream stream, ImageDecodeParam param, RenderingHints hints)
          Reads an image from a SeekableStream.
 
Methods inherited from class javax.media.jai.OperationDescriptorImpl
arePropertiesSupported, getDefaultSourceClass, getDestClass, getDestClass, getInvalidRegion, getName, getNumParameters, getNumSources, getParamClasses, getParamDefaults, getParamDefaultValue, getParameterListDescriptor, getParamMaxValue, getParamMinValue, getParamNames, getPropertyGenerators, getPropertyGenerators, getRenderableDestClass, getRenderableSourceClasses, getResourceBundle, getResources, getSourceClasses, getSourceClasses, getSourceNames, getSupportedModes, isImmediate, isModeSupported, isRenderableSupported, isRenderedSupported, makeDefaultSourceClassList, validateArguments, validateArguments, validateParameters, validateParameters, validateRenderableArguments, validateRenderableSources, validateSources, validateSources
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StreamDescriptor

public StreamDescriptor()
Constructor.

Method Detail

create

public static RenderedOp create(SeekableStream stream,
                                ImageDecodeParam param,
                                RenderingHints hints)
Reads an image from a SeekableStream.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.create(String,ParameterBlock,RenderingHints).

Parameters:
stream - The SeekableStream to read from.
param - The ImageDecodeParam to use. May be null.
hints - The RenderingHints to use. May be null.
Returns:
The RenderedOp destination.
Throws:
IllegalArgumentException - if stream is null.
See Also:
JAI, ParameterBlockJAI, RenderedOp