com.kapowtech.robosuite.api.java.rql.construct

Class RobotOutputObjectResponse

java.lang.Object

com.kapowtech.robosuite.api.java.rql.construct.RQLConstruct

com.kapowtech.robosuite.api.java.rql.construct.RQLResponse

com.kapowtech.robosuite.api.java.rql.construct.RobotResponse

com.kapowtech.robosuite.api.java.rql.construct.RobotOutputObjectResponse

All Implemented Interfaces:

java.io.Serializable

public final class RobotOutputObjectResponse
extends RobotResponse

A RobotOutputObjectResponse is a RobotResponse that contains an extracted object.

The RobotOutputObjectResponse has an extractedObject property whose value is the extracted object.

See Also:

ExecuteRequest, RQLObject, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RobotOutputObjectResponse(java.util.Date date, java.lang.String robotURL, java.lang.String executionId, int robotRunId, int robotId, RQLObject outputObject) Creates a RobotOutputObjectResponse with the specified property values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true if this object and the specified object have the same property values, and false otherwise.
RQLObject	getOutputObject() Returns the output object.
int	hashCode() Returns the hash code of this object based on property values.
java.lang.String	toString() Returns a human readable string representation of this object.

Methods inherited from class com.kapowtech.robosuite.api.java.rql.construct.RobotResponse

getExecutionId, getRobotId, getRobotRunId, getRobotURL

Methods inherited from class com.kapowtech.robosuite.api.java.rql.construct.RQLResponse

getDate

Methods inherited from class java.lang.Object

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

Constructor Detail

RobotOutputObjectResponse

public RobotOutputObjectResponse(java.util.Date date,
                                 java.lang.String robotURL,
                                 java.lang.String executionId,
                                 int robotRunId,
                                 int robotId,
                                 RQLObject outputObject)

Creates a RobotOutputObjectResponse with the specified property values. This constrictor is subject to change if the RQL protocol is extended

Parameters:

date - the date at which the response was created by the server.

robotURL - the robot file URL.

executionId - the execution id.

robotRunId - the robot run id.

robotId - the robot id.

outputObject - the output object.

Throws:

java.lang.NullPointerException - if the outputObject parameter is null.

Method Detail

getOutputObject

public RQLObject getOutputObject()

Returns the output object.

Returns:

the output object.

equals

public boolean equals(java.lang.Object obj)

Returns true if this object and the specified object have the same property values, and false otherwise.

Overrides:

equals in class RobotResponse

Parameters:

obj - the object to test for equality.

Returns:

true if this object and the specified object have the same property values, and false otherwise.

hashCode

public int hashCode()

Returns the hash code of this object based on property values.

Overrides:

hashCode in class RobotResponse

Returns:

the hash code of this object based on property values.

toString

public java.lang.String toString()

Returns a human readable string representation of this object.

Overrides:

toString in class RobotResponse

Returns:

a human readable string representation of this object.