H2 Database Engine 2.3.232 · org.h2.value.ValueLob · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv static final int	BLOCK_COMPARISON_SIZE
pack-priv long	charLength Length in characters.
private int	hash Cache the hashCode because it can be expensive to compute.
pack-priv final LobData	lobData
pack-priv long	octetLength Length in bytes.
private TypeInfo	type

Access	Constructor and Description
pack-priv	ValueLob(LobData lobData, long octetLength, long charLength)

Method Summary

Modifier and Type	Method and Description
public abstract ValueLob	Returns: the new value or itself copy(DataHandler the data handler database, int the table where this object is used tableId) Copy a large value, to be used in the given table.
public ValueLob	Returns: the value (this for small objects) copyToResult() Create an independent copy of this value, that will be bound to a result.
pack-priv static String	Returns: full path and name of the created file createTempLobFileName(DataHandler to get path from handler) Create file name for temporary LOB storage
public boolean	equals(Object the other value other) Implements abstract org.h2.value.Value.equals. Check if the two values have the same hash code.
pack-priv final void	formatLobDataComment(StringBuilder builder)
pack-priv DbException	getBinaryTooLong(long precision)
pack-priv static int	getBufferSize(DataHandler handler, long remaining)
public byte[]	getBytes() Overrides org.h2.value.Value.getBytes.
pack-priv abstract byte[]	getBytesInternal()
public byte[]	getBytesNoCopy() Overrides org.h2.value.Value.getBytesNoCopy.
public LobData	getLobData()
public int	getMemory() Overrides org.h2.value.Value.getMemory. Get the memory used by this object.
public Reader	getReader() Overrides org.h2.value.Value.getReader.
private byte[]	getSmall()
pack-priv DbException	getStringTooLong(long precision)
public TypeInfo	getType() Implements abstract org.h2.value.Value.getType. Implements org.h2.value.Typed.getType. Returns the data type.
public int	hashCode() Implements abstract org.h2.value.Value.hashCode. Returns a hash code value for this object.
public boolean	Returns: true if it is isLinkedToTable() Check if this value is linked to a specific table.
private static void	rangeCheckUnknown(long zeroBasedOffset, long length)
protected static InputStream	Returns: the smaller input stream rangeInputStream(InputStream the source input stream inputStream, long the offset (1 means no offset) oneBasedOffset, long the length of the result, in bytes length, long the length of the input, in bytes dataSize) Create an input stream that is s subset of the given stream.
pack-priv static Reader	Returns: the smaller input stream rangeReader(Reader the input reader reader, long the offset (1 means no offset) oneBasedOffset, long the length of the result, in bytes length, long the length of the input, in bytes dataSize) Create a reader that is s subset of the given reader.
pack-priv byte[]	readBytes(int len)
pack-priv String	readString(int len)
public void	remove() Remove the underlying resource, if any.

Inherited from org.h2.value.Value:: add cache castTo charLength clearCache compareTo compareTypeSafe compareWithNull containsNull convertForAssignTo convertTo convertTo convertTo convertTo convertTo convertToAnyArray convertToAnyJson convertToAnyRow convertToBigint convertToBoolean convertToChar convertToDate convertToDouble convertToEnum convertToGeometry convertToInt convertToInt convertToJavaObject convertToJson convertToLong convertToReal convertToSmallint convertToTinyint convertToUuid divide getBigDecimal getBoolean getByte getDataConversionError getDataConversionError getDouble getFloat getHigherOrder getHigherOrderKnown getInputStream getInputStream getInt getLong getReader getShort getSignum getString getTypeName getUnsupportedExceptionForOperation getValueTooLongException getValueType getValueWithFirstNull getValueWithFirstNullImpl isFalse isTrue modulus multiply negate octetLength rangeCheck subtract toString

BLOCK_COMPARISON_SIZE	back to summary
pack-priv static final int BLOCK_COMPARISON_SIZE

charLength	back to summary
pack-priv long charLength Length in characters.

hash	back to summary
private int hash Cache the hashCode because it can be expensive to compute.

lobData	back to summary
pack-priv final LobData lobData

octetLength	back to summary
pack-priv long octetLength Length in bytes.

type	back to summary
private TypeInfo type

ValueLob	back to summary
pack-priv ValueLob(LobData lobData, long octetLength, long charLength)

Method Detail

copy	back to summary
public abstract ValueLob copy(DataHandler database, int tableId) Copy a large value, to be used in the given table. For values that are kept fully in memory this method has no effect. Parameters database:DataHandler the data handler tableId:int the table where this object is used Returns:ValueLob the new value or itself

copy

back to summary

public abstract ValueLob copy(DataHandler database, int tableId)

Copy a large value, to be used in the given table. For values that are kept fully in memory this method has no effect.

Parameters

database:DataHandler: the data handler
tableId:int: the table where this object is used

Returns:ValueLob

the new value or itself

copyToResult	back to summary
public ValueLob copyToResult() Create an independent copy of this value, that will be bound to a result. Returns:ValueLob the value (this for small objects)

copyToResult

back to summary

public ValueLob copyToResult()

Create an independent copy of this value, that will be bound to a result.

Returns:ValueLob: the value (this for small objects)

createTempLobFileName	back to summary
pack-priv static String createTempLobFileName(DataHandler handler) throws IOException Create file name for temporary LOB storage Parameters handler:DataHandler to get path from Returns:String full path and name of the created file Exceptions IOException: if file creation fails

createTempLobFileName

back to summary

pack-priv static String createTempLobFileName(DataHandler handler) throws IOException

Create file name for temporary LOB storage

Parameters

handler:DataHandler: to get path from

Returns:String

full path and name of the created file

Exceptions

