|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.media.jai.EnumeratedParameter
This class provides a mechanism by which enumerated parameters may be
added to subclasses of OperationDescriptorImpl
while
retaining the ability to perform introspection on the allowable range of
values of the enumeration. An example of an enumerated parameter is the
type parameter of the "Transpose" operation which is defined in
TransposeDescriptor
to accept only the values defined by the
FLIP_*
and ROTATE_*
fields of the descriptor.
This class may be used to create enumerated parameters in an
OperationDescriptor
as follows:
EnumeratedParameter
. This class should consist of only a
package private constructor with a single String
parameter
called name and a single statement invoking the superclass
constructor with name as the parameter.EnumeratedParameter
which was created for it in
in the previous step.OperationDescriptor
of the operator a public static final
field of type equal to the class defined in the first step. Each field
should be assigned an instance of the subclass defined in the first step.
The name and value
used for each of these
EnumeratedParameter
subclass instances should be distinct
for each distinct field or an error will occur.TransposeDescriptor
, the three steps above
would be to 1) create a final class TransposeType
in the
javax.media.jai.operator
package; 2) define the
type of the "type" parameter as TransposeType.class
; and
3) define a static final field of class TransposeType
for
each of the enumerated values with each field being initialized to an
instance of TransposeType
with name equal to the name
of the field and value to its integral (enumerated) value.
OperationDescriptorImpl
,
TransposeDescriptor
, Serialized FormConstructor Summary | |
EnumeratedParameter(String name,
int value)
Constructs an EnumeratedParameter with the indicated name
and value. |
Method Summary | |
boolean |
equals(Object o)
Returns true if and only if the parameter is an instance
of the class on which this method is invoked and has either the same
name or the same value. |
String |
getName()
Returns the name assigned to this EnumeratedParameter
when it was constructed. |
int |
getValue()
Returns the value assigned to this EnumeratedParameter
when it was constructed. |
int |
hashCode()
Returns a hash code value for the object. |
String |
toString()
Returns a String representation of this
EnumeratedParameter as a concatentation of the form
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public EnumeratedParameter(String name, int value)
EnumeratedParameter
with the indicated name
and value.Method Detail |
public String getName()
EnumeratedParameter
when it was constructed.public int getValue()
EnumeratedParameter
when it was constructed.public int hashCode()
hashCode
in class Object
public boolean equals(Object o)
true
if and only if the parameter is an instance
of the class on which this method is invoked and has either the same
name or the same value.equals
in class Object
public String toString()
String
representation of this
EnumeratedParameter
as a concatentation of the form
[class name]:[parameter name]=[parameter value]For example, for an instance of a subclass
org.foobar.jai.EnumParam
with name "SomeValue" and
value "2" the returned String
would be
org.foobar.jai.EnumParam:SomeValue=2
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |