javax.media.jai.operator
Class EncodeDescriptor
java.lang.Object
|
+--javax.media.jai.OperationDescriptorImpl
|
+--javax.media.jai.operator.EncodeDescriptor
- All Implemented Interfaces:
- OperationDescriptor, RegistryElementDescriptor, Serializable
- public class EncodeDescriptor
- extends OperationDescriptorImpl
An OperationDescriptor describing the "Encode" operation.
The "Encode" operation writes an image to a given OutputStream
in a specified format using the supplied encoding parameters.
The third parameter contains an instance of
ImageEncodeParam to be used during the decoding. It
may be set to null in order to perform default
encoding, or equivalently may be omitted. If
non-null, it must be of the correct class type for the
selected format.
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 | encode |
| LocalName | encode |
| Vendor | com.sun.media.jai |
| Description | Stores an image to an OutputStream. |
| DocURL | http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/EncodeDescriptor.html |
| Version | 1.0 |
| arg0Desc | The OutputStream to write to. |
| arg1Desc | The format of the created file. |
| arg2Desc | The encoding parameters. |
Parameter List
| Name | Class Type |
Default Value |
|---|
| stream | java.io.OutputStream |
NO_PARAMETER_DEFAULT |
| format | java.lang.String |
"tiff" |
| param | com.sun.media.jai.codec.ImageEncodeParam |
null |
- See Also:
OperationDescriptor, Serialized Form
| 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,
isModeSupported,
isRenderableSupported,
isRenderedSupported,
makeDefaultSourceClassList,
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 |
EncodeDescriptor
public EncodeDescriptor()
- Constructor.
validateArguments
public boolean validateArguments(String modeName,
ParameterBlock args,
StringBuffer msg)
- Validates the input source and parameters.
In addition to the standard checks performed by the
superclass method, this method checks that the format name is
recognized and is capable of encoding the source image using
the encoding parameter "param", if non-null.
- Overrides:
- validateArguments in class OperationDescriptorImpl
- Tags copied from class: OperationDescriptorImpl
- Parameters:
modeName - the operation mode nameargs - Input arguments, including source(s) and/or parameter(s).msg - A string that may contain error messages.- Throws:
- IllegalArgumentException - if
modeName is null - See Also:
OperationDescriptorImpl.validateSources(java.lang.String, java.awt.image.renderable.ParameterBlock, java.lang.StringBuffer),
OperationDescriptorImpl.validateParameters(java.lang.String, java.awt.image.renderable.ParameterBlock, java.lang.StringBuffer)
isImmediate
public boolean isImmediate()
- Returns true indicating that the operation should be rendered
immediately during a call to
JAI.create().
- Overrides:
- isImmediate in class OperationDescriptorImpl
- See Also:
OperationDescriptor