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

List of all members.

Public Member Functions
T	getResult ()
StatusCode	getStatusCode ()
String	getStatusMessage ()
boolean	isSuccess ()
	Response (int statusCode, String statusMessage, T value)
	Response (StatusCode statusCode, String statusMessage, T value)
List< Object >	toList ()
String	toString ()
Static Public Member Functions
static< T > Response< T >	fromListChecked (List< Object > response, ResultFactory< T > resultFactory) throws RemoteException
static< T > Response< T >	fromListCheckedFailure (List< Object > response, ResultFactory< T > resultFactory) throws RemoteException
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)
Private Attributes
final T	result
final StatusCode	statusCode
final String	statusMessage

---

Detailed Description

The response from an XML-RPC call.

Author:

damonkohler@google.com (Damon Kohler)

Parameters:

<T>

Definition at line 33 of file Response.java.

---

Constructor & Destructor Documentation

org.ros.internal.node.response.Response< T >.Response	(	int	statusCode,
		String	statusMessage,
		T	value
	)		[inline]

Definition at line 128 of file Response.java.

org.ros.internal.node.response.Response< T >.Response	(	StatusCode	statusCode,
		String	statusMessage,
		T	value
	)		[inline]

Definition at line 132 of file Response.java.

---

Member Function Documentation

static <T> Response<T> org.ros.internal.node.response.Response< T >.fromListChecked	(	List< Object >	response,
		ResultFactory< T >	resultFactory
	)		throws RemoteException [inline, static]

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

Parameters:

<T>
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

Exceptions:

RemoteException

if the Response's StatusCode does not indicate success

Definition at line 107 of file Response.java.

static <T> Response<T> org.ros.internal.node.response.Response< T >.fromListCheckedFailure	(	List< Object >	response,
		ResultFactory< T >	resultFactory
	)		throws RemoteException [inline, static]

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

Parameters:

<T>
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

Exceptions:

RemoteException

if the Response's StatusCode indicates StatusCode.FAILURE.

Definition at line 68 of file Response.java.

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

(

)

[inline]

Definition at line 150 of file Response.java.

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

(

)

[inline]

Definition at line 142 of file Response.java.

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

(

)

[inline]

Definition at line 146 of file Response.java.

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

(

)

[inline]

Definition at line 159 of file Response.java.

static <T> Response<T> org.ros.internal.node.response.Response< T >.newError	(	String	message,
		T	value
	)		[inline, static]

Definition at line 39 of file Response.java.

static <T> Response<T> org.ros.internal.node.response.Response< T >.newFailure	(	String	message,
		T	value
	)		[inline, static]

Definition at line 43 of file Response.java.

static <T> Response<T> org.ros.internal.node.response.Response< T >.newSuccess	(	String	message,
		T	value
	)		[inline, static]

Definition at line 47 of file Response.java.

List<Object> org.ros.internal.node.response.Response< T >.toList

(

)

[inline]

Definition at line 138 of file Response.java.

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

(

)

[inline]

Definition at line 155 of file Response.java.

---

Member Data Documentation

final T org.ros.internal.node.response.Response< T >.result [private]

Definition at line 37 of file Response.java.

final StatusCode org.ros.internal.node.response.Response< T >.statusCode [private]

Definition at line 35 of file Response.java.

final String org.ros.internal.node.response.Response< T >.statusMessage [private]

Definition at line 36 of file Response.java.

---

The documentation for this class was generated from the following file:

• Response.java