Top Description Fields Constructors Methods
org.hsqldb.types

public Class BinaryData

extends Object
implements BlobData
Class Inheritance
All Implemented Interfaces
org.hsqldb.types.BlobData, org.hsqldb.types.LobData
Imports
java.io.DataInput, .IOException, .InputStream, java.util.Arrays, org.hsqldb.SessionInterface, org.hsqldb.error.Error, .ErrorCode, org.hsqldb.lib.ArrayUtil

Implementation of BlobData for memory binary data.

A Binary object instance always wraps a non-null byte[] object.

Author
Fred Toussi (fredt@users dot sourceforge.net)
Since
1.7.2
Version
2.6.1

Field Summary

Modifier and TypeField and Description
private long
protected byte[]
private int
pack-priv long
private boolean
public static final BinaryData
public static final BinaryData
public static final BinaryData
public static final byte[]

Constructor Summary

AccessConstructor and Description
public
BinaryData(byte[] data, boolean clone)

This constructor is used inside the engine when an already serialized byte[] is read from a file (.log, .script, .data or text table source).

public
public
BinaryData(byte[] data, long bitLength)

public
BinaryData(long length, DataInput stream)

Method Summary

Modifier and TypeMethod and Description
public long
public BlobData
public boolean
equals(Object other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public void
public InputStream
public InputStream
public static BinaryData
getBitData(byte[] data, long bitLength)

public BlobData
getBlob(SessionInterface session, long pos, long length)

Implements org.hsqldb.types.BlobData.getBlob.

public byte[]
public byte[]
getBytes(SessionInterface session, long pos, int length)

Implements org.hsqldb.types.BlobData.getBytes.

public long
public int
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
public boolean
public boolean
pack-priv static boolean
isInLimits(long fullLength, long pos, long len)

public long
public long
public long
position(SessionInterface session, byte[] pattern, long start)

Implements org.hsqldb.types.BlobData.position.

public long
position(SessionInterface session, BlobData pattern, long start)

Implements org.hsqldb.types.BlobData.position.

public void
public void
setBytes(SessionInterface session, long pos, byte[] bytes, int offset, int length)

Implements org.hsqldb.types.BlobData.setBytes.

public void
setBytes(SessionInterface session, long pos, byte[] bytes)

Implements org.hsqldb.types.BlobData.setBytes.

public void
setBytes(SessionInterface session, long pos, BlobData b, long offset, long length)

Implements org.hsqldb.types.BlobData.setBytes.

public void
public void
public void
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

bitLengthback to summary
private long bitLength
databack to summary
protected byte[] data
hashCodeback to summary
private int hashCode
idback to summary
pack-priv long id
isBitsback to summary
private boolean isBits
singleBitOneback to summary
public static final BinaryData singleBitOne
singleBitZeroback to summary
public static final BinaryData singleBitZero
zeroLengthBinaryback to summary
public static final BinaryData zeroLengthBinary
zeroLengthBytesback to summary
public static final byte[] zeroLengthBytes

Constructor Detail

BinaryDataback to summary
public BinaryData(byte[] data, boolean clone)

This constructor is used inside the engine when an already serialized byte[] is read from a file (.log, .script, .data or text table source). In this case clone is false. When a byte[] is submitted as a parameter of PreparedStatement then clone is true.

BinaryDataback to summary
public BinaryData(SessionInterface session, BlobData b1, BlobData b2)
BinaryDataback to summary
public BinaryData(byte[] data, long bitLength)
BinaryDataback to summary
public BinaryData(long length, DataInput stream)

Method Detail

bitLengthback to summary
public long bitLength(SessionInterface session)

Implements org.hsqldb.types.BlobData.bitLength.

duplicateback to summary
public BlobData duplicate(SessionInterface session)

Implements org.hsqldb.types.BlobData.duplicate.

equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

freeback to summary
public void free()

Implements org.hsqldb.types.BlobData.free.

getBinaryStreamback to summary
public InputStream getBinaryStream(SessionInterface session)

Implements org.hsqldb.types.BlobData.getBinaryStream.

getBinaryStreamback to summary
public InputStream getBinaryStream(SessionInterface session, long pos, long length)

Implements org.hsqldb.types.BlobData.getBinaryStream.

getBitDataback to summary
public static BinaryData getBitData(byte[] data, long bitLength)
getBlobback to summary
public BlobData getBlob(SessionInterface session, long pos, long length)

Implements org.hsqldb.types.BlobData.getBlob.

getBytesback to summary
public byte[] getBytes()

Implements org.hsqldb.types.BlobData.getBytes.

getBytesback to summary
public byte[] getBytes(SessionInterface session, long pos, int length)

Implements org.hsqldb.types.BlobData.getBytes.

getIdback to summary
public long getId()

Implements org.hsqldb.types.BlobData.getId.

getStreamBlockSizeback to summary
public int getStreamBlockSize()

Implements org.hsqldb.types.BlobData.getStreamBlockSize.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
isBinaryback to summary
public boolean isBinary()

Implements org.hsqldb.types.LobData.isBinary.

isBitsback to summary
public boolean isBits()

Implements org.hsqldb.types.BlobData.isBits.

isClosedback to summary
public boolean isClosed()

Implements org.hsqldb.types.BlobData.isClosed.

isInLimitsback to summary
pack-priv static boolean isInLimits(long fullLength, long pos, long len)
lengthback to summary
public long length(SessionInterface session)

Implements org.hsqldb.types.BlobData.length.

nonZeroLengthback to summary
public long nonZeroLength(SessionInterface session)

Implements org.hsqldb.types.BlobData.nonZeroLength.

positionback to summary
public long position(SessionInterface session, byte[] pattern, long start)

Implements org.hsqldb.types.BlobData.position.

positionback to summary
public long position(SessionInterface session, BlobData pattern, long start)

Implements org.hsqldb.types.BlobData.position.

setBinaryStreamback to summary
public void setBinaryStream(SessionInterface session, long pos, InputStream in)

Implements org.hsqldb.types.BlobData.setBinaryStream.

setBytesback to summary
public void setBytes(SessionInterface session, long pos, byte[] bytes, int offset, int length)

Implements org.hsqldb.types.BlobData.setBytes.

setBytesback to summary
public void setBytes(SessionInterface session, long pos, byte[] bytes)

Implements org.hsqldb.types.BlobData.setBytes.

setBytesback to summary
public void setBytes(SessionInterface session, long pos, BlobData b, long offset, long length)

Implements org.hsqldb.types.BlobData.setBytes.

setIdback to summary
public void setId(long id)

Implements org.hsqldb.types.BlobData.setId.

setSessionback to summary
public void setSession(SessionInterface session)

Implements org.hsqldb.types.BlobData.setSession.

truncateback to summary
public void truncate(SessionInterface session, long len)

Implements org.hsqldb.types.BlobData.truncate.