com.idevicesinc.sweetblue

Enum BleServerState

java.lang.Object

java.lang.Enum<BleServerState>

com.idevicesinc.sweetblue.BleServerState

All Implemented Interfaces:

State, UsesCustomNull, java.io.Serializable, java.lang.Comparable<BleServerState>

public enum BleServerState
extends java.lang.Enum<BleServerState>
implements State

An enumeration of the various states that a BleServer can be in on a per-client (mac address) basis. Note that unlike a BleDevice, a BleServer can only be in one state at a time for a given client Use BleServer.setListener_State(ServerStateListener) to be notified of state changes.

See Also:

ServerStateListener

Nested Class Summary

Nested classes/interfaces inherited from interface com.idevicesinc.sweetblue.utils.State

State.ChangeEvent<T_State extends State>, State.ChangeIntent

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED SweetBlue equivalent of BluetoothProfile.STATE_CONNECTED.
CONNECTING SweetBlue equivalent of BluetoothProfile.STATE_CONNECTING.
DISCONNECTED SweetBlue equivalent of BluetoothProfile.STATE_DISCONNECTED.
NULL Dummy value returned from any method that would otherwise return Java's built-in null.
RETRYING_CONNECTION This is a state which is a SweetBlue construct.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FULL_MASK Full bitwise mask made by ORing all BleServerState instances together.

Method Summary

Modifier and Type	Method and Description
int	bit()
boolean	didEnter(int oldStateBits, int newStateBits) Given an old and new state mask, for example from DeviceStateListener.onEvent(com.idevicesinc.sweetblue.DeviceStateListener.StateEvent) or ManagerStateListener.onEvent(com.idevicesinc.sweetblue.ManagerStateListener.StateEvent), this method tells you whether the the 'this' state was appended.
boolean	didExit(int oldStateBits, int newStateBits) Reverse of State.didEnter(int, int).
boolean	isNull() Returns true if this state is meant to stand in for Java's built-in null.
int	or(BitwiseEnum state)
boolean	overlaps(int mask)
static int	toBits(BleServerState... states)
static BleServerState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BleServerState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NULL

public static final BleServerState NULL

Dummy value returned from any method that would otherwise return Java's built-in null. A normal BleDevice will never be in this state, but this will be the sole state of BleServer.NULL.

DISCONNECTED

public static final BleServerState DISCONNECTED

SweetBlue equivalent of BluetoothProfile.STATE_DISCONNECTED.

CONNECTING

public static final BleServerState CONNECTING

SweetBlue equivalent of BluetoothProfile.STATE_CONNECTING.

CONNECTED

public static final BleServerState CONNECTED

SweetBlue equivalent of BluetoothProfile.STATE_CONNECTED.

RETRYING_CONNECTION

public static final BleServerState RETRYING_CONNECTION

This is a state which is a SweetBlue construct. If the server/client connection fails, but is retrying, this will be it's state.

Field Detail

FULL_MASK

public static final int FULL_MASK

Full bitwise mask made by ORing all BleServerState instances together.

Method Detail

values

public static BleServerState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BleServerState c : BleServerState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BleServerState valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toBits

public static int toBits(BleServerState... states)

overlaps

public boolean overlaps(int mask)

bit

public int bit()

didEnter

public boolean didEnter(int oldStateBits,
                        int newStateBits)

Description copied from interface: State

Given an old and new state mask, for example from DeviceStateListener.onEvent(com.idevicesinc.sweetblue.DeviceStateListener.StateEvent) or ManagerStateListener.onEvent(com.idevicesinc.sweetblue.ManagerStateListener.StateEvent), this method tells you whether the the 'this' state was appended.

Specified by:

didEnter in interface State

See Also:

State.didExit(int, int)

didExit

public boolean didExit(int oldStateBits,
                       int newStateBits)

Description copied from interface: State

Reverse of State.didEnter(int, int).

Specified by:

didExit in interface State

See Also:

State.didEnter(int, int)

or

public int or(BitwiseEnum state)

isNull

public boolean isNull()

Description copied from interface: State

Returns true if this state is meant to stand in for Java's built-in null.

Specified by:

isNull in interface State

Specified by:

isNull in interface UsesCustomNull