| java.lang.Object
 javax.media.jai.OperationDescriptorImpl
javax.media.jai.operator.FileStoreDescriptor
| FileStoreDescriptor | | public class FileStoreDescriptor extends OperationDescriptorImpl (Code) | | An OperationDescriptor describing the "FileStore" operation.
The "FileStore" operation writes an image to a given file in a specified
format using the supplied encoding parameters.
In the default instance the validateParameters() method
checks for the named file to be writable if it already exists, else that
it can be created. If not, it will return false, causing
JAI.createNS() to throw an
IllegalArgumentException.
In special cases such as an image being written to a remote system,
the above check for existence of a file on the local system should be
bypassed. This can be accomplished by setting the Boolean
variable checkFileLocally to FALSE in the
ParameterBlock.
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 requested file path must be writable.
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 | filestore |
| LocalName | filestore |
| Vendor | com.sun.media.jai |
| Description | Stores an image to a file. |
| DocURL | http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/FileStoreDescriptor.html |
| Version | 1.0 |
| arg0Desc | The path of the file to write to. |
| arg1Desc | The format of the file. |
| arg2Desc | The encoding parameters. |
| arg3Desc | Boolean specifying whether check for file creation / writing locally should be done. |
Parameter List
| Name | Class Type |
Default Value |
|---|
| filename | java.lang.String |
NO_PARAMETER_DEFAULT |
| format | java.lang.String |
"tiff" |
| param | com.sun.media.jai.codec.ImageEncodeParam |
null |
| checkFileLocally | java.lang.Boolean |
TRUE |
See Also: javax.media.jai.OperationDescriptor |
| FileStoreDescriptor | | public FileStoreDescriptor()(Code) | | Constructor.
|
| validateArguments | | public boolean validateArguments(String modeName, ParameterBlock args, StringBuffer msg)(Code) | | 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,
ans that the output file path "filename" is writable.
|
| Methods inherited from javax.media.jai.OperationDescriptorImpl | public boolean arePropertiesSupported()(Code)(Java Doc)
protected static Class getDefaultSourceClass(String modeName)(Code)(Java Doc)
public Class getDestClass(String modeName)(Code)(Java Doc)
public Class getDestClass()(Code)(Java Doc)
public Object getInvalidRegion(String modeName, ParameterBlock oldParamBlock, RenderingHints oldHints, ParameterBlock newParamBlock, RenderingHints newHints, OperationNode node)(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public int getNumParameters()(Code)(Java Doc)
public int getNumSources()(Code)(Java Doc)
public Class[] getParamClasses()(Code)(Java Doc)
public Object getParamDefaultValue(int index)(Code)(Java Doc)
public Object[] getParamDefaults()(Code)(Java Doc)
public Number getParamMaxValue(int index)(Code)(Java Doc)
public Number getParamMinValue(int index)(Code)(Java Doc)
public String[] getParamNames()(Code)(Java Doc)
public ParameterListDescriptor getParameterListDescriptor(String modeName)(Code)(Java Doc)
public PropertyGenerator[] getPropertyGenerators(String modeName)(Code)(Java Doc)
public PropertyGenerator[] getPropertyGenerators()(Code)(Java Doc)
public Class getRenderableDestClass()(Code)(Java Doc)
public Class[] getRenderableSourceClasses()(Code)(Java Doc)
public ResourceBundle getResourceBundle(Locale locale)(Code)(Java Doc)
public String[][] getResources(Locale locale)(Code)(Java Doc)
public Class[] getSourceClasses(String modeName)(Code)(Java Doc)
public Class[] getSourceClasses()(Code)(Java Doc)
public String[] getSourceNames()(Code)(Java Doc)
public String[] getSupportedModes()(Code)(Java Doc)
public boolean isImmediate()(Code)(Java Doc)
public boolean isModeSupported(String modeName)(Code)(Java Doc)
public boolean isRenderableSupported()(Code)(Java Doc)
public boolean isRenderedSupported()(Code)(Java Doc)
protected static Class[][] makeDefaultSourceClassList(String[] supportedModes, int numSources)(Code)(Java Doc)
public boolean validateArguments(String modeName, ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
public boolean validateArguments(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateParameters(String modeName, ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateParameters(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
public boolean validateRenderableArguments(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateRenderableSources(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateSources(String modeName, ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
protected boolean validateSources(ParameterBlock args, StringBuffer msg)(Code)(Java Doc)
|
|
|