IOException:: if file creation fails

equals	back to summary
public boolean equals(Object other) Implements abstract org.h2.value.Value.equals. Doc from org.h2.value.Value.equals. Check if the two values have the same hash code. No data conversion is made; this method returns false if the other object is not of the same class. For some values, compareTo may return 0 even if equals return false. Example: ValueDecimal 0.0 and 0.00. Parameters other:Object the other value Returns:boolean true if they are equal Annotations @Override

equals

back to summary

public boolean equals(Object other)

Implements abstract org.h2.value.Value.equals.

Doc from org.h2.value.Value.equals.

Check if the two values have the same hash code. No data conversion is made; this method returns false if the other object is not of the same class. For some values, compareTo may return 0 even if equals return false. Example: ValueDecimal 0.0 and 0.00.

Parameters

other:Object: the other value

Returns:boolean

true if they are equal

Annotations

@Override

formatLobDataComment	back to summary
pack-priv final void formatLobDataComment(StringBuilder builder)

getBinaryTooLong	back to summary
pack-priv DbException getBinaryTooLong(long precision)

getBufferSize	back to summary
pack-priv static int getBufferSize(DataHandler handler, long remaining)

getBytes	back to summary
public byte[] getBytes() Overrides org.h2.value.Value.getBytes. Annotations @Override

getBytes

back to summary

public byte[] getBytes()

Overrides org.h2.value.Value.getBytes.

Annotations

@Override

getBytesInternal	back to summary
pack-priv abstract byte[] getBytesInternal()

getBytesNoCopy	back to summary
public byte[] getBytesNoCopy() Overrides org.h2.value.Value.getBytesNoCopy. Annotations @Override

getBytesNoCopy

back to summary

public byte[] getBytesNoCopy()

Overrides org.h2.value.Value.getBytesNoCopy.

Annotations

@Override

getLobData	back to summary
public LobData getLobData()

getMemory	back to summary
public int getMemory() Overrides org.h2.value.Value.getMemory. Doc from org.h2.value.Value.getMemory. Get the memory used by this object. Returns:int the memory used in bytes Annotations @Override

getMemory

back to summary

public int getMemory()

Overrides org.h2.value.Value.getMemory.

Doc from org.h2.value.Value.getMemory.

Get the memory used by this object.

Returns:int

the memory used in bytes

Annotations

@Override

getReader	back to summary
public Reader getReader() Overrides org.h2.value.Value.getReader. Annotations @Override

getReader

back to summary

public Reader getReader()

Overrides org.h2.value.Value.getReader.

Annotations

@Override

getSmall	back to summary
private byte[] getSmall()

getStringTooLong	back to summary
pack-priv DbException getStringTooLong(long precision)

getType	back to summary
public TypeInfo getType() Implements abstract org.h2.value.Value.getType. Implements org.h2.value.Typed.getType. Doc from org.h2.value.Typed.getType. Returns the data type. Returns:TypeInfo the data type Annotations @Override

getType

back to summary

public TypeInfo getType()

Implements abstract org.h2.value.Value.getType.

Implements org.h2.value.Typed.getType.

Doc from org.h2.value.Typed.getType.

Returns the data type.

Returns:TypeInfo

the data type

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Implements abstract org.h2.value.Value.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. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Implements abstract org.h2.value.Value.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.

Returns:int

a hash code value for this object

Annotations

@Override

isLinkedToTable	back to summary
public boolean isLinkedToTable() Check if this value is linked to a specific table. For values that are kept fully in memory, this method returns false. Returns:boolean true if it is

isLinkedToTable

back to summary

public boolean isLinkedToTable()

Check if this value is linked to a specific table. For values that are kept fully in memory, this method returns false.

Returns:boolean: true if it is

rangeCheckUnknown	back to summary
private static void rangeCheckUnknown(long zeroBasedOffset, long length)

rangeInputStream	back to summary
protected static InputStream rangeInputStream(InputStream inputStream, long oneBasedOffset, long length, long dataSize) Create an input stream that is s subset of the given stream. Parameters inputStream:InputStream the source input stream oneBasedOffset:long the offset (1 means no offset) length:long the length of the result, in bytes dataSize:long the length of the input, in bytes Returns:InputStream the smaller input stream

rangeInputStream

back to summary

protected static InputStream rangeInputStream(InputStream inputStream, long oneBasedOffset, long length, long dataSize)

Create an input stream that is s subset of the given stream.

Parameters

inputStream:InputStream: the source input stream
oneBasedOffset:long: the offset (1 means no offset)
length:long: the length of the result, in bytes
dataSize:long: the length of the input, in bytes

Returns:InputStream

the smaller input stream

rangeReader	back to summary
pack-priv static Reader rangeReader(Reader reader, long oneBasedOffset, long length, long dataSize) Create a reader that is s subset of the given reader. Parameters reader:Reader the input reader oneBasedOffset:long the offset (1 means no offset) length:long the length of the result, in bytes dataSize:long the length of the input, in bytes Returns:Reader the smaller input stream

rangeReader

back to summary

pack-priv static Reader rangeReader(Reader reader, long oneBasedOffset, long length, long dataSize)

Create a reader that is s subset of the given reader.

Parameters

reader:Reader: the input reader
oneBasedOffset:long: the offset (1 means no offset)
length:long: the length of the result, in bytes
dataSize:long: the length of the input, in bytes

Returns:Reader

the smaller input stream

readBytes	back to summary
pack-priv byte[] readBytes(int len)

readString	back to summary
pack-priv String readString(int len)

remove	back to summary
public void remove() Remove the underlying resource, if any. For values that are kept fully in memory this method has no effect.

public abstract Class ValueLob

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail