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

Class EmbeddedFileBasedRobotLibrary

java.lang.Object

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

All Implemented Interfaces:

FileBasedRobotLibrary, RobotLibrary, java.io.Serializable

public final class EmbeddedFileBasedRobotLibrary
extends java.lang.Object
implements FileBasedRobotLibrary

Represents a robot library that will be embedded in the ExecuteRequest that is sent to the robot server.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EmbeddedFileBasedRobotLibrary(Binary libraryBytes) Creates a new robot library that will be embedded in the message sent to RoboServer.
EmbeddedFileBasedRobotLibrary(byte[] libraryBytes) Creates a new robot library that will be embedded in the message sent to RoboServer.
EmbeddedFileBasedRobotLibrary(java.io.InputStream in) Creates a new robot library that will be embedded in the message sent to RoboServer.

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.
byte[]	getBytes() Deprecated. This method has been renamed toByteArray(). The name getBytes implied a low- or no-cost operation. In fact the operation entailed copying the internal byte array.
java.io.InputStream	getInputStream() Returns a byte input stream that can be used to read the raw, packed robot library.
int	getSize() Returns the number of bytes in the embedded packed library.
int	hashCode() Returns the hash code of this object based on property values.
java.lang.String	toBase64String() Returns a Base64 encoded representation of the bytes in the embedded library.
byte[]	toByteArray() Returns the embedded robot library, as an array of bytes.
java.lang.String	toString() Returns a human readable string representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedFileBasedRobotLibrary

public EmbeddedFileBasedRobotLibrary(java.io.InputStream in)
                              throws java.io.IOException

Creates a new robot library that will be embedded in the message sent to RoboServer.

When the constructor is called, the library is read from the underlying stream. Because this can be costly, it is recommended that the same instance of this class is reused. This is safe, because the class is immutable and can be shared among many different threads.

The caller is responsible for closing the input stream.

Parameters:

in - the InputStream to read the library file from.

Throws:

java.io.IOException - if the input stream could not be read for some reason.

EmbeddedFileBasedRobotLibrary

public EmbeddedFileBasedRobotLibrary(byte[] libraryBytes)

Creates a new robot library that will be embedded in the message sent to RoboServer. This constructor embeds the actual bytes that is given as a parameter.

Parameters:

libraryBytes - the bytes to embed in the request.

Throws:

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

EmbeddedFileBasedRobotLibrary

public EmbeddedFileBasedRobotLibrary(Binary libraryBytes)

Creates a new robot library that will be embedded in the message sent to RoboServer. The constructor embeds the bytes, represented as a Binary object in the request.

Parameters:

libraryBytes - the bytes to embed in the request.

Throws:

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

Method Detail

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns a byte input stream that can be used to read the raw, packed robot library.

Returns:

a byte input stream that can be used to read the raw, packed robot library.

Throws:

java.io.IOException - if an I/O error prevents us from reading the library bytes.

getBytes

public byte[] getBytes()

Deprecated. This method has been renamed toByteArray(). The name getBytes implied a low- or no-cost operation. In fact the operation entailed copying the internal byte array.

Returns the embedded robot library, as a sequence of bytes.

Returns:

the embedded robot library, as a sequence of bytes.

toByteArray

public byte[] toByteArray()

Returns the embedded robot library, as an array of bytes.

Returns:

the embedded robot library, as a sequence of bytes.

toBase64String

public java.lang.String toBase64String()

Returns a Base64 encoded representation of the bytes in the embedded library. This can be useful if the contents of the library need to be transported in a text format.

Returns:

a Base64 encoded representation of the bytes in the array.

getSize

public int getSize()

Returns the number of bytes in the embedded packed library.

Returns:

the number of bytes in the embedded packed library

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 java.lang.Object

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. The hash code uses a relatively cheap algorithm for sampling the packed library, and does not incur any special overhead.

Overrides:

hashCode in class java.lang.Object

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 java.lang.Object

Returns:

a human readable string representation of this object.