Interface IIOMetadataController
-
public interface IIOMetadataController
An interface to be implemented by objects that can determine the settings of anIIOMetadata
object, either by putting up a GUI to obtain values from a user, or by other means. This interface merely specifies a genericactivate
method that invokes the controller, without regard for how the controller obtains values (i.e., whether the controller puts up a GUI or merely computes a set of values is irrelevant to this interface).Within the
activate
method, a controller obtains initial values by querying theIIOMetadata
object's settings, either using the XML DOM tree or a plug-in specific interface, modifies values by whatever means, then modifies theIIOMetadata
object's settings, using either thesetFromTree
ormergeTree
methods, or a plug-in specific interface. In general, applications may expect that when theactivate
method returnstrue
, theIIOMetadata
object is ready for use in a write operation.Vendors may choose to provide GUIs for the
IIOMetadata
subclasses they define for a particular plug-in. These can be set up as default controllers in the correspondingIIOMetadata
subclasses.Alternatively, an algorithmic process such as a database lookup or the parsing of a command line could be used as a controller, in which case the
activate
method would simply look up or compute the settings, call methods onIIOMetadata
to set its state, and returntrue
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description boolean
activate(IIOMetadata metadata)
Activates the controller.
-
-
-
Method Detail
activate
boolean activate(IIOMetadata metadata)
Activates the controller. Iftrue
is returned, all settings in theIIOMetadata
object should be ready for use in a write operation. Iffalse
is returned, no settings in theIIOMetadata
object will be disturbed (i.e., the user canceled the operation).- Parameters:
-
metadata
- theIIOMetadata
object to be modified. - Returns:
-
true
if theIIOMetadata
has been modified,false
otherwise. - Throws:
-
IllegalArgumentException
- ifmetadata
isnull
or is not an instance of the correct class.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.