Java Doc for OperationDescriptorImpl.java in  » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » media » jai » Java Source Code / Java DocumentationJava Source Code and Java Documentation

For the sake of backward compatibilty, if a deprecated constructor was used to create this object, then this method simply calls its deprecated equivalent, if the modeName is either "rendered" or "renderable".

The class of the returned object will vary as a function of the mode of the operation.

This method is the standard place where input arguments are validated against this operation's specification for the specified mode.

For the sake of backward compatibilty, if a deprecated constructor was used to create this object, then this method simply calls its deprecated equivalent, if the modeName is either "rendered" or "renderable".
Parameters:
  modeName - the operation mode name
throws:
  IllegalArgumentException - if modeName is nullor if it is not one of the supported modes.
since:
   JAI 1.1

The class of the returned object will vary as a function of the mode of the operation. For rendered and renderable two- dimensional images this will be an instance of a class which implements java.awt.Shape.
Parameters:
  modeName - The name of the mode.
Parameters:
  oldParamBlock - The previous sources and parameters.
Parameters:
  oldHints - The previous hints.
Parameters:
  newParamBlock - The current sources and parameters.
Parameters:
  newHints - The current hints.
Parameters:
  node - The affected node in the processing chain. null to indicate that there is nocommon region of validity.
throws:
  IllegalArgumentException - if modeNameis null or if the operation requires eithersources or parameters and either oldParamBlockor newParamBlock is null.
throws:
  IllegalArgumentException - if oldParamBlock ornewParamBlock do not contain sufficient sourcesor parameters for the operation in question.
since:
   JAI 1.1

The return value should be of the class type corresponding to the parameter's primitive type, that is, Byte for a byte parameter, Integer for an int parameter, and so forth.

The default implementation returns the maximum value in the parameter data type's full range.
Parameters:
  index - The index of the parameter to be queried. A Number representing the maximum legal value,or null if the specified parameter is notnumeric.
throws:
  IllegalArgumentException - if this operation has no parameters.
throws:
  ArrayIndexOutOfBoundsException - if there is no parametercorresponding to the specified index.
See Also:   ParameterListDescriptor.getParamValueRange
See Also:   ParameterListDescriptor.getEnumeratedParameterValues
See Also:   ParameterListDescriptor.isParameterValueValid

The return value should be of the class types corresponding to the parameter's primitive type, that is, Byte for a byte parameter, Integer for an int parameter, and so forth.

The default implementation returns the minimum value in the parameter data type's full range.
Parameters:
  index - The index of the parameter to be queried. A Number representing the minimum legal value,or null if the specified parameter is notnumeric.
throws:
  IllegalArgumentException - if this operation has no parameters.
throws:
  ArrayIndexOutOfBoundsException - if there is no parametercorresponding to the specified index.
See Also:   ParameterListDescriptor.getParamValueRange
See Also:   ParameterListDescriptor.getEnumeratedParameterValues
See Also:   ParameterListDescriptor.isParameterValueValid

For the sake of backward compatibilty, if a deprecated constructor was used to create this object, then this method simply calls its deprecated equivalent, getPropertyGenerators(), if the modeName is either "rendered" or "renderable".
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 arePropertiesSupportedreturns false
See Also:   RegistryElementDescriptor
since:
   JAI 1.1

The default implementation ignores the Locale argument, and always returns the resources in the default Locale.
Parameters:
  locale - The Locale in which to localize theresource data. A ResourceBundle containing mandatory andoptional resource information.

The default implementation simply returns a reference to the local "resources" variable, which should be supplied by each subclass by way of the superclass constructor. It also ignores the Locale argument, and always returns the Strings in the default Locale.
Parameters:
  locale - The Locale in which to localize theresource data. A two-dimensional array of Strings containingthe mandatory and optional resource tags and theircorresponding resource data. (String[i][0] isthe tag for the i-th resource and String[i][1] is thecorresponding data)

Operations that rely on an external resource, such as a source file, or that produce externally-visible side effects, such as writing to an output file, should return true from this method. Operations that rely only on their sources and parameters usually wish to return false in order to defer rendering as long as possible.

The default implementation in this class returns false so that deferred execution is invoked. Operations that wish to be placed in the immediate mode must override this implementation.

This method is the standard place where input arguments are validated against this operation's specification for the specified mode. It is called by JAI.create() as a part of its validation process. Thus it is strongly recommended that the application programs use the JAI.create() methods to instantiate all the rendered operations.

The default implementation of this method makes sure that this operator supports the specified mode and then calls validateSources and validateParameters.

This method sets all the undefined parameters in the ParameterBlock to their default values, if the default values are specified.

Note that DeferredData parameters will not be recognized as valid unless the parameter is defined to have class DeferredData.class.
Parameters:
  modeName - the operation mode name
Parameters:
  args - Input arguments, including source(s) and/or parameter(s).
Parameters:
  msg - A string that may contain error messages.
throws:
  IllegalArgumentException - if modeName is null
since:
   JAI 1.1
See Also:   OperationDescriptorImpl.validateSources
See Also:   OperationDescriptorImpl.validateParameters

Note that DeferredData parameters will not be recognized as valid unless the parameter is defined to have class DeferredData.class.

Additional validations should be added by each individual operation based on its specification.
throws:
  IllegalArgumentException - if args is null.
throws:
  IllegalArgumentException - if msg is nulland the validation fails.
See Also:   OperationDescriptorImpl.validateArguments

JAI allows unspecified tailing parameters if these parameters have default values. This method automatically sets these unspecified parameters to their default values. However, if a parameter, which has a default value, is followed by one or more parameters that have no default values, this parameter must be specified in the ParameterBlock; else this method returns false.

This method sets all the undefined parameters in the ParameterBlock to their default values, if the default values are specified.

Note that DeferredData parameters will not be recognized as valid unless the parameter is defined to have class DeferredData.class.

For the sake of backward compatibilty, if a deprecated constructor was used to create this object, then this method simply calls its deprecated equivalent, if the modeName is either "rendered" or "renderable".
throws:
  IllegalArgumentException - if any of the input parameters are null.
since:
   JAI 1.1
See Also:   OperationDescriptorImpl.validateArguments
See Also:   ParameterListDescriptorImpl.isParameterValueValid

JAI allows unspecified tailing parameters if these parameters have default values. This method automatically sets these unspecified parameters to their default values. However, if a parameter, which has a default value, is followed by one or more parameters that have no default values, this parameter must be specified in the ParameterBlock; else this method returns false.

Note that DeferredData parameters will not be recognized as valid unless the parameter is defined to have class DeferredData.class.
throws:
  IllegalArgumentException - if args is null.
throws:
  IllegalArgumentException - if msg is nulland the validation fails.
See Also:   OperationDescriptorImpl.validateParameters

If this operation does not support the renderable mode, this method returns false regardless of the input arguments.

Note that DeferredData parameters will not be recognized as valid unless the parameter is defined to have class DeferredData.class.

Additional validations should be added by each individual operation based on its specification.
throws:
  IllegalArgumentException - if args is null.
throws:
  IllegalArgumentException - if msg is nulland the validation fails.
See Also:   OperationDescriptorImpl.validateArguments

For the sake of backward compatibilty, if a deprecated constructor was used to create this object, then this method simply calls its deprecated equivalent, if the modeName is either "rendered" or "renderable".
Parameters:
  modeName - the operation mode name
Parameters:
  args - a ParameterBlock that has the sources
Parameters:
  msg - A string that may contain error messages.
throws:
  IllegalArgumentException - if any of the input parameters are null.
since:
   JAI 1.1
See Also:   OperationDescriptorImpl.validateArguments