public interface Controller extends Device
Modifier and Type | Field and Description |
---|---|
static int |
AUTOMATIC
No physical action is required on the Node to exclude it from the network.
|
static int |
EXCLUSION
A controller in that mode can exclude a new device.
|
static int |
INCLUSION
A controller in that mode can include a new device.
|
static int |
MANUAL
A physical action is on the Node to exclude it from the network.
|
static int |
RUNNING
A controller state.
|
static int |
UNKNOWN
The state has not been determined yet.
|
UNKNOWN_NAME
Modifier and Type | Method and Description |
---|---|
void |
exclusionStart()
Starts the exclusion mode.
|
void |
exclusionStop()
Stops the exclusion mode.
|
int |
getExclusionMode()
Return The supported exclusion mode.
|
ControllerListener |
getListener()
Get the
ControllerListener attached to this controller. |
int |
getState()
Returns the actual state on the controller.
|
void |
inclusionStart()
Start the inclusion mode.
|
void |
inclusionStop()
Stop the inclusion mode.
|
boolean |
isStarted()
Returns true if the controller is started, false otherwise.
|
boolean |
start(ControllerListener listener)
Start this controller.
|
void |
stop()
Stop this controller.
|
getChildren, getDescriptor, getName, getParent
static final int AUTOMATIC
static final int EXCLUSION
static final int INCLUSION
static final int MANUAL
static final int RUNNING
inclusionStop()
the controller is in this state.exclusionStop()
the controller is in this state.inclusionStart()
the controller is in this state.exclusionStart()
the controller is in this state.static final int UNKNOWN
void exclusionStart()
IllegalStateException
- if the controller is not in RUNNING state before this call.void exclusionStop()
IllegalStateException
- if the controller is not in EXCLUSION state before this call.int getExclusionMode()
ControllerListener getListener()
ControllerListener
attached to this controller.int getState()
inclusionStart()
,
inclusionStop()
,
exclusionStart()
,
exclusionStop()
void inclusionStart()
IllegalStateException
- if the controller is not in RUNNING state before this call.void inclusionStop()
IllegalStateException
- if the controller is not in INCLUSION state before this call.boolean isStarted()
boolean start(ControllerListener listener)
listener
- the listener which receive all events.NullPointerException
- if the given listener is null.IllegalStateException
- if the controller is already started.void stop()
IllegalStateException
- if the controller is not started.