OSGi 8.1.0 · org.osgi.service.dal.functions.BooleanControl

BooleanControl function provides a boolean control support. The eventable function state is accessible with getData() getter and setData(boolean) setter. The state can be reversed with inverse() method, can be set to true value with setTrue() method and can be set to false value with setFalse() method.

The control type can be:

Types#LIGHT
Types#DOOR
Types#WINDOW
Types#POWER
other type defined in Types
custom - vendor specific type

Field Summary

Modifier and Type	Field and Description
public static final String	OPERATION_INVERSE Specifies the inverse operation name.
public static final String	OPERATION_SET_FALSE Specifies the operation name, which sets the control state to `false` value.
public static final String	OPERATION_SET_TRUE Specifies the operation name, which sets the control state to `true` value.
public static final String	PROPERTY_DATA Specifies the state property name.

Inherited from org.osgi.service.dal.Function:: SERVICE_DESCRIPTION SERVICE_DEVICE_UID SERVICE_OPERATION_NAMES SERVICE_PROPERTY_NAMES SERVICE_REFERENCE_UIDS SERVICE_TYPE SERVICE_UID SERVICE_VERSION

Method Summary

Modifier and Type	Method and Description
public BooleanData	Returns: The current state of `BooleanControl`. getData() Returns the current state of `BooleanControl`.
public void	inverse() Reverses the `BooleanControl` state.
public void	setData(boolean The new function value. data) Sets the `BooleanControl` state to the specified value.
public void	setFalse() Sets the `BooleanControl` state to `false` value.
public void	setTrue() Sets the `BooleanControl` state to `true` value.

Inherited from org.osgi.service.dal.Function:: getOperationMetadata getPropertyMetadata getServiceProperty getServicePropertyKeys

Field Detail

OPERATION_INVERSE	back to summary
public static final String OPERATION_INVERSE Specifies the inverse operation name. The operation can be executed with `inverse()` method.

OPERATION_SET_FALSE	back to summary
public static final String OPERATION_SET_FALSE Specifies the operation name, which sets the control state to `false` value. The operation can be executed with `setFalse()` method.

OPERATION_SET_TRUE	back to summary
public static final String OPERATION_SET_TRUE Specifies the operation name, which sets the control state to `true` value. The operation can be executed with `setTrue()` method.

PROPERTY_DATA back to summary

PROPERTY_DATA	back to summary
public static final String PROPERTY_DATA Specifies the state property name. The eventable property value is accessible with `getData()` method. See Also `BooleanData`

public static final String PROPERTY_DATA

Specifies the state property name. The eventable property value is accessible with getData() method.

See Also: BooleanData

Method Detail

getData back to summary

getData	back to summary
public BooleanData getData() throws DeviceException Returns the current state of `BooleanControl`. It's a getter method for `PROPERTY_DATA` property. Returns:BooleanData The current state of `BooleanControl`. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered. See Also `BooleanData`, `BooleanControl#PROPERTY_DATA`

public BooleanData getData() throws DeviceException

Returns the current state of BooleanControl. It's a getter method for PROPERTY_DATA property.

Returns:BooleanData

The current state of BooleanControl.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.

inverse back to summary

inverse	back to summary
public void inverse() throws DeviceException Reverses the `BooleanControl` state. If the current state represents `true` value, it'll be changed to `false`. If the current state represents `false` value, it'll be changed to `true`. The operation name is `OPERATION_INVERSE`. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered.

public void inverse() throws DeviceException

Reverses the BooleanControl state. If the current state represents true value, it'll be changed to false. If the current state represents false value, it'll be changed to true. The operation name is OPERATION_INVERSE.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.

setData back to summary

setData	back to summary
public void setData(boolean data) throws DeviceException Sets the `BooleanControl` state to the specified value. It's setter method for `PROPERTY_DATA` property. Parameters data:boolean The new function value. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered. IllegalArgumentException: If there is an invalid argument. See Also `BooleanControl#PROPERTY_DATA`

public void setData(boolean data) throws DeviceException

Sets the BooleanControl state to the specified value. It's setter method for PROPERTY_DATA property.

Parameters

data:boolean: The new function value.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.
IllegalArgumentException:: If there is an invalid argument.

See Also

BooleanControl#PROPERTY_DATA

setFalse back to summary

setFalse	back to summary
public void setFalse() throws DeviceException Sets the `BooleanControl` state to `false` value. The operation name is `OPERATION_SET_FALSE`. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered.

public void setFalse() throws DeviceException

Sets the BooleanControl state to false value. The operation name is OPERATION_SET_FALSE.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.

setTrue back to summary

setTrue	back to summary
public void setTrue() throws DeviceException Sets the `BooleanControl` state to `true` value. The operation name is `OPERATION_SET_TRUE`. Exceptions DeviceException: If an operation error is available. IllegalStateException: If this function service object has already been unregistered.

public void setTrue() throws DeviceException

Sets the BooleanControl state to true value. The operation name is OPERATION_SET_TRUE.

Exceptions

DeviceException:: If an operation error is available.
IllegalStateException:: If this function service object has already been unregistered.

public Interface BooleanControl

Field Summary

Method Summary

Field Detail

Method Detail