| javax.media.jai.RegistryElementDescriptor
| RegistryElementDescriptor | | public interface RegistryElementDescriptor (Code) | | An interface for all JAI descriptors that register themselves
with the OperationRegistry. Examples include
OperationDescriptor, TileCodecDescriptor,
RemoteDescriptor etc.
See Also: OperationRegistry
See Also: RegistryMode
since:
JAI 1.1 |
| Method Summary | |
| boolean | arePropertiesSupported()
Whether this descriptor supports JAI properties.
true, if the implementation of this descriptorsupports JAI properties. | | String | getName()
The name this descriptor will be registered under in the
OperationRegistry. | | ParameterListDescriptor | getParameterListDescriptor(String modeName)
Returns the ParameterListDescriptor that describes
the associated parameters (not sources). | | PropertyGenerator[] | getPropertyGenerators(String modeName)
Returns an array of PropertyGenerators implementing
the property inheritance for this descriptor. | | String[] | getSupportedModes()
The registry modes supported by this descriptor. | | boolean | isModeSupported(String modeName)
Whether this descriptor supports the specified registry mode.
The modeNames are to be treated in a case-insensitive
(but retentive) manner.
Parameters:
modeName - the registry mode name true, if the implementation of this descriptor supportsthe specified mode. |
| arePropertiesSupported | | boolean arePropertiesSupported()(Code) | | Whether this descriptor supports JAI properties.
true, if the implementation of this descriptorsupports JAI properties. false otherwise.
See Also: PropertyGenerator |
| getName | | String getName()(Code) | | The name this descriptor will be registered under in the
OperationRegistry. Individual descriptors
implementing this interface will define what this name means
in their space. For example this would be "operation name" for
OperationDescriptor and "format name" for
TileCodecDescriptor etc. The descriptor
names are to be treated in a case-insensitive (but retentive) manner.
|
| getParameterListDescriptor | | ParameterListDescriptor getParameterListDescriptor(String modeName)(Code) | | Returns the ParameterListDescriptor that describes
the associated parameters (not sources). This method returns
null if the specified modeName does not support parameters.
If the specified modeName supports parameters but the
implementing class does not have parameters, then this method
returns a non-null ParameterListDescriptor whose
getNumParameters() returns 0.
Parameters:
modeName - the registry mode name.
throws:
IllegalArgumentException - if modeName is nullor if it is not one of the supported modes. |
| getPropertyGenerators | | PropertyGenerator[] getPropertyGenerators(String modeName)(Code) | | Returns an array of PropertyGenerators implementing
the property inheritance for this descriptor. They may be used
as a basis for the descriptor's property management.
Parameters:
modeName - the registry mode name An array of PropertyGenerators, ornull if this operation does not have any ofits own PropertyGenerators.
throws:
IllegalArgumentException - if modeName is nullor if it is not one of the supported modes.
throws:
UnsupportedOperationException - if arePropertiesSupported()returns false |
| getSupportedModes | | String[] getSupportedModes()(Code) | | The registry modes supported by this descriptor. Known modes
include those returned by RegistryMode.getModes().
an array of Strings specifying the supported modes.
See Also: RegistryMode |
| isModeSupported | | boolean isModeSupported(String modeName)(Code) | | Whether this descriptor supports the specified registry mode.
The modeNames are to be treated in a case-insensitive
(but retentive) manner.
Parameters:
modeName - the registry mode name true, if the implementation of this descriptor supportsthe specified mode. false otherwise.
throws:
IllegalArgumentException - if modeName is null |
|
|