|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.media.jai.OperationDescriptorImpl
javax.media.jai.operator.FileLoadDescriptor
public class FileLoadDescriptor
An OperationDescriptor
describing the "FileLoad" operation.
In the default instance the validateParameters()
method
checks that the named file exists and is readable. If not, it will return
false
, causing JAI.createNS()
to throw an
IllegalArgumentException
.
In special cases like when an image is loaded from a Remote system,
the above check for existence of a file on the local system could be bypassed.
This is done by setting the Boolean
variable checkFileLocally
to FALSE
in the ParameterBlock
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.
Name | Value |
---|---|
GlobalName | fileload |
LocalName | fileload |
Vendor | com.sun.media.jai |
Description | Reads an image from a file. |
DocURL | http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/FileLoadDescriptor.html |
Version | 1.0 |
arg0Desc | The path of the file to read from. |
arg1Desc | The ImageDecodeParam to use. |
arg2Desc | Boolean specifying if File existence should be checked locally. |
Name | Class Type | Default Value |
---|---|---|
filename | java.lang.String | NO_PARAMETER_DEFAULT |
param | com.sun.media.jai.codec.ImageDecodeParam | null |
checkFileLocally | java.lang.Boolean | TRUE |
OperationDescriptor
,
Serialized FormField Summary |
---|
Fields inherited from class javax.media.jai.OperationDescriptorImpl |
---|
sourceNames, supportedModes |
Fields inherited from interface javax.media.jai.OperationDescriptor |
---|
NO_PARAMETER_DEFAULT |
Constructor Summary | |
---|---|
FileLoadDescriptor()
Constructor. |
Method Summary | |
---|---|
static RenderedOp |
create(String filename,
ImageDecodeParam param,
Boolean checkFileLocally,
RenderingHints hints)
Reads an image from a file. |
protected boolean |
validateParameters(ParameterBlock args,
StringBuffer msg)
Validates the input parameters. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileLoadDescriptor()
Method Detail |
---|
protected boolean validateParameters(ParameterBlock args, StringBuffer msg)
In addition to the standard checks performed by the
superclass method, this method by default checks that the source file
exists and is readable. This check may be bypassed by setting the
checkFileLocally
parameter to FALSE
validateParameters
in class OperationDescriptorImpl
OperationDescriptorImpl.validateParameters(java.lang.String, java.awt.image.renderable.ParameterBlock, java.lang.StringBuffer)
public static RenderedOp create(String filename, ImageDecodeParam param, Boolean checkFileLocally, RenderingHints hints)
Creates a ParameterBlockJAI
from all
supplied arguments except hints
and invokes
JAI.create(String,ParameterBlock,RenderingHints)
.
filename
- The path of the file to read from.param
- The ImageDecodeParam to use.
May be null
.checkFileLocally
- Boolean specifying if File existence should be checked locally
May be null
.hints
- The RenderingHints
to use.
May be null
.
RenderedOp
destination.
IllegalArgumentException
- if filename
is null
.JAI
,
ParameterBlockJAI
,
RenderedOp
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |