buzz.getcoco.iot

Enum Network.State

java.lang.Object

java.lang.Enum<Network.State>

buzz.getcoco.iot.Network.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Network.State>

Enclosing class:

Network

public static enum Network.State
extends java.lang.Enum<Network.State>

state enum denoting if a network is connected/connecting etc.,

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCKED State represents that client is being blocked from connecting to network.
CONNECTED State representing that client is connected to network.
CONNECTING State represents that client is trying to connect to a network, connection is not yet successfully established.
CONNECTION_ERROR State represents there was an error while trying to connect to network.
DISCONNECTED State represents that client is disconnected from network.
NETWORK_RESET State represents networks is either deleted or client was removed from network.
NOT_PERMITTED State represent that client is not permitted to join the network.

Method Summary

Modifier and Type	Method and Description
boolean	connectionNotPermitted() A function to check if current state is NOT_PERMITTED.
boolean	isBlocked() A function to check if current is BLOCKED.
boolean	isConnected() A function to check if current state is CONNECTED.
boolean	isConnectedOrConnecting() A function to check if current state is CONNECTED OR CONNECTING state.
boolean	isConnecting() A function to check if current state is CONNECTING.
boolean	isEquivalentToDisconnected() A function to check if current state is equivalent to DISCONNECTED.
boolean	isLeftOrDeleted() A function to check if current state is equivalent to NETWORK_RESET.
boolean	isLeftOrDeletedOrBlocked() A function to check if current state of networks is NETWORK_RESET or BLOCKED.
static Network.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Network.State[]	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

CONNECTED

public static final Network.State CONNECTED

State representing that client is connected to network.

CONNECTING

public static final Network.State CONNECTING

State represents that client is trying to connect to a network, connection is not yet successfully established.

CONNECTION_ERROR

public static final Network.State CONNECTION_ERROR

State represents there was an error while trying to connect to network.

NETWORK_RESET

public static final Network.State NETWORK_RESET

State represents networks is either deleted or client was removed from network.

DISCONNECTED

public static final Network.State DISCONNECTED

State represents that client is disconnected from network.

BLOCKED

public static final Network.State BLOCKED

State represents that client is being blocked from connecting to network.

NOT_PERMITTED

public static final Network.State NOT_PERMITTED

State represent that client is not permitted to join the network.

Method Detail

values

public static Network.State[] 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 (Network.State c : Network.State.values())
    System.out.println(c);

Returns:

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

valueOf

public static Network.State 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

isConnected

public boolean isConnected()

A function to check if current state is CONNECTED.

Returns:

A flag that represents if network is CONNECTED.

isConnecting

public boolean isConnecting()

A function to check if current state is CONNECTING.

Returns:

A flag that represents if network is in connecting CONNECTED.

isConnectedOrConnecting

public boolean isConnectedOrConnecting()

A function to check if current state is CONNECTED OR CONNECTING state.

Returns:

A flag that represents if network in DISCONNECTED OR DISCONNECTED.

isEquivalentToDisconnected

public boolean isEquivalentToDisconnected()

A function to check if current state is equivalent to DISCONNECTED. NOTE: The current state necessarily need not be DISCONNECTED.

Returns:

A flag that represents if current state is equivalent to DISCONNECTED.

isLeftOrDeletedOrBlocked

public boolean isLeftOrDeletedOrBlocked()

A function to check if current state of networks is NETWORK_RESET or BLOCKED.

Returns:

A flag indicating if current networks left/deleted/blocked.

isLeftOrDeleted

public boolean isLeftOrDeleted()

A function to check if current state is equivalent to NETWORK_RESET.

Returns:

A flag that represents if current state is equivalent to NETWORK_RESET.

isBlocked

public boolean isBlocked()

A function to check if current is BLOCKED.

Returns:

A flag that represents if current state is BLOCKED.

connectionNotPermitted

public boolean connectionNotPermitted()

A function to check if current state is NOT_PERMITTED.

Returns:

A flag that represents if current state is NOT_PERMITTED.