buzz.getcoco.iot

Class ResourceAction

java.lang.Object

buzz.getcoco.iot.ResourceAction

public class ResourceAction
extends java.lang.Object

Resource action defines action to be taken on a resource, which shall be altering attribute value of certain capability of that resource.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RESOURCE_ACTION_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
	ResourceAction(Capability capability, Command<? extends Capability.CommandId> command) This class is used to represent the action.
protected	ResourceAction(int id, Capability capability, Command<? extends Capability.CommandId> command) This class is used to represent the action.

Method Summary

Modifier and Type	Method and Description
static ResourceAction	fromJson(java.lang.String jsonAction) A function to create resource action from JSON.
Capability	getCapability() A function to get the capability on which the command will be executed.
Command<? extends Capability.CommandId>	getCommand() A function to get the command which get executed while executing the resourceAction.
int	getId() A function to get the identifier of the current object.
java.lang.String	toJson() A function to make this ResourceAction to a serialized string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESOURCE_ACTION_ID

public static final int DEFAULT_RESOURCE_ACTION_ID

See Also:

Constant Field Values

Constructor Detail

ResourceAction

public ResourceAction(Capability capability,
                      Command<? extends Capability.CommandId> command)

This class is used to represent the action.

Parameters:

capability - The capability to which the command will be sent

command - The command which will get executed

ResourceAction

protected ResourceAction(int id,
                         Capability capability,
                         Command<? extends Capability.CommandId> command)

This class is used to represent the action.

Parameters:

id - The id of the action

capability - The capability to which the command will be sent

command - The command which will get executed

Method Detail

getId

public int getId()

A function to get the identifier of the current object.

Returns:

int: The identifier

getCommand

public Command<? extends Capability.CommandId> getCommand()

A function to get the command which get executed while executing the resourceAction.

Returns:

Command: The executing command

getCapability

public Capability getCapability()

A function to get the capability on which the command will be executed.

Returns:

Capability: The capability on which the command will be executed.

toJson

public java.lang.String toJson()

A function to make this ResourceAction to a serialized string. NOTE: This mustn't be used to add/edit existing resourceActions.

Returns:

returns a String that represents the json format of the class

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fromJson

public static ResourceAction fromJson(java.lang.String jsonAction)

A function to create resource action from JSON.

Parameters:

jsonAction - The stringified Json format of the resourceAction

Returns:

ResourceAction: the ResourceAction that has been recreated from the json string