Package org.cytoscape.work.properties
Interface TunablePropertyHandler
- All Superinterfaces:
TunableHandler
An extension of
TunableHandler
with added functionality to support
converting to/from a String.Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.
Module: work-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>work-api</artifactId> </dependency>
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
handle()
Typically don't need to implement this method, default implementation is empty.void
parseAndSetValue
(String propertyValue) Converts the String representation to an object or primitive value and sets the tunable.Converts the value of the tunable to a String.Methods inherited from interface org.cytoscape.work.TunableHandler
controlsMutuallyExclusiveNestedChildren, dependsOn, getChildKey, getDescription, getExampleStringValue, getGroups, getLongDescription, getName, getParams, getQualifiedName, getType, getValue, listenForChange, setValue
-
Method Details
-
toPropertyValue
String toPropertyValue()Converts the value of the tunable to a String.- Returns:
- String representation of the tunable value.
- Throws:
IllegalArgumentException
- If there is a problem accessing the tunable value.
-
parseAndSetValue
Converts the String representation to an object or primitive value and sets the tunable.- Throws:
IllegalArgumentException
- If there is a problem setting the tunable value.
-
handle
default void handle()Typically don't need to implement this method, default implementation is empty.- Specified by:
handle
in interfaceTunableHandler
-