|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecthenplus.property.PropertyHolder
public abstract class PropertyHolder
A Property is something that has a value and is bound to some name. The binding to a name is done elsewhere, the PropertyHolder holds the value and informs a callback method on change. It provides a simple way of completing values, if possible to aid the shell. The PropertyHolder is abstract, since it needs to be overwritten to get informed on changes of its value. Since a property is always special in a sense that changing the property does change some internal state, possibly by calling several methods, code is always executed on change.
Field Summary | |
---|---|
protected String |
_propertyValue
|
Constructor Summary | |
---|---|
protected |
PropertyHolder()
construct a PropertyHolder with an empty value. |
protected |
PropertyHolder(String initialValue)
|
Method Summary | |
---|---|
Iterator |
completeValue(String partialValue)
given a partial value of a to-be-set value, this will return an iterator of possible values possible at that point or 'null' if no such completion can take place. |
abstract String |
getDefaultValue()
|
String |
getLongDescription()
returns a longer string describing this property. |
String |
getShortDescription()
return a short string describing the purpose of this property Should contain no newline, no leading spaces and should not be longer than 40 characters. |
String |
getValue()
The canonicalized value of the value of this Property. |
protected abstract String |
propertyChanged(String newValue)
is called, when the property changes. |
void |
setValue(String newValue)
set the new value of this property. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected String _propertyValue
Constructor Detail |
---|
protected PropertyHolder()
protected PropertyHolder(String initialValue)
Method Detail |
---|
public void setValue(String newValue) throws Exception
propertyChanged(String)
listener method.
newValue
- the new value to be set.
Exception
public String getValue()
public abstract String getDefaultValue()
protected abstract String propertyChanged(String newValue) throws Exception
newValue
- a new value of the property. The old value
is still accessible with the getValue()
method.
Exception
public Iterator completeValue(String partialValue)
partialValue
- a partial given value
null
if no such completion exists.public String getShortDescription()
public String getLongDescription()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |