buzz.getcoco.iot

Class Zone

java.lang.Object

buzz.getcoco.iot.Zone

All Implemented Interfaces:

java.lang.Iterable<Resource>

public class Zone
extends java.lang.Object
implements java.lang.Iterable<Resource>

Zone class is a blueprint of zone present in a network. Zone is a container of resources added by user, this class also facilitates movement of resources between different zones by implementing iterable.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ZONE_ID
static java.lang.String	defaultZoneName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Zone(int zoneId, Network parent) The constructor of the current class.

Method Summary

Modifier and Type	Method and Description
protected boolean	containsResource(Resource resource)
int	getId() A function to get the zoneId of the zone.
java.lang.String	getName() A function to get the name of the zone.
Network	getParent() A function to get the parent Network of the zone.
java.util.Set<Resource>	getResources() A function to get the set of resources of the current zone.
int	hashCode()
protected void	internalAddResource(Resource resource)
protected void	internalMarkAsReady()
protected void	internalRemoveResource(Resource resource)
protected void	internalSetName(java.lang.String name)
protected void	internalSetParent(Network parent)
boolean	isReady() A function suggesting if the zone is made from NativeCallbacks.zoneInfoCallback(boolean, java.lang.String, int, java.lang.String, long[], java.lang.String[], java.lang.String[], java.lang.Object) or because of state retrieval.
java.util.Iterator<Resource>	iterator()
void	setName(java.lang.String name, Network.NetworkManagementStatusListener listener) A function to set the name of the current zone.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

defaultZoneName

public static java.lang.String defaultZoneName

DEFAULT_ZONE_ID

public static final int DEFAULT_ZONE_ID

See Also:

Constant Field Values

Constructor Detail

Zone

protected Zone(int zoneId,
               Network parent)

The constructor of the current class.

Parameters:

zoneId - The unique id of the zone

parent - The parent network of the zone

Method Detail

getId

public int getId()

A function to get the zoneId of the zone.

Returns:

int: zoneId of the current zone

getName

public java.lang.String getName()

A function to get the name of the zone.

Returns:

String: The name of the zone

getResources

public java.util.Set<Resource> getResources()

A function to get the set of resources of the current zone.

Returns:

The set of resources

getParent

public Network getParent()

A function to get the parent Network of the zone.

Returns:

Network: The parent network of the current zone

setName

public void setName(java.lang.String name,
                    Network.NetworkManagementStatusListener listener)

A function to set the name of the current zone.

Parameters:

name - The name that has to be set

internalAddResource

protected void internalAddResource(Resource resource)

internalRemoveResource

protected void internalRemoveResource(Resource resource)

containsResource

protected boolean containsResource(Resource resource)

internalSetName

protected void internalSetName(java.lang.String name)

internalMarkAsReady

protected void internalMarkAsReady()

internalSetParent

protected void internalSetParent(Network parent)

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

isReady

public boolean isReady()

A function suggesting if the zone is made from NativeCallbacks.zoneInfoCallback(boolean, java.lang.String, int, java.lang.String, long[], java.lang.String[], java.lang.String[], java.lang.Object) or because of state retrieval.

Returns:

boolean: states if the zone is dummy ot not.

iterator

public java.util.Iterator<Resource> iterator()

Specified by:

iterator in interface java.lang.Iterable<Resource>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object