casa.util

Class BooleanProperty

java.lang.Object

casa.util.Property

casa.util.BooleanProperty

public class BooleanProperty
extends Property

Title: BooleanProperty

Description: A boolean 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
private boolean	value The value of this property.

Fields inherited from class casa.util.Property

BOOLEAN, BYTE, CHAR, DOUBLE, FLOAT, INTEGER, LONG, SHORT, STRING

Constructor Summary

Constructors

Constructor and Description
BooleanProperty(boolean value) Initializes the property to have the value indicated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Determines if the current property is equal to the given object.
static Property	fromString(String property) Creates a BooleanProperty that is decoded from the given String and returns it.
boolean	getBoolean() Retrieves the value of the property.
int	getType() Retrieves the type of property this is.
void	setBoolean(boolean value) Sets the value of the property.
String	toString() Retreives the String representation of the property.

Methods inherited from class casa.util.Property

getByte, getChar, getDouble, getFloat, getInteger, getLong, getShort, getString, setBtye, setChar, setDouble, setFloat, setInteger, setLong, setShort, setString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

value

private boolean value

The value of this property.

Constructor Detail

BooleanProperty

public BooleanProperty(boolean value)

Initializes the property to have the value indicated.

Parameters:

value - The value to set the property at.

Method Detail

getType

public int getType()

Retrieves the type of property this is.

Specified by:

getType in class Property

Returns:

The type of property this is, Property.BOOLEAN.

See Also:

Property.BOOLEAN, Property.STRING, Property.INTEGER, Property.LONG, Property.FLOAT, Property.DOUBLE, Property.CHAR, Property.BYTE, Property.FLOAT

toString

public String toString()

Retreives the String representation of the property.

Specified by:

toString in class Property

Returns:

The String representation of the property.

equals

public boolean equals(Object object)

Determines if the current property is equal to the given object.

Specified by:

equals in class Property

Parameters:

object - The object to compare to the current property.

Returns:

true if the object is a BooleanProperty and its value is the same as the current property.

fromString

public static Property fromString(String property)

Creates a BooleanProperty that is decoded from the given String and returns it.

Parameters:

property - The property in String form.

Returns:

The property in BooleanProperty form.

getBoolean

public boolean getBoolean()

Retrieves the value of the property.

Overrides:

getBoolean in class Property

Returns:

The value of the property.

setBoolean

public void setBoolean(boolean value)

Sets the value of the property.

Overrides:

setBoolean in class Property

Parameters:

value - The new value of the property.