Property

java.lang.Object
- casa.util.Property

Direct Known Subclasses:

BooleanProperty, ByteProperty, CharProperty, DoubleProperty, FloatProperty, IntegerProperty, LongProperty, ShortProperty, StringProperty
```
public abstract class Property
extends Object
```
Title: Property

Description: An abstract property.

Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Version:

0.9

Author:

Jason Heard, Rob Kremer

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOLEAN` Constant used to indicate a boolean property type.
`static int`	`BYTE` Constant used to indicate a boolean property type.
`static int`	`CHAR` Constant used to indicate a boolean property type.
`static int`	`DOUBLE` Constant used to indicate a floating point property type.
`static int`	`FLOAT` Constant used to indicate a floating point property type.
`static int`	`INTEGER` Constant used to indicate an integer property type.
`static int`	`LONG` Constant used to indicate a floating point property type.
`static int`	`SHORT` Constant used to indicate a boolean property type.
`static int`	`STRING` Constant used to indicate a string property type.

Constructor Summary

Constructors
Constructor and Description

Property()

Constructors
Constructor and Description
`Property()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`equals(Object object)` Determines if the current property is equal to the given object.
`static Property`	`fromString(String property)` Creates a `Property` that is decoded from the given `String` and returns it.
`boolean`	`getBoolean()` Retrieves the boolean value of the property.
`byte`	`getByte()` Retrieves the byte value of the property.
`char`	`getChar()` Retrieves the char value of the property.
`double`	`getDouble()` Retrieves the double precision floating point value of the property.
`float`	`getFloat()` Retrieves the floating point value of the property.
`int`	`getInteger()` Retrieves the integer value of the property.
`long`	`getLong()` Retrieves the long integer value of the property.
`short`	`getShort()` Retrieves the short value of the property.
`String`	`getString()` Retrieves the string value of the property.
`abstract int`	`getType()` Retrieves the type of property this is.
`void`	`setBoolean(boolean value)` Sets the boolean value of the property.
`void`	`setBtye(byte value)` Sets the byte value of the property.
`void`	`setChar(char value)` Sets the char value of the property.
`void`	`setDouble(double value)` Sets the double precision floating point value of the property.
`void`	`setFloat(float value)` Sets the floating point value of the property.
`void`	`setInteger(int value)` Sets the integer value of the property.
`void`	`setLong(long value)` Sets the long integer value of the property.
`void`	`setShort(short value)` Sets the short value of the property.
`void`	`setString(String value)` Sets the string value of the property.
`abstract String`	`toString()` Retreives the `String` representation of the property.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BOOLEAN
```
public static final int BOOLEAN
```
    Constant used to indicate a boolean property type.
    
    See Also:
    
    Constant Field Values
  - STRING
```
public static final int STRING
```
    Constant used to indicate a string property type.
    
    See Also:
    
    Constant Field Values
  - INTEGER
```
public static final int INTEGER
```
    Constant used to indicate an integer property type.
    
    See Also:
    
    Constant Field Values
  - LONG
```
public static final int LONG
```
    Constant used to indicate a floating point property type.
    
    See Also:
    
    Constant Field Values
  - FLOAT
```
public static final int FLOAT
```
    Constant used to indicate a floating point property type.
    
    See Also:
    
    Constant Field Values
  - DOUBLE
```
public static final int DOUBLE
```
    Constant used to indicate a floating point property type.
    
    See Also:
    
    Constant Field Values
  - CHAR
```
public static final int CHAR
```
    Constant used to indicate a boolean property type.
    
    See Also:
    
    Constant Field Values
  - BYTE
```
public static final int BYTE
```
    Constant used to indicate a boolean property type.
    
    See Also:
    
    Constant Field Values
  - SHORT
```
public static final int SHORT
```
    Constant used to indicate a boolean property type.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Property
```
public Property()
```
- Method Detail
  - getType
```
public abstract int getType()
```
    Retrieves the type of property this is.
    
    Returns:
    
    The type of property this is.
    
    See Also:
    
    BOOLEAN, STRING, INTEGER, LONG, FLOAT, DOUBLE, CHAR, BYTE, FLOAT
  - toString
```
public abstract String toString()
```
    Retreives the String representation of the property.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The String representation of the property.
  - equals
```
public abstract boolean equals(Object object)
```
    Determines if the current property is equal to the given object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The object to compare to the current property.
    
    Returns:
    
    true if the object is the same property type and its value is the same as the current property.
  - fromString
```
public static Property fromString(String property)
                           throws PropertyException
```
    Creates a Property that is decoded from the given String and returns it.
    
    Parameters:
    
    property - The property in String form.
    
    Returns:
    
    The decoded property.
    
    Throws:
    
    PropertyException - If the function has not been overridden.
  - getChar
