XdevBlob (XDEV Application Framework 6.0.2 API)

java.lang.Object
- xdev.vt.XdevBlob

All Implemented Interfaces:

Serializable, Comparable<ByteHolder>, ByteHolder
```
public class XdevBlob
extends Object
implements ByteHolder, Serializable, Comparable<ByteHolder>
```
The mapping in XDEV for the SQL BLOB type. A XdevBlob stores a Binary Large Object as a column value in a row of a VirtualTable.
The XdevBlob holds either an reference to a Blob object or plain bytes.

Author:

XDEV Software Corp.

See Also:

Blob, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`XdevBlob()` Initializes a new instance of `XdevBlob`.
`XdevBlob(Blob blob)` Initializes a new instance of `XdevBlob`.
`XdevBlob(byte[] bytes)` Initializes a new instance of `XdevBlob`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ByteHolder other)` Compares this `XdevBlob` with another `ByteHolder`.
`boolean`	`equals(Object obj)`
`InputStream`	`getBinaryStream()` Retrieves the BLOB value designated by this Blob instance as a stream.
`InputStream`	`getBinaryStream(int position, int length)` Returns an InputStream object that contains a partial Blob value, starting with the byte specified by pos, which is length bytes in length.
`int`	`getByteAt(int index)` Returns the byte value at the specified index position.
`byte[]`	`getBytes(int position, int length)` Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes.
`int`	`hashCode()` Generates a hashcode for this `XdevBlob`.
`int`	`length()` Returns the number of bytes of this `XdevBlob`.
`OutputStream`	`setBinaryStream(int position)` Retrieves a stream that can be used to write to the BLOB value that this Blob object represents.
`int`	`setBytes(int position, byte[] bytes)` Writes the given array of bytes to the BLOB value that this Blob object represents, starting at position pos, and returns the number of bytes written.
`int`	`setBytes(int position, byte[] bytes, int offset, int length)` Writes all or part of the given byte array to the BLOB value that this Blob object represents and returns the number of bytes written.
`byte[]`	`toByteArray()` Returns a copied `byte array` of this `XdevBlob`.
`Blob`	`toJDBCBlob()` Returns a copied `Blob` for this `XdevBlob`.
`String`	`toString()` Returns the `String` represenation for this `XdevBlob` containing the length of the BLOB.
`void`	`truncate(long length)` Truncates the BLOB value that this `XdevBlob` object represents to be len bytes in length.

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

- Constructor Detail
  - XdevBlob
```
public XdevBlob()
```
    Initializes a new instance of XdevBlob.
  - XdevBlob
```
public XdevBlob(byte[] bytes)
```
    Initializes a new instance of XdevBlob.
    
    Parameters:
    
    bytes - a byte array initially to be set
  - XdevBlob
```
public XdevBlob(Blob blob)
         throws DBException
```
    Initializes a new instance of XdevBlob.
    
    Parameters:
    
    blob - a Blob initially to be set.
    
    Throws:
    
    DBException - if the specified blob could not be set.
- Method Detail
  - length
```
public int length()
```
    Returns the number of bytes of this XdevBlob.
    
    Specified by:
    
    length in interface ByteHolder
    
    Returns:
    
    the number of bytes or -1 if the length couldn't be retrieved
  - truncate
```
public void truncate(long length)
              throws DBException
```
    Truncates the BLOB value that this XdevBlob object represents to be len bytes in length.
    
    Parameters:
    
    length - the length, in bytes, to which the BLOB value that this Blob object represents should be truncated
    
    Throws:
    
    DBException - if truncate was not successful.
  - getBinaryStream
```
public InputStream getBinaryStream()
                            throws DBException
```
    Retrieves the BLOB value designated by this Blob instance as a stream.
    
    Returns:
    
    an InputStream containing the BLOB data
    
    Throws:
    
    DBException - if there is an error accessing the BLOB value
  - getBinaryStream
```
public InputStream getBinaryStream(int position,
                                   int length)
                            throws DBException
```
    Returns an InputStream object that contains a partial Blob value, starting with the byte specified by pos, which is length bytes in length.
    
    Parameters:
    
    position - the offset to the first byte of the partial value to be retrieved
    
    length - the length in bytes of the partial value to be retrieved
    
    Returns:
    
    InputStream through which the partial Blob value can be read.
    
    Throws:
    
    DBException - if there is an error accessing the BLOB value
  - setBinaryStream
```
public OutputStream setBinaryStream(int position)
                             throws DBException
