Package org.ros.internal.node.response

Class Response<T>

java.lang.Object

org.ros.internal.node.response.Response<T>

Type Parameters:

T -

public class Response<T>
extends Object

The response from an XML-RPC call.

Author:

damonkohler@google.com (Damon Kohler)

Constructor Summary

Constructors

Constructor	Description
Response(int statusCode, String statusMessage, T value)
Response(StatusCode statusCode, String statusMessage, T value)

Method Summary

Modifier and Type	Method	Description
static <T> Response<T>	fromListChecked(List<Object> response, ResultFactory<T> resultFactory)	Creates a Response from the List of Objects returned from an XML-RPC call.
static <T> Response<T>	fromListCheckedFailure(List<Object> response, ResultFactory<T> resultFactory)	Creates a Response from the List of Objects returned from an XML-RPC call.
T	getResult()
StatusCode	getStatusCode()
String	getStatusMessage()
boolean	isSuccess()
static <T> Response<T>	newError(String message, T value)
static <T> Response<T>	newFailure(String message, T value)
static <T> Response<T>	newSuccess(String message, T value)
List<Object>	toList()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Response

public Response(int statusCode,
 String statusMessage,
 T value)

Response

public Response(StatusCode statusCode,
 String statusMessage,
 T value)

Method Details

newError

public static <T> Response<T> newError(String message,
 T value)

newFailure

public static <T> Response<T> newFailure(String message,
 T value)

newSuccess

public static <T> Response<T> newSuccess(String message,
 T value)

fromListCheckedFailure

public static <T> Response<T> fromListCheckedFailure(List<Object> response,
 ResultFactory<T> resultFactory)
                                              throws RemoteException

Creates a Response from the List of Objects returned from an XML-RPC call. Throws RemoteException if the StatusCode is StatusCode.FAILURE.

Type Parameters:

T -

Parameters:

response - the List of Objects returned from the XML-RPC call

resultFactory - a ResultFactory that creates a result from the third Object in the Response

Returns:

a Response using the specified ResultFactory to generate the result

Throws:

RemoteException - if the Response's StatusCode indicates StatusCode.FAILURE.

fromListChecked

public static <T> Response<T> fromListChecked(List<Object> response,
 ResultFactory<T> resultFactory)
                                       throws RemoteException

Creates a Response from the List of Objects returned from an XML-RPC call. Throws RemoteException if the StatusCode is not a success.

Type Parameters:

T -

Parameters:

response - the List of Objects returned from the XML-RPC call

resultFactory - a ResultFactory that creates a result from the third Object in the Response

Returns:

a Response using the specified ResultFactory to generate the result

Throws:

RemoteException - if the Response's StatusCode does not indicate success

toList

public List<Object> toList()

getStatusCode

public StatusCode getStatusCode()

getStatusMessage

public String getStatusMessage()

getResult

public T getResult()

toString

public String toString()

Overrides:

toString in class Object

isSuccess

public boolean isSuccess()