Binary (Kofax RPA Java API)

java.lang.Object
- com.kapowtech.robosuite.api.java.rest.Binary

All Implemented Interfaces:

java.lang.Cloneable
```
public final class Binary
extends java.lang.Object
implements java.lang.Cloneable
```
Represents a Binary Robot value. The Binary type represents a binary object of some sort.
Instances of this class are immutable.
This class is similar in philosophy to the Collection classes, and a Binary object can be viewed as an immutable ArrayList of bytes. The getInputStream() allows an Iterator-like approach.

Constructor Summary

Constructors
Constructor and Description
`Binary(byte[] bytes)` Creates a new binary object from a byte array.
`Binary(byte[] bytes, int offset, int length)` Creates a new binary object from a byte array.
`Binary(java.io.InputStream in)` Creates a new binary object from a byte input stream.
`Binary(java.lang.String base64)` Creates a new byte array from a base 64 encoded string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates and returns a deep copy of this object.
`boolean`	`equals(java.lang.Object obj)` Returns `true` if this object and the specified object have the same property values, and false otherwise.
`byte`	`get(int index)` Returns the byte at the specified index.
`java.io.ByteArrayInputStream`	`getInputStream()` Returns an input stream that can be used to read from the internal byte array.
`int`	`hashCode()` Returns the hash code of this object based on property values.
`boolean`	`isEmpty()` Returns `true` if this object contains no bytes.
`int`	`size()` Returns the number of bytes in the array.
`java.lang.String`	`toBase64String()` Returns a Base64 encoded representation of the bytes in the array.
`byte[]`	`toByteArray()` Returns the bytes in the object as a `byte[]` instance.
`java.lang.String`	`toString()` Returns a human-readable string representation of this object.
`static Binary`	`valueOfBase64(java.lang.String s)` Returns a new `Binary` object with a value represented by the specified Base64 encoded string.
`void`	`writeTo(java.io.OutputStream out)` Writes the contents of this object to a stream.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Binary
```
public Binary(byte[] bytes)
```
    Creates a new binary object from a byte array.
    
    Parameters:
    
    bytes - the byte array to construct the object from.
    
    Throws:
    
    java.lang.NullPointerException - if the bytes parameter is null.
  - Binary
```
public Binary(byte[] bytes,
              int offset,
              int length)
```
    Creates a new binary object from a byte array.
    
    Parameters:
    
    bytes - the byte array to construct the object from.
    
    offset - starting position in buffer
    
    length - number of bytes
    
    Throws:
    
    java.lang.NullPointerException - if the bytes parameter is null.
  - Binary
```
public Binary(java.io.InputStream in)
       throws java.io.IOException
```
    Creates a new binary object from a byte input stream.
    The caller is responsible for closing the input stream.
    
    Parameters:
    
    in - the input stream to read the bytes from.
    
    Throws:
    
    java.io.IOException - if an I/O error occurs when reading the byte stream.
  - Binary
```
public Binary(java.lang.String base64)
```
    Creates a new byte array from a base 64 encoded string.
    
    Parameters:
    
    base64 - a Base64 encoded string.
- Method Detail
  - valueOfBase64
```
public static Binary valueOfBase64(java.lang.String s)
```
    Returns a new Binary object with a value represented by the specified Base64 encoded string.
    
    Parameters:
    
    s - a Base64 encoded string.
    
    Returns:
    
    the Binary value representing the string.
    
    See Also:
    
    toBase64String()
  - get
```
public byte get(int index)
```
    Returns the byte at the specified index.
    
    Parameters:
    
    index - the index of the byte to retrieve.
    
    Returns:
    
    the byte at the specified index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the given index is out of range (index < 0 || index >= size()).
  - size
```
public int size()
```
    Returns the number of bytes in the array.
    
    Returns:
    
    the number of bytes in the array.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this object contains no bytes.
    
    Returns:
    
    true if this object contains no bytes.
  - toByteArray
```
public byte[] toByteArray()
```
    Returns the bytes in the object as a byte[] instance.
    Note that this method performs a deep copy of the bytes.
    
    Returns:
    
    the bytes in the object as a byte[] instance.
  - getInputStream
```
public java.io.ByteArrayInputStream getInputStream()
```
    Returns an input stream that can be used to read from the internal byte array.
    
    Returns:
    
    an input stream that can be used to read from the internal byte array.
  - 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 byte array, 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.
  - clone
```
public java.lang.Object clone()
```
    Creates and returns a deep copy of this object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a clone of this instance.
    
    See Also:
    
    Cloneable
  - toBase64String
```
public java.lang.String toBase64String()
```
    Returns a Base64 encoded representation of the bytes in the array. This can be useful if the contents of the array need to be transported in a text format.
    
    Returns:
    
    a Base64 encoded representation of the bytes in the array.
  - writeTo
```
public void writeTo(java.io.OutputStream out)
             throws java.io.IOException
```
    Writes the contents of this object to a stream. This has the same effect as calling out.write(binary.toByteArray()), except that it doesn't involve copying the array.
    
    Parameters:
    
    out - the output stream to write to.
    
    Throws:
    
    java.io.IOException - if an I/O error prevented us from writing to the stream.

Class Binary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Binary

Binary

Binary

Binary

Method Detail

valueOfBase64

get

size

isEmpty

toByteArray

getInputStream

equals

hashCode

toString

clone

toBase64String

writeTo