All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.trumphurst.utils.TBooleanProperty

java.lang.Object
   |
   +----com.trumphurst.utils.TBooleanProperty

public class TBooleanProperty
extends Object
implements TProperty
A TProperty which holds a boolean value


Variable Index

 o b
The value

Constructor Index

 o TBooleanProperty(boolean)
Construct with a value

Method Index

 o arguments()
Return a String representation of the arguments necessary to construct the property.
 o construct(String)
"Construct" the property from a String argument list.
 o fromString(String)
Change the value of the property from a String representation of the new value.
 o get()
Return the value
 o get(TProperties, String)
Return the boolean value of the specified property in the properties list.
 o set(boolean)
Set the value
 o toString()
Return a String representation of the value.

Variables

 o b
 protected boolean b
The value

Constructors

 o TBooleanProperty
 public TBooleanProperty(boolean b)
Construct with a value

Parameters:
the - value

Methods

 o get
 public boolean get()
Return the value

 o get
 public static boolean get(TProperties properties,
                           String key)
Return the boolean value of the specified property in the properties list. Verifies that the key exists, and refers to a TBooleanProperty (or a subclass).

Parameters:
properties - the properties list
Returns:
the boolean value of the property, or false
 o set
 public void set(boolean b) throws ValidationException
Set the value

Parameters:
b - the value to set
Throws: ValidationException
never thrown by this class, but a subclass that only permits a limited range of values might throw the exception if the new value was out of range.
 o construct
 public void construct(String arguments) throws ValidationException
"Construct" the property from a String argument list. The same as fromString, as there are no additional arguments other than the value.

Parameters:
arguments - "true", "false", "yes", "no", "1" or "0"
Throws: ValidationException
if the argument is none of the above
 o fromString
 public void fromString(String s) throws ValidationException
Change the value of the property from a String representation of the new value.

Parameters:
arguments - "true", "false", "yes", "no", "1" or "0"
Throws: ValidationException
if the argument is none of the above
 o toString
 public String toString()
Return a String representation of the value.

Returns:
"true" or "false"
Overrides:
toString in class Object
 o arguments
 public String arguments()
Return a String representation of the arguments necessary to construct the property.

Returns:
"true" or "false"

All Packages  Class Hierarchy  This Package  Previous  Next  Index