buzz.getcoco.iot

Class CommandResponse<T extends CommandIdInterface>

java.lang.Object

buzz.getcoco.iot.CommandResponse<T>

Type Parameters:

T - The CommandIdInterface which can uniquely identify the type of the command.

public final class CommandResponse<T extends CommandIdInterface>
extends java.lang.Object

This class is a blueprint for Command Response received as JSON and encapsulates Command with it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandResponse.Args<T> Args found in JSON response.
static class	CommandResponse.Error Error class contains information about the CommandResponse.ErrorCode, error message and field in response.
static class	CommandResponse.ErrorCode This class covers possible integer error codes as final constant fields, used to create Error objects.

Method Summary

Modifier and Type	Method and Description
CommandResponse.Args<T>	getArgs() A function used to generate args from JSON response.
Command<T>	getCommand() A function to get the command corresponding to the response.
CommandResponse.Error	getError() A function to get the error occurred while executing this command.
Command.State	getState() This function is used to get the state of the command.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getState

public Command.State getState()

This function is used to get the state of the command.

Returns:

State: The enum denoting the state of the command.

getError

public CommandResponse.Error getError()

A function to get the error occurred while executing this command.

getCommand

public Command<T> getCommand()

A function to get the command corresponding to the response.

Returns:

get the executed command

getArgs

public CommandResponse.Args<T> getArgs()

A function used to generate args from JSON response.

Returns:

args corresponding to Command.DeviceTag, Command.NetworkTag and Command.CapabilityTag

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object