buzz.getcoco.iot

Class InfoResponse

java.lang.Object

buzz.getcoco.iot.InfoResponse

public class InfoResponse
extends java.lang.Object

This class holds response in form of key-value pairs for keys in the Parameter.Key and are received from a node/device. This class can be used to pass as argument to functions like Device.sendInfoResponse(buzz.getcoco.iot.InfoResponse, buzz.getcoco.iot.Device.InfoResponseStatusListener).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InfoResponse.BrandSearchResults This class encapsulates brand information such as id and name.
static class	InfoResponse.ContentPlayback This class forms a value of response corresponding to Parameter.Key.CONTENT_PLAYBACK.
static class	InfoResponse.ContentSearch This class forms a value of response corresponding to Parameter.Key.CONTENT_SEARCH.
static class	InfoResponse.ListenPort This class forms a value of response corresponding to Parameter.Key.AVAIL_LISTEN_PORT.
static class	InfoResponse.RemoteButtonInfo This class acts as value of response corresponding to Parameter.Key.REMOTE_BUTTON_INFO.
static class	InfoResponse.RemotePairingCapabilities This class acts as a value of response corresponding to Parameter.Key.REMOTE_PAIR_CAPABILITIES.
static class	InfoResponse.RemotePairingCode This class acts as value of response corresponding to Parameter.Key.REMOTE_PAIRING_CODES.
static class	InfoResponse.Search This class acts as a value of response corresponding to Parameter.Key.REMOTE_SEARCH.
static interface	InfoResponse.SearchResults A marker interface to classify search results.
static class	InfoResponse.UserDefined This class forms a value of response corresponding to Parameter.Key.USER_DEFINED.
static interface	InfoResponse.Value A marker interface for values corresponding to key as in Parameter.Key for InfoResponse.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	networkId Network.id of Network on which this info response was received /sent.
protected Command.State	state The state of the info response.

Constructor Summary

Constructors

Constructor and Description
InfoResponse(InfoRequest infoRequest, java.util.List<Parameter<InfoResponse.Value>> parameters) Constructor for current class.
InfoResponse(long infoRequestId, long cmdSeqNum, Device device, java.util.List<Parameter<InfoResponse.Value>> parameters) Constructor for current class.
InfoResponse(long infoRequestId, long cmdSeqNum, java.util.List<Parameter<InfoResponse.Value>> parameters) Constructor for current class.
InfoResponse(long infoRequestId, long cmdSeqNum, java.lang.String networkId, long requestNodeId, java.util.List<Parameter<InfoResponse.Value>> parameters) An overloaded constructor for this class.

Method Summary

Modifier and Type	Method and Description
long	getCmdSeqNum() A function to get cmdSeqNum.
Device	getDevice() A function to get device.
long	getInfoRequestId() A function to get infoRequestId.
Parameter.Key[]	getKeys() A function to fetch keys from parameters .
java.util.List<Parameter<InfoResponse.Value>>	getParameters() A function to get parameters.
long	getRequestNodeId() A function to get requestNodeId.
Command.State	getState() A function to get state.
protected void	setCmdSeqNum(long cmdSeqNum) A function to set cmdSeqNum.
void	setDevice(Device device) A function to set request node ID.
protected void	setInfoRequestId(long infoRequestId) A function to set InfoRequest.requestId.
protected void	setRequestNodeId(long requestNodeId) A function to set requestNodeId.
protected com.google.gson.JsonElement	toJson() A function to serialize this class as JsonElement.

Methods inherited from class java.lang.Object

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

Field Detail

state

protected transient Command.State state

The state of the info response.

networkId

protected transient java.lang.String networkId

Network.id of Network on which this info response was received /sent.

Constructor Detail

InfoResponse

public InfoResponse(InfoRequest infoRequest,
                    java.util.List<Parameter<InfoResponse.Value>> parameters)

Constructor for current class.

Parameters:

infoRequest - InfoRequest corresponding to this response

parameters - collection of value responses

InfoResponse

public InfoResponse(long infoRequestId,
                    long cmdSeqNum,
                    java.util.List<Parameter<InfoResponse.Value>> parameters)

Constructor for current class.

Parameters:

infoRequestId - ID of the info response.

cmdSeqNum - command sequence of info response.

parameters - collection of value responses.

InfoResponse

public InfoResponse(long infoRequestId,
                    long cmdSeqNum,
                    Device device,
                    java.util.List<Parameter<InfoResponse.Value>> parameters)

Constructor for current class.

Parameters:

infoRequestId - ID of the info response.

cmdSeqNum - command sequence of info response.

device - device on which this info response was received.

parameters - collection of value responses.

InfoResponse

public InfoResponse(long infoRequestId,
                    long cmdSeqNum,
                    java.lang.String networkId,
                    long requestNodeId,
                    java.util.List<Parameter<InfoResponse.Value>> parameters)

An overloaded constructor for this class.

Parameters:

infoRequestId - id for the info request for which this response is being created

cmdSeqNum - command sequence number

networkId - The network to which the device belongs

requestNodeId - The node from which infoRequest came by or the device from which response is received

parameters - The params which are responded

Method Detail

getState

public Command.State getState()

A function to get state.

Returns:

Command.State.

setDevice

public void setDevice(Device device)

A function to set request node ID.

Parameters:

device - Device whose ID needs to be set to requestNodeId.

getDevice

public Device getDevice()

A function to get device.

Returns:

Device on which this info response was received.

setCmdSeqNum

protected void setCmdSeqNum(long cmdSeqNum)

A function to set cmdSeqNum.

Parameters:

cmdSeqNum - Command sequence ID.

setInfoRequestId

protected void setInfoRequestId(long infoRequestId)

A function to set InfoRequest.requestId.

Parameters:

infoRequestId - Request ID.

getParameters

public java.util.List<Parameter<InfoResponse.Value>> getParameters()

A function to get parameters.

Returns:

parameters.

getKeys

public Parameter.Key[] getKeys()

A function to fetch keys from parameters .

Returns:

The array of keys in the parameters

setRequestNodeId

protected void setRequestNodeId(long requestNodeId)

A function to set requestNodeId.

Parameters:

requestNodeId - request node id that needs to be set.

getRequestNodeId

public long getRequestNodeId()

A function to get requestNodeId.

Returns:

requestNodeId.

getInfoRequestId

public long getInfoRequestId()

A function to get infoRequestId.

Returns:

infoRequestId.

getCmdSeqNum

public long getCmdSeqNum()

A function to get cmdSeqNum.

Returns:

cmdSeqNum.

toJson

protected com.google.gson.JsonElement toJson()

A function to serialize this class as JsonElement.

Returns:

InfoResponse as JsonElement.