Package pulse.properties
Interface Property
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
DiscreteSelector,Flag,Identifier,InstanceDescriptor,NumericProperty,SampleName
public interface Property extends Serializable
The basic interface for properties. The only declared functionality consists in the ability to report the associated value and deliver text description.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description booleanattemptUpdate(Object value)default StringformattedOutput()Formats the value so that it is suitable for output using the GUI or console.StringgetDescriptor(boolean addHtmlTags)Creates aStringto describe this property (often used in GUI applications).ObjectgetValue()Retrieves the value of thisProperty.default Objectidentifier()
-
-
-
Method Detail
-
getValue
Object getValue()
Retrieves the value of thisProperty.- Returns:
- an object representing the value of this
Property
-
formattedOutput
default String formattedOutput()
Formats the value so that it is suitable for output using the GUI or console.- Returns:
- a formatted
Stringrepresenting thevalue
-
getDescriptor
String getDescriptor(boolean addHtmlTags)
Creates aStringto describe this property (often used in GUI applications).- Parameters:
addHtmlTags- iftrue, adds the 'html' tags at both ends of the descriptorString.- Returns:
- a
String, with or without 'html' tags, describing thisProperty
-
attemptUpdate
boolean attemptUpdate(Object value)
-
identifier
default Object identifier()
-
-