Package xbot.common.properties

Class BooleanProperty

java.lang.Object

xbot.common.properties.Property

xbot.common.properties.BooleanProperty

All Implemented Interfaces:

DataFrameRefreshable

public class BooleanProperty
extends Property

A property holding a boolean value.

Nested Class Summary

Nested classes/interfaces inherited from class xbot.common.properties.Property

Property.PropertyLevel, Property.PropertyPersistenceType

Field Summary

Fields inherited from class xbot.common.properties.Property

activeStore, key, level, log, prefix, suffix

Constructor Summary

Constructors

Constructor	Description
BooleanProperty(String prefix, String name, boolean defaultValue, XPropertyManager manager)
BooleanProperty(String prefix, String name, boolean defaultValue, XPropertyManager manager, Property.PropertyLevel level)

Method Summary

Modifier and Type	Method	Description
boolean	get()
boolean	get_internal()
boolean	isSetToDefault()	Checks if the property's current value matches the default.
void	refreshDataFrame()	Consumes and processes inputs from the device or subsystem.
void	set(boolean value)

Methods inherited from class xbot.common.properties.Property

getLevel

Methods inherited from class java.lang.Object

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

Constructor Details

BooleanProperty

public BooleanProperty(String prefix,
 String name,
 boolean defaultValue,
 XPropertyManager manager)

BooleanProperty

public BooleanProperty(String prefix,
 String name,
 boolean defaultValue,
 XPropertyManager manager,
 Property.PropertyLevel level)

Method Details

get

public boolean get()

get_internal

public boolean get_internal()

Returns:

the current boolean value

set

public void set(boolean value)

Parameters:

value - the value to set

isSetToDefault

public boolean isSetToDefault()

Description copied from class: Property

Checks if the property's current value matches the default.

Specified by:

isSetToDefault in class Property

Returns:

True if the current value is the default.

refreshDataFrame

public void refreshDataFrame()

Description copied from interface: DataFrameRefreshable

Consumes and processes inputs from the device or subsystem.