```
    Retrieves a stream that can be used to write to the BLOB value that this Blob object represents. The stream begins at position pos. The bytes written to the stream will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing to the stream, then the length of the Blob value will be increased to accomodate the extra bytes.
    
    Parameters:
    
    position - the position in the BLOB value at which to start writing
    
    Returns:
    
    a OutputStream object to which data can be written
    
    Throws:
    
    DBException - if there is an error accessing the BLOB value
  - getByteAt
```
public int getByteAt(int index)
              throws DBException
```
    Returns the byte value at the specified index position.
    
    Parameters:
    
    index - the index to retrieve the byte from.
    
    Returns:
    
    a byte value
    
    Throws:
    
    DBException - if byte could not be read.
  - getBytes
```
public byte[] getBytes(int position,
                       int length)
                throws DBException
```
    Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes. This byte array contains up to length consecutive bytes starting at position pos.
    
    Parameters:
    
    position - the ordinal position of the first byte in the BLOB value to be extracted
    
    length - the number of consecutive bytes to be copied; the value for length must be 0 or greater
    
    Returns:
    
    a byte array containing up to length consecutive bytes from the BLOB value designated by this Blob object, starting with the byte at position pos
    
    Throws:
    
    DBException - if there is an error accessing the BLOB value
  - setBytes
```
public int setBytes(int position,
                    byte[] bytes)
             throws DBException
```
    Writes the given array of bytes to the BLOB value that this Blob object represents, starting at position pos, and returns the number of bytes written. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accomodate the extra bytes.
    
    Parameters:
    
    position - the position in the BLOB object at which to start writing
    
    bytes - the array of bytes to be written to the BLOB value that this Blob object represents
    
    Returns:
    
    the number of bytes written
    
    Throws:
    
    DBException - if there is an error accessing the BLOB value
  - setBytes
```
public int setBytes(int position,
                    byte[] bytes,
                    int offset,
                    int length)
             throws DBException
```
    Writes all or part of the given byte array to the BLOB value that this Blob object represents and returns the number of bytes written. Writing starts at position pos in the BLOB value; len bytes from the given byte array are written. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accomodate the extra bytes.
    
    Parameters:
    
    position - the position in the BLOB object at which to start writing
    
    bytes - the array of bytes to be written to this BLOB object
    
    offset - the offset into the array bytes at which to start reading the bytes to be set
    
    length - the number of bytes to be written to the BLOB value from the array of bytes bytes
    
    Returns:
    
    the number of bytes written
    
    Throws:
    
    DBException - if there is an error accessing the BLOB value
  - toString
```
public String toString()
```
    Returns the String represenation for this XdevBlob containing the length of the BLOB.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String represenation for this XdevBlob.
  - toByteArray
```
public byte[] toByteArray()
```
    Returns a copied byte array of this XdevBlob.
    
    Specified by:
    
    toByteArray in interface ByteHolder
    
    Returns:
    
    a byte array
  - compareTo
```
public int compareTo(ByteHolder other)
```
    Compares this XdevBlob with another ByteHolder.
    The length of the ByteHolder objects is used for this comparison.
    Specified by:
    
    compareTo in interface Comparable<ByteHolder>
    
    Parameters:
    
    other - the other ByteHolder.
    
    Returns:
    0 - if the length of both objects is equal
    
    -1 - if the length of this ByteHolder is greater
    
    1 - if the length of this ByteHolder is smaller
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toJDBCBlob
```
public Blob toJDBCBlob()
                throws DBException
```
    Returns a copied Blob for this XdevBlob.
    
    Returns:
    
    a Blob
    
    Throws:
    
    DBException - if Blob could not be created.
  - hashCode
```
public int hashCode()
```
    Generates a hashcode for this XdevBlob.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hashcode

Class XdevBlob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XdevBlob

XdevBlob

XdevBlob

Method Detail

length

truncate

getBinaryStream

getBinaryStream

setBinaryStream

getByteAt

getBytes

setBytes

setBytes

toString

toByteArray

compareTo

equals

toJDBCBlob

hashCode