|
| |
|
| java.lang.Object
 java.awt.image.renderable.ParameterBlock
javax.media.jai.ParameterBlockJAI
| ParameterBlockJAI | | public class ParameterBlockJAI extends ParameterBlock implements ParameterList(Code) | | A convenience subclass of ParameterBlock that
allows the use of default parameter values and getting/setting
sources and parameters by name. A ParameterBlockJAI is
constructed using either an OperationDescriptor,
or an operation name (that will be looked up in the appropriate
default OperationRegistry) and a mode which should
be in OperationDescriptor.getSupportedModes() (such
as rendered, renderable, collection or renderableCollection). If
the mode is not specified ParameterBlockJAI will by
default work with the first mode in the array of Strings
returned by OperationDescriptor.getSupportedModes().
Once constructed, a ParameterBlockJAI appears to
have no sources. It contains all the parameters required by its
OperationDescriptor for a specified mode, each having
its default value as given by the OperationDescriptor.
Such a ParameterBlockJAI may not yet be usable, its
sources (if any) are not set, and some or all of its parameters may
have inapproriate values. The addSource methods of
ParameterBlock may be used to initialize the source values,
and the set(value, index) methods may be used to modify
new parameter values. The preferred way of setting parameter values
is the setParameter(name, value) described below. The
add() methods should not be used since the parameter
list is already long enough to hold all of the parameters required by
the OperationDescriptor.
Additionally, ParameterBlockJAI offers
setParameter(name, value) methods that take a
parameter name; the index of the parameter is determined from the
OperationDescriptor and the corresponding parameter
is set. (users are strongly recommended to use this method
instead of the equivalent set(value, index) or
the deprecated set(value, name) methods). As in
ParameterBlock, all parameters are stored internally
as subclasses of Object and all get/set methods that take or return
values of primitive types are simply convenience methods that transform
values between the primitive types and their corresponding wrapper
classes.
The OperationDescriptor that is used to initialize
a ParameterBlockJAI at construction is not
serializable and thus cannot be serialized using the default
serialization mechanism. The operation name is serialized instead and
included in the serialized ParameterBlockJAI stream.
During de-serialization, the operation name is de-serialized and then
looked up in the default OperationRegistry available at
the time of de-serialization. If no OperationDescriptor
has been registered with this OperationRegistry
under the given operation name, a NotSerializableException will
be thrown. The serialization of ParameterBlockJAI
works correctly only if the OperationDescriptor
registered for the operation name in question is identical to the
OperationDescriptor that was registered with the
OperationRegistry available at serialization time.
All parameter names are treated in a case-insensitive but
retentive manner.
Warning: Serialized objects of this class will
not be compatible with future releases. The current serialization
support is appropriate for short term storage or RMI between
applications running the same version of JAI. A future release of JAI
will provide support for long term persistence.
|
| Method Summary | |
| public ParameterBlock | add(Object obj)
Adds an object to the list of parameters. | | public Object | clone()
Creates a copy of a ParameterBlockJAI. | | public boolean | getBooleanParameter(String paramName)
A convenience method to return a parameter as a boolean. | | public byte | getByteParameter(String paramName)
A convenience method to return a parameter as a byte. | | public char | getCharParameter(String paramName)
A convenience method to return a parameter as a char. | | public double | getDoubleParameter(String paramName)
A convenience method to return a parameter as a double. | | public float | getFloatParameter(String paramName)
A convenience method to return a parameter as a float. | | public int | getIntParameter(String paramName)
A convenience method to return a parameter as an int. | | public long | getLongParameter(String paramName)
A convenience method to return a parameter as a long. | | public String | getMode()
Get the operation mode used to determine parameter names,
classes and default values. | | public Object | getObjectParameter(String paramName)
Gets a named parameter as an Object. | | public OperationDescriptor | getOperationDescriptor()
Returns the OperationDescriptor associated with this
ParameterBlockJAI. | | public Class[] | getParamClasses()
Returns an array of Class objects describing the types
of the parameters. | | public ParameterListDescriptor | getParameterListDescriptor()
Returns the ParameterListDescriptor that provides
descriptions of the parameters associated with the operator
and mode. | | public short | getShortParameter(String paramName)
A convenience method to return a parameter as an short. | | public int | indexOf(String paramName)
Returns the zero-relative index of a named parameter within the list of
parameters. | | public int | indexOfParam(String paramName)
Returns the zero-relative index of a named parameter within the list of
parameters. | | public int | indexOfSource(String sourceName)
Returns the zero-relative index of a named source within the list of
sources. | | public ParameterBlock | set(Object obj, int index)
Replaces an Object in the list of parameters. | | public ParameterBlock | set(byte b, String paramName)
Sets a named parameter to a byte value. | | public ParameterBlock | set(char c, String paramName)
Sets a named parameter to a char value.
Parameters:
paramName - a String naming a parameter.
Parameters:
c - a char value for the parameter. | | public ParameterBlock | set(short s, String paramName)
Sets a named parameter to a short value.
Parameters:
paramName - a String naming a parameter.
Parameters:
s - a short value for the parameter. | | public ParameterBlock | set(int i, String paramName)
Sets a named parameter to an int value.
Parameters:
paramName - a String naming a parameter.
Parameters:
i - an int value for the parameter. | | public ParameterBlock | set(long l, String paramName)
Sets a named parameter to a long value.
Parameters:
paramName - a String naming a parameter.
Parameters:
l - a long value for the parameter. | | public ParameterBlock | set(float f, String paramName)
Sets a named parameter to a float value.
Parameters:
paramName - a String naming a parameter.
Parameters:
f - a float value for the parameter. | | public ParameterBlock | set(double d, String paramName)
Sets a named parameter to a double value.
Parameters:
paramName - a String naming a parameter.
Parameters:
d - a double value for the parameter. | | public ParameterBlock | set(Object obj, String paramName)
Sets a named parameter to an Object value. | | public ParameterList | setParameter(String paramName, byte b)
Sets a named parameter to a byte value. | | public ParameterList | setParameter(String paramName, boolean b)
Sets a named parameter to a boolean value. | | public ParameterList | setParameter(String paramName, char c)
Sets a named parameter to a char value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
c - a char value for the parameter. | | public ParameterList | setParameter(String paramName, short s)
Sets a named parameter to a short value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
s - a short value for the parameter. | | public ParameterList | setParameter(String paramName, int i)
Sets a named parameter to an int value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
i - an int value for the parameter. | | public ParameterList | setParameter(String paramName, long l)
Sets a named parameter to a long value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
l - a long value for the parameter. | | public ParameterList | setParameter(String paramName, float f)
Sets a named parameter to a float value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
f - a float value for the parameter. | | public ParameterList | setParameter(String paramName, double d)
Sets a named parameter to a double value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
d - a double value for the parameter. | | public ParameterList | setParameter(String paramName, Object obj)
Sets a named parameter to an Object value. | | public void | setParameters(Vector parameters)
Sets the entire Vector of parameters to a given
Vector. | | public ParameterBlockJAI | setSource(String sourceName, Object source)
Sets a named source to a given Object value. |
| ParameterBlockJAI | | public ParameterBlockJAI(OperationDescriptor odesc)(Code) | | Constructs a ParameterBlockJAI for
use with an operation described by a particular
OperationDescriptor. It uses the first
mode in the array of Strings returned by
OperationDescriptor.getSupportedModes()
to get the ParameterListDescriptor from
OperationDescriptor. The default values of the
parameters are filled in.
Parameters:
odesc - the OperationDescriptor describing the parametersto be managed.
throws:
IllegalArgumentException - if odesc is null |
| ParameterBlockJAI | | public ParameterBlockJAI(String operationName)(Code) | | Constructs a ParameterBlockJAI for a particular
operation by name. The OperationRegistry associated
with the default instance of the JAI class is used
to locate the OperationDescriptor associated with
the operation name.
It uses the first mode in the array of Strings
returned by OperationDescriptor.getSupportedModes()
to get the ParameterListDescriptor from
OperationDescriptor. The default values of the
parameters are filled in.
Parameters:
operationName - a String giving the name of the operation.
throws:
IllegalArgumentException - if operationName is null. |
| ParameterBlockJAI | | public ParameterBlockJAI(OperationDescriptor odesc, String modeName)(Code) | | Constructs a ParameterBlockJAI for
use with an operation described by a particular
OperationDescriptor and a registry mode. The default
values of the parameters are filled in.
Parameters:
odesc - the OperationDescriptor describing the parametersto be managed.
Parameters:
modeName - the operation mode whose paramters are to be managed.
throws:
IllegalArgumentException - if modeName is null or odesc is null
since:
JAI 1.1 |
| ParameterBlockJAI | | public ParameterBlockJAI(String operationName, String modeName)(Code) | | Constructs a ParameterBlockJAI for a
particular operation by name and a registry mode. The
OperationRegistry associated with the default
instance of the JAI class is used to locate the
OperationDescriptor associated with the operation
name. The default values of the parameters are filled in.
Parameters:
operationName - a String giving the name of theoperation.
Parameters:
modeName - the operation mode whose paramters are to be managed.
throws:
IllegalArgumentException - if operationName or modeName is null
since:
JAI 1.1 |
| add | | public ParameterBlock add(Object obj)(Code) | | Adds an object to the list of parameters.
This method always throws an IllegalStateException
because the ParameterBlockJAI constructor initializes
all parameters with their default values.
throws:
IllegalStateException - if parameters are added to an already initialized ParameterBlockJAI
since:
JAI 1.1 |
| clone | | public Object clone()(Code) | | Creates a copy of a ParameterBlockJAI. The source
and parameter Vectors are cloned, but the actual sources and
parameters are copied by reference. This allows modifications to
the order and number of sources and parameters in the clone to be
invisible to the original ParameterBlockJAI. Changes
to the shared sources or parameters themselves will still be
visible.
an Object clone of the ParameterBlockJAI.
since:
JAI 1.1 |
| getBooleanParameter | | public boolean getBooleanParameter(String paramName)(Code) | | A convenience method to return a parameter as a boolean. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT
since:
JAI 1.1 |
| getByteParameter | | public byte getByteParameter(String paramName)(Code) | | A convenience method to return a parameter as a byte. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT |
| getCharParameter | | public char getCharParameter(String paramName)(Code) | | A convenience method to return a parameter as a char. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT |
| getDoubleParameter | | public double getDoubleParameter(String paramName)(Code) | | A convenience method to return a parameter as a double. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT |
| getFloatParameter | | public float getFloatParameter(String paramName)(Code) | | A convenience method to return a parameter as a float. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT |
| getIntParameter | | public int getIntParameter(String paramName)(Code) | | A convenience method to return a parameter as an int. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT |
| getLongParameter | | public long getLongParameter(String paramName)(Code) | | A convenience method to return a parameter as a long. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT |
| getMode | | public String getMode()(Code) | | Get the operation mode used to determine parameter names,
classes and default values.
since:
JAI 1.1 |
| getObjectParameter | | public Object getObjectParameter(String paramName)(Code) | | Gets a named parameter as an Object. Parameters belonging to a
primitive type, such as int, will be returned as a
member of the corresponding Number subclass, such as
Integer.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT |
| getOperationDescriptor | | public OperationDescriptor getOperationDescriptor()(Code) | | Returns the OperationDescriptor associated with this
ParameterBlockJAI.
|
| getParamClasses | | public Class[] getParamClasses()(Code) | | Returns an array of Class objects describing the types
of the parameters. This is a more efficient implementation than that
of the superclass as the parameter classes are known a priori.
since:
JAI 1.1 |
| getParameterListDescriptor | | public ParameterListDescriptor getParameterListDescriptor()(Code) | | Returns the ParameterListDescriptor that provides
descriptions of the parameters associated with the operator
and mode.
since:
JAI 1.1 |
| getShortParameter | | public short getShortParameter(String paramName)(Code) | | A convenience method to return a parameter as an short. An
exception will be thrown if the parameter is of a different
type.
Parameters:
paramName - the name of the parameter to be returned.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
ClassCastException - if the parameter is of a different type.
throws:
IllegalStateException - if the parameter value is stillParameterListDescriptor.NO_PARAMETER_DEFAULT
since:
JAI 1.1 |
| indexOf | | public int indexOf(String paramName)(Code) | | Returns the zero-relative index of a named parameter within the list of
parameters.
Parameters:
paramName - a String containing the parameter name.
throws:
IllegalArgumentException - if paramName is null or if there isno parameter with the specified name.
See Also: ParameterBlockJAI.indexOfParam |
| indexOfParam | | public int indexOfParam(String paramName)(Code) | | Returns the zero-relative index of a named parameter within the list of
parameters.
Parameters:
paramName - a String containing the parameter name.
throws:
IllegalArgumentException - if paramName is null or if there isno parameter with the specified name.
since:
JAI 1.1 |
| indexOfSource | | public int indexOfSource(String sourceName)(Code) | | Returns the zero-relative index of a named source within the list of
sources.
Parameters:
sourceName - a String containing the parameter name.
throws:
IllegalArgumentException - if source is null or if there isno source with the specified name.
since:
JAI 1.1 |
| set | | public ParameterBlock set(Object obj, int index)(Code) | | Replaces an Object in the list of parameters.
Parameters:
obj - The new value of the parameter.
Parameters:
index - The zero-relative index of the parameter.
throws:
ArrayIndexOutOfBoundsException - if indexis negative or not less than the number of parametersexpected for the associated operation.
throws:
IllegalArgumentException - if obj isnon-null and not an instance of the classexpected for the indicated parameter or if objis an invalid value for the indicated parameter.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, byte b)(Code) | | Sets a named parameter to a byte value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
b - a byte value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Byte
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, boolean b)(Code) | | Sets a named parameter to a boolean value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
b - a boolean value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Boolean
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, char c)(Code) | | Sets a named parameter to a char value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
c - a char value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Character
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, short s)(Code) | | Sets a named parameter to a short value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
s - a short value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Short
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, int i)(Code) | | Sets a named parameter to an int value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
i - an int value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Integer
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, long l)(Code) | | Sets a named parameter to a long value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
l - a long value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Long
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, float f)(Code) | | Sets a named parameter to a float value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
f - a float value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Float
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, double d)(Code) | | Sets a named parameter to a double value.
Checks are made to verify that the parameter is of the right
Class type and that the value is valid.
Parameters:
paramName - a String naming a parameter.
Parameters:
d - a double value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the class type of parameterpointed to by the paramName is not a Double
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameter | | public ParameterList setParameter(String paramName, Object obj)(Code) | | Sets a named parameter to an Object value. The value
may be null, an instance of the class expected for this
parameter, or a DeferredData instance the
getDataClass() method of which returns the
expected class. If the object is a DeferredData instance,
then its wrapped data value is checked for validity if and only if
its isValid() method returns true. If the
object is not a DeferredData instance, then it is
always checked for validity.
Parameters:
paramName - a String naming a parameter.
Parameters:
obj - an Object value for the parameter.
throws:
IllegalArgumentException - if paramName is null.
throws:
IllegalArgumentException - if there is no parameter with thespecified name.
throws:
IllegalArgumentException - if the parameter value is invalid.
since:
JAI 1.1 |
| setParameters | | public void setParameters(Vector parameters)(Code) | | Sets the entire Vector of parameters to a given
Vector. The Vector is saved by reference.
throws:
IllegalArgumentException - if the size of the suppliedVector does not equal the number of parametersof the associated operation.
throws:
IllegalArgumentException - if a non-null,non-DeferredData value is not an instance ofthe class expected for the indicated parameter or ifobj is an invalid value for the indicatedparameter.
throws:
IllegalArgumentException - if a non-null,DeferredData value does not wrap an instance ofthe class expected for the indicated parameter or if it isvalid but its wrapped value is invalid for the indicatedparameter.
since:
JAI 1.1 |
|
|
|