All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.trumphurst.utils.TProperty

public interface TProperty

The base interface for all properties added to a TProperties. Should also have all the following members/constructors ...

An empty constructor accessable from the trumphurst.utils package.
A constructor to construct the property with an initial value and and range or other validation limits. Some such constructors may throw a ValidationException if the initial value provided is unsuitable.
A get method which returns an appropriate value (e.g. int for an integer property).
A static get method which takes as arguments a TProperties and a key, and which looks up the key, validates that the returned TProperty is the correct class (i.e. this class, or a subclass of this class), extracts the value, and returns it. If the property does not exist, or is the wrong type, a suitable default value should be returned.
A set method which takes an appropriate value. Some such set methods may throw a ValidationException if the value provided is unsuitable.

See Also:
Tproperties

version

arguments()
Return a String representation of the arguments necessary to construct the property.
construct(String)
"Construct" the property from a String argument list.
fromString(String)
Change the value of the property from a String representation of the new value.
toString()
Return a String representation of the value.

version
```
 public static final RCSVersion version
```
construct
```
 public abstract void construct(String arguments) throws ValidationException
```
"Construct" the property from a String argument list. The argument list is of exactly the same form as the return value of the arguments method.

Parameters:
arguments - a String representing the arguments. By convention, the argument list consists of individual arguments, separated by commas (',') - the first argument is the value, and subsequent arguments are any additional data needed for the class (e.g. the low and high values for a range validation class).
Throws: ValidationException
when the value in the argument list is invalid for the property, or the argument list is invalid.
See Also:
arguments

fromString
```
 public abstract void fromString(String value) throws ValidationException
```
Change the value of the property from a String representation of the new value.

Parameters:
value - a String representation of the new value
Throws: ValidationException
when the value is not a valid value for the property
See Also:
toString

toString
```
 public abstract String toString()
```
Return a String representation of the value. The String returned should be suitable to use in a call to the fromString method.

Returns:
a String representation of the value
Overrides:
toString in class Object
See Also:
fromString

arguments
```
 public abstract String arguments()
```
Return a String representation of the arguments necessary to construct the property. The String returned should be suitable for use in a call to the construct method.

Returns:
a String representation of the arguments necessary to construct the property
See Also:
construct
```
All Packages  Class Hierarchy  This Package  Previous  Next  Index
```