com.oracle.iot.client.message

Class Resource.Builder

java.lang.Object

com.oracle.iot.client.message.Resource.Builder

Enclosing class:

Resource

public static final class Resource.Builder
extends java.lang.Object

Resource class is immutable. A builder is required when creating new Resource.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor - does nothing.

Method Summary

Modifier and Type	Method and Description
Resource	build() Builds (creates) new instance of Resource.
Resource.Builder	endpointName(java.lang.String endpointName) Sets the name or ID of the resource's endpoint.
Resource.Builder	fromJson(org.json.JSONObject resObject)
Resource.Builder	method(Resource.Method method) Sets the method value for the resource.
Resource.Builder	methods(java.util.List<Resource.Method> methods) Sets the method values for the resource.
Resource.Builder	name(java.lang.String name) Sets the name of the resource.
Resource.Builder	path(java.lang.String path) Sets the path of the resource.
Resource.Builder	status(Resource.Status status) Sets the status value for the resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor - does nothing.

Method Detail

endpointName

public Resource.Builder endpointName(java.lang.String endpointName)

Sets the name or ID of the resource's endpoint.

Parameters:

endpointName - name or ID of the resource's endpoint.

Returns:

Builder with the endpointName added.

path

public Resource.Builder path(java.lang.String path)

Sets the path of the resource. path must be unique for all resources within an endpoint.

Parameters:

path - Uri of the resource. Must be unique and must not be null.

Returns:

Builder with already set path field.

name

public Resource.Builder name(java.lang.String name)

Sets the name of the resource.

Parameters:

name - name of the resource.

Returns:

Builder with added name

status

public Resource.Builder status(Resource.Status status)

Sets the status value for the resource. The default is Resource.Status.ADDED if no status or a null status is specified.

Parameters:

status - the status of the resource.

Returns:

a Builder with the specified status added.

method

public Resource.Builder method(Resource.Method method)

Sets the method value for the resource. The default is an empty list if no method or a null method is specified.

Parameters:

method - status of the resource

Returns:

a Builder with the specified method added.

methods

public Resource.Builder methods(java.util.List<Resource.Method> methods)

Sets the method values for the resource. The default is an empty list if no method or a null methods is specified.

Parameters:

methods - a List of methods supported by the resource.

Returns:

a Builder with the specified methods added.

fromJson

public final Resource.Builder fromJson(org.json.JSONObject resObject)

build

public Resource build()

Builds (creates) new instance of Resource.

Returns:

new instance of Resource