Resource (IBM Watson IoT SDK 0.2.1 API)

java.lang.Object
- com.ibm.wiotp.sdk.devicemgmt.resource.Resource<T>

Direct Known Subclasses:

DateResource, DeviceFirmware, DeviceInfo, DeviceLocation, DeviceMetadata, DeviceMgmt, NumberResource, StringResource
```
public abstract class Resource<T>
extends Object
```
An internal class that provides a a tree like resource model to handle update or establish observe relation on fields/objects requested by Watson IoT Platform

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Resource.ChangeListenerType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Resource.ChangeListenerType`

Field Summary

Fields
Modifier and Type Field and Description

static int RESPONSE_TIMEOUT

static String ROOT_RESOURCE_NAME

Fields
Modifier and Type	Field and Description
`static int`	`RESPONSE_TIMEOUT`
`static String`	`ROOT_RESOURCE_NAME`

Constructor Summary

Constructors
Constructor and Description

Resource(String resourceResourceName)

Resource(String resourceResourceName, T value)

Constructors
Constructor and Description
`Resource(String resourceResourceName)`
`Resource(String resourceResourceName, T value)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Resource child)`
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a new listener to be notified when the value is changed.
`void`	`addPropertyChangeListener(Resource.ChangeListenerType type, PropertyChangeListener listener)` Add a new listener to be notified when the location is changed.
`protected void`	`fireEvent(boolean fire)`
`void`	`fireEvent(String event)`
`String`	`getCanonicalName()`
`Resource`	`getChild(String resourceResourceName)`
`Collection<Resource>`	`getChildren()`
`Resource`	`getParent()`
`int`	`getRC()` Returns the return code of the last location update notification.
`String`	`getResourceName()`
`boolean`	`getResponseRequired()`
`T`	`getValue()`
`void`	`notifyExternalListeners()`
`boolean`	`remove(Resource child)`
`Resource`	`remove(String resourceResourceName)` Removes the child with the specified resourceResourceName and returns it.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Remove the specified listener.
`void`	`setParent(Resource parent)`
`void`	`setRC(int rc)` Used by the client library to set return code received in the response from Watson IoT Platform.
`void`	`setValue(T value)`
`void`	`setValue(T value, boolean fireEvent)`
`abstract com.google.gson.JsonElement`	`toJsonObject()`
`abstract int`	`update(com.google.gson.JsonElement json)`
`abstract int`	`update(com.google.gson.JsonElement json, boolean fireEvent)`
`void`	`waitForResponse(boolean responseRequired)` Requests that Watson IoT Platform to respond when it receives update notification.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- ROOT_RESOURCE_NAME
```
public static final String ROOT_RESOURCE_NAME
```
  See Also:
  
  Constant Field Values
- RESPONSE_TIMEOUT
```
public static final int RESPONSE_TIMEOUT
```
  See Also:
  
  Constant Field Values

Constructor Detail

Resource

public Resource(String resourceResourceName)

Resource

public Resource(String resourceResourceName,
                T value)

Method Detail
- getValue
```
public T getValue()
```
- setValue
```
public void setValue(T value)
```
- setValue
```
public void setValue(T value,
                     boolean fireEvent)
```
- fireEvent
```
protected void fireEvent(boolean fire)
```
- fireEvent
```
public void fireEvent(String event)
```
- notifyExternalListeners
```
public void notifyExternalListeners()
```
- add
```
public void add(Resource child)
```
- remove
```
public boolean remove(Resource child)
```
- remove
```
public Resource remove(String resourceResourceName)
```
  Removes the child with the specified resourceResourceName and returns it. If no child with the specified resourceResourceName is found, the return value is null.
  
  Parameters:
  
  resourceResourceName - the resourceResourceName
  
  Returns:
  
  the removed resource or null
- getParent
```
public Resource getParent()
```
- setParent
```
public void setParent(Resource parent)
```
- getChild
```
public Resource getChild(String resourceResourceName)
```
- getResourceName
```
public String getResourceName()
```
- getCanonicalName
```
public String getCanonicalName()
```
- getChildren
```
public Collection<Resource> getChildren()
```
- toJsonObject
```
public abstract com.google.gson.JsonElement toJsonObject()
```
- addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
  Add a new listener to be notified when the value is changed.
  
  Parameters:
  
  listener - PropertyChangeListener
- addPropertyChangeListener
```
public void addPropertyChangeListener(Resource.ChangeListenerType type,
                                      PropertyChangeListener listener)
```
  Add a new listener to be notified when the location is changed.
  
  Parameters:
  
  type - The type of listener
  
  listener - PropertyChangeListener
- removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
  Remove the specified listener.
  
  Parameters:
  
  listener - PropertyChangeListener
- update
```
public abstract int update(com.google.gson.JsonElement json)
```
- update
```
public abstract int update(com.google.gson.JsonElement json,
                           boolean fireEvent)
```
- waitForResponse
```
public void waitForResponse(boolean responseRequired)
```
  Requests that Watson IoT Platform to respond when it receives update notification. This implies that the update call will be blocked until a response is received or timed out.
  
  Parameters:
  
  responseRequired - boolean specifying whether response is required or not
- getRC
```
public int getRC()
```
  Returns the return code of the last location update notification.
  Note 200 is successful.
  
  Returns:
  
  Return code
- setRC
```
public void setRC(int rc)
```
  Used by the client library to set return code received in the response from Watson IoT Platform.
  
  Parameters:
  
  rc - return code to be set
- getResponseRequired
```
public boolean getResponseRequired()
```

Methods inherited from class java.lang.Object

ROOT_RESOURCE_NAME

RESPONSE_TIMEOUT

Resource

Resource

getValue

setValue

setValue

fireEvent

fireEvent

notifyExternalListeners

add

remove

remove

getParent

setParent

getChild

getResourceName

getCanonicalName

getChildren

toJsonObject

addPropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

update

update

waitForResponse

getRC

setRC

getResponseRequired