Zone (cococlientsdk-java 0.28.2 API)

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 is container that holds resources. Zone usually represents specific environment such as living area, dinning area, office room, gardening area to name a few.
Zone class is a blueprint of a zone present in the network.
Zone can be created using Network.createZone(String, Network.NetworkManagementStatusListener), deleted using Network.deleteZone(Zone, Network.NetworkManagementStatusListener), modified using Network.moveResources(Zone, Zone, Resource[], Network.NetworkManagementStatusListener) by user. All networks by default contain the default zone, which is identified by DEFAULT_ZONE_ID.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_ZONE_ID
ID of default zone.

static java.lang.String defaultZoneName
Name of the default zone.

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ZONE_ID` ID of default zone.
`static java.lang.String`	`defaultZoneName` Name of the default zone.

Constructor Summary

Constructors
Modifier Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`containsResource(Resource resource)` A function to check if a `Resource` exists in the zone.
`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)` A function that would be triggered when a `Resource` is added to this zone.
`protected void`	`internalMarkAsReady()` A function that would be triggered to mark this zone as ready.
`protected void`	`internalRemoveResource(Resource resource)` A function that would be triggered when a `Resource` is removed from this zone.
`protected void`	`internalSetName(java.lang.String name)` A function that would be triggered when `zoneName` is updated.
`protected void`	`internalSetParent(Network parent)` A function that would be triggered when `parent` is updated.
`boolean`	`isReady()` A function suggesting if the zone is created from `NativeCallbacks.zoneInfoCallback(boolean, java.lang.String, int, java.lang.String, long[], java.lang.String[], java.lang.String[], java.lang.Object)` or retrieved from cache.
`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
```
    Name of the default zone. Note: default zone name can't be changed.
  - DEFAULT_ZONE_ID
```
public static final int DEFAULT_ZONE_ID
```
    ID of default zone. Note: Default zone ID can't be changed.
    
    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.
```
   
     livingRoom
     .setName(newName, (commandStatus, throwable) &#45;&gt; {
      if (null != throwable) {
        // client specific code.
      }
     });
   
 
```
    Parameters:
    
    name - The name that has to be set.
    
    listener - Listener which will get called with response.
  - internalAddResource
```
protected void internalAddResource(Resource resource)
```
    A function that would be triggered when a Resource is added to this zone.
    
    Parameters:
    
    resource - Resource that is added to this zone.
  - internalRemoveResource
```
protected void internalRemoveResource(Resource resource)
```
    A function that would be triggered when a Resource is removed from this zone.
    
    Parameters:
    
    resource - Resource that is removed from the zone.
  - containsResource
```
protected boolean containsResource(Resource resource)
```
    A function to check if a Resource exists in the zone.
    
    Parameters:
    
    resource - Resource that needs to looked up in the zone.
    
    Returns:
    
    boolean - flag representing whether Resource with given ID is present in the zone.
  - internalSetName
```
protected void internalSetName(java.lang.String name)
```
    A function that would be triggered when zoneName is updated.
    
    Parameters:
    
    name - Updated name of the zone.
  - internalMarkAsReady
```
protected void internalMarkAsReady()
```
    A function that would be triggered to mark this zone as ready.
  - internalSetParent
```
protected void internalSetParent(Network parent)
```
    A function that would be triggered when parent is updated.
    
    Parameters:
    
    parent - parent network of the zone.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - isReady
```
public boolean isReady()
```
    A function suggesting if the zone is created from NativeCallbacks.zoneInfoCallback(boolean, java.lang.String, int, java.lang.String, long[], java.lang.String[], java.lang.String[], java.lang.Object) or retrieved from cache.
    
    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

Class Zone

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

defaultZoneName

DEFAULT_ZONE_ID

Constructor Detail

Zone

Method Detail

getId

getName

getResources

getParent

setName

internalAddResource

internalRemoveResource

containsResource

internalSetName

internalMarkAsReady

internalSetParent

hashCode

isReady

iterator

toString