```
public char getChar()
             throws PropertyException
```
    Retrieves the char value of the property.
    
    Returns:
    
    The char value of the property.
    
    Throws:
    
    PropertyException - If the property is not a CharProperty.
  - getByte
```
public byte getByte()
             throws PropertyException
```
    Retrieves the byte value of the property.
    
    Returns:
    
    The byte value of the property.
    
    Throws:
    
    PropertyException - If the property is not a ByteProperty.
  - getShort
```
public short getShort()
               throws PropertyException
```
    Retrieves the short value of the property.
    
    Returns:
    
    The short value of the property.
    
    Throws:
    
    PropertyException - If the property is not a ShortProperty.
  - getBoolean
```
public boolean getBoolean()
                   throws PropertyException
```
    Retrieves the boolean value of the property.
    
    Returns:
    
    The boolean value of the property.
    
    Throws:
    
    PropertyException - If the property is not a BooleanProperty.
  - setBoolean
```
public void setBoolean(boolean value)
                throws PropertyException
```
    Sets the boolean value of the property.
    
    Parameters:
    
    value - The new boolean value of the property.
    
    Throws:
    
    PropertyException - If the property is not a BooleanProperty.
  - setChar
```
public void setChar(char value)
             throws PropertyException
```
    Sets the char value of the property.
    
    Parameters:
    
    value - The new char value of the property.
    
    Throws:
    
    PropertyException - If the property is not a CharProperty.
  - setBtye
```
public void setBtye(byte value)
             throws PropertyException
```
    Sets the byte value of the property.
    
    Parameters:
    
    value - The new byte value of the property.
    
    Throws:
    
    PropertyException - If the property is not a ByteProperty.
  - setShort
```
public void setShort(short value)
              throws PropertyException
```
    Sets the short value of the property.
    
    Parameters:
    
    value - The new short value of the property.
    
    Throws:
    
    PropertyException - If the property is not a ShortProperty.
  - getString
```
public String getString()
                 throws PropertyException
```
    Retrieves the string value of the property.
    
    Returns:
    
    The string value of the property.
    
    Throws:
    
    PropertyException - If the property is not a StringProperty.
  - setString
```
public void setString(String value)
               throws PropertyException
```
    Sets the string value of the property.
    
    Parameters:
    
    value - The new string value of the property.
    
    Throws:
    
    PropertyException - If the property is not a StringProperty.
  - getInteger
```
public int getInteger()
               throws PropertyException
```
    Retrieves the integer value of the property.
    
    Returns:
    
    The integer value of the property.
    
    Throws:
    
    PropertyException - If the property is not a IntegerProperty.
  - setInteger
```
public void setInteger(int value)
                throws PropertyException
```
    Sets the integer value of the property.
    
    Parameters:
    
    value - The new integer value of the property.
    
    Throws:
    
    PropertyException - If the property is not a IntegerProperty.
  - getLong
```
public long getLong()
             throws PropertyException
```
    Retrieves the long integer value of the property.
    
    Returns:
    
    The long integer value of the property.
    
    Throws:
    
    PropertyException - If the property is not a LongProperty.
  - setLong
```
public void setLong(long value)
             throws PropertyException
```
    Sets the long integer value of the property.
    
    Parameters:
    
    value - The new long integer value of the property.
    
    Throws:
    
    PropertyException - If the property is not a LongProperty.
  - getFloat
```
public float getFloat()
               throws PropertyException
```
    Retrieves the floating point value of the property.
    
    Returns:
    
    The floating point value of the property.
    
    Throws:
    
    PropertyException - If the property is not a FloatProperty
  setFloat public void setFloat(float value) throws PropertyException Sets the floating point value of the property. Parameters: value - The new floating point value of the property. Throws: PropertyException - If the property is not a FloatProperty. getDouble public double getDouble() throws PropertyException Retrieves the double precision floating point value of the property. Returns: The double precision floating point value of the property. Throws: PropertyException - If the property is not a DoubleProperty setDouble public void setDouble(double value) throws PropertyException Sets the double precision floating point value of the property. Parameters: value - The new double precision floating point value of the property. Throws: PropertyException - If the property is not a DoubleProperty.

Class Property

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOOLEAN

STRING

INTEGER

LONG

FLOAT

DOUBLE

CHAR

BYTE

SHORT

Constructor Detail

Property

Method Detail

getType

toString

equals

fromString

getChar

getByte

getShort

getBoolean

setBoolean

setChar

setBtye

setShort

getString

setString

getInteger

setInteger

getLong

setLong

getFloat

setFloat

getDouble

setDouble