| java.lang.Object
 javax.media.jai.ParameterListImpl
javax.media.jai.tilecodec.TileCodecParameterList
| TileCodecParameterList | | public class TileCodecParameterList extends ParameterListImpl (Code) | | A subclass of ParameterListImpl that is specific to
tile codecs. This class functions in either one or both of the two
registry modes supported by the TileCodecDescriptor
- "tileEncoder" and "tileDecoder".
This class is not intended to be subclassed for each individual
TileEncoder or TileDecoder. This is a generic
class which can be used as is for representing a parameter list for
any tile encoding/decoding format. The ParameterListDescriptor
provided as argument to the constructor should be the one returned from
the getParameterListDescriptor() method of the
TileCodecDescriptor for the given format name.
If the associated TileCodecDescriptor's
includesSampleModelInfo() method returns false, then for the
"tileDecoder" mode, this class will be expected to contain a parameter
named "sampleModel" with a non-null SampleModel as its value.
since:
JAI 1.1 |
| Method Summary | |
| public String | getFormatName()
Returns the name of the format which this parameter list describes. | | public String[] | getValidModes()
Returns all the modes that this TileCodecParameterList
is valid for, as a String array. | | public boolean | isValidForMode(String registryModeName)
Returns true if the parameters in this
TileCodecParameterList are valid for the specified
registry mode name, false otherwise. |
| TileCodecParameterList | | public TileCodecParameterList(String formatName, String validModes, ParameterListDescriptor descriptor)(Code) | | Creates a TileCodecParameterList. The
validModes argument specifies the registry modes valid
for this TileCodecParameterList. This should contain
the "tileEncoder" registry mode or the "tileDecoder" registry
mode or both. The supplied descriptor object specifies the names
and number of the valid parameters, their Class types,
as well as the Range of valid values for each parameter.
Parameters:
formatName - The name of the format, parameters for which arespecified through this parameter list.
Parameters:
validModes - An array of String objects specifyingwhich registry modes are valid for this parameter list.
Parameters:
descriptor - The ParameterListDescriptor object thatdescribes all valid parameters for this format. Thismust be the the same descriptor that is returned fromthe getParameterListDescriptor() method ofthe TileCodecDescriptor for the givenformatName.
throws:
IllegalArgumentException - if formatName is null.
throws:
IllegalArgumentException - if validModes is null.
throws:
IllegalArgumentException - if descriptor is null. |
| getFormatName | | public String getFormatName()(Code) | | Returns the name of the format which this parameter list describes.
|
| getValidModes | | public String[] getValidModes()(Code) | | Returns all the modes that this TileCodecParameterList
is valid for, as a String array.
|
| isValidForMode | | public boolean isValidForMode(String registryModeName)(Code) | | Returns true if the parameters in this
TileCodecParameterList are valid for the specified
registry mode name, false otherwise. The valid modes for
this class are the "tileEncoder" registry mode, and the
"tileDecoder" registry mode.
|
|
|