edu.wpi.rail.jrosbridge.services

Class ServiceResponse

java.lang.Object

edu.wpi.rail.jrosbridge.JsonWrapper

edu.wpi.rail.jrosbridge.services.ServiceResponse

Direct Known Subclasses:

Empty.Response

public class ServiceResponse
extends JsonWrapper

ServiceResponse objects are used for making a response to a service. These service responses act as wrappers around JSON objects. Service response data is immutable.

Version:

April 1, 2014

Author:

Russell Toris - rctoris@wpi.edu

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_MESSAGE The String representation of an empty service response in JSON.

Fields inherited from class edu.wpi.rail.jrosbridge.JsonWrapper

EMPTY_JSON

Constructor Summary

Constructors

Constructor and Description
ServiceResponse() Create a new, empty service response.
ServiceResponse(javax.json.JsonObject jsonObject, boolean result) Create a ServiceResponse based on the given JSON object.
ServiceResponse(javax.json.JsonObject jsonObject, String serviceResponseType, boolean result) Create a ServiceResponse based on the given JSON object.
ServiceResponse(String jsonString, boolean result) Create a ServiceResponse based on the given String representation of a JSON object.
ServiceResponse(String jsonString, String serviceResponseType, boolean result) Create a ServiceResponse based on the given String representation of a JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceResponse	clone() Create a clone of this ServiceResponse.
boolean	getResult() Get the result flag of this response (i.e., if the service server returned a success).
String	getServiceResponseType() Get the type of the service response if one was set.
void	setServiceResponseType(String serviceResponseType) Set the type of the service response.

Methods inherited from class edu.wpi.rail.jrosbridge.JsonWrapper

equals, hashCode, toJsonObject, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_MESSAGE

public static final String EMPTY_MESSAGE

The String representation of an empty service response in JSON.

See Also:

Constant Field Values

Constructor Detail

ServiceResponse

public ServiceResponse()

Create a new, empty service response. The type will be set to the empty string.

ServiceResponse

public ServiceResponse(String jsonString,
               boolean result)

Create a ServiceResponse based on the given String representation of a JSON object. The type will be set to the empty string.

Parameters:

jsonString - The JSON String to parse.

result - The result flag for the response (i.e., if the service server returned a success).

ServiceResponse

public ServiceResponse(String jsonString,
               String serviceResponseType,
               boolean result)

Create a ServiceResponse based on the given String representation of a JSON object.

Parameters:

jsonString - The JSON String to parse.

serviceResponseType - The type of the service response (e.g., "std_srvs/Empty").

result - The result flag for the response (i.e., if the service server returned a success).

ServiceResponse

public ServiceResponse(javax.json.JsonObject jsonObject,
               boolean result)

Create a ServiceResponse based on the given JSON object. The type will be set to the empty string.

Parameters:

jsonObject - The JSON object containing the service response data.

result - The result flag for the response (i.e., if the service server returned a success).

ServiceResponse

public ServiceResponse(javax.json.JsonObject jsonObject,
               String serviceResponseType,
               boolean result)

Create a ServiceResponse based on the given JSON object.

Parameters:

jsonObject - The JSON object containing the service response data.

serviceResponseType - The type of the service response (e.g., "std_srvs/Empty").

result - The result flag for the response (i.e., if the service server returned a success).

Method Detail

getServiceResponseType

public String getServiceResponseType()

Get the type of the service response if one was set.

Returns:

The type of the service response.

getResult

public boolean getResult()

Get the result flag of this response (i.e., if the service server returned a success).

Returns:

The result flag for the response.

setServiceResponseType

public void setServiceResponseType(String serviceResponseType)

Set the type of the service response.

Parameters:

serviceResponseType - The type of the service response (e.g., "std_srvs/Empty").

clone

public ServiceResponse clone()

Create a clone of this ServiceResponse.

Specified by:

clone in class JsonWrapper