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

Field Summary

Modifier and Type	Field and Description
private static final int	ARRAY
private static final int	BIGINT
private static final int	BINARY
private static final int	BLOB
private static final int	BOOLEAN
private static final int	BUFFER_SIZE
private static final int	CHAR
private static final int	CLOB
private static final int	DATE
private static final int	DECFLOAT
private static final int	DOUBLE
private static final int	ENUM
private static final int	GEOMETRY
private DataInputStream	in
private static final int	INTEGER
private static final int	INTERVAL
private static final int	JAVA_OBJECT
private static final int	JSON
private static final int	LOB_MAC_SALT_LENGTH
private static final int	LOB_MAGIC
private byte[]	lobMacSalt
private final ReentrantLock	lock
private static final int	NULL
private static final int	NUMERIC
private DataOutputStream	out
private static final int	REAL
private static final int	ROW
private Session	session
private static final int	SMALLINT
private Socket	socket
private boolean	ssl
private static final int[]	TI_TO_VALUE
private static final int	TIME
private static final int	TIME_TZ
private static final int	TIMESTAMP
private static final int	TIMESTAMP_TZ
private static final int	TINYINT
private static final int	UUID
private static final int[]	VALUE_TO_TI
private static final int	VARBINARY
private static final int	VARCHAR
private static final int	VARCHAR_IGNORECASE
private int	version

Constructor Summary

Access	Constructor and Description
public	Transfer(Session the session session, Socket the socket s) Create a new transfer object for the specified session.

Method Summary

Modifier and Type	Method and Description
private static void	addType(int typeInformationType, int valueType)
private byte[]	calculateLobMac(long lobId)
public void	close() Close the transfer object and the socket.
public void	flush() Write pending changes.
public Socket	Returns: the socket getSocket() Get the socket.
public int	getVersion()
public void	init() Initialize the transfer object.
public boolean	isClosed()
private void	lock() Locks this object with a reentrant lock.
public Transfer	Returns: the new transfer object openNewConnection() Open a new connection to the same address and port as this one.
private Value[]	readArrayElements(int len, TypeInfo elementType)
public boolean	Returns: the value readBoolean() Read a boolean.
public byte	Returns: the value readByte() Read a byte.
public byte[]	Returns: the value readBytes() Read a byte array.
public void	readBytes(byte[] the target buffer buff, int the offset off, int the number of bytes to read len) Read a number of bytes.
private double	Returns: the value readDouble() Read a double.
private float	Returns: the value readFloat() Read a float.
public int	Returns: the value readInt() Read an int.
public long	Returns: the value readLong() Read a long.
public long	Returns: the row count readRowCount() Read a row count.
private short	Returns: the value readShort() Read a short.
public String	Returns: the value readString() Read a string.
public TypeInfo	Returns: the type information readTypeInfo() Read a type information.
private TypeInfo	readTypeInfo19()
private TypeInfo	readTypeInfo20()
private ExtTypeInfo	readTypeInfoEnum()
private ExtTypeInfo	readTypeInfoGeometry()
private ExtTypeInfo	readTypeInfoRow()
public Value	Returns: the value readValue(TypeInfo the data type of value, or `null` columnType) Read a value.
public void	setSession(Session the session session) Set the session.
public void	setSSL(boolean the new value ssl) Enable or disable SSL.
public void	setVersion(int version)
private void	unlock() Unlocks this object.
public void	verifyLobMac(byte[] the message authentication code hmac, long the lobId lobId) Verify the HMAC.
public Transfer	Returns: itself writeBoolean(boolean the value x) Write a boolean.
public Transfer	Returns: itself writeByte(byte the value x) Write a byte.
private void	writeBytePrecisionWithDefault(long precision)
public Transfer	Returns: itself writeBytes(byte[] the value data) Write a byte array.
public Transfer	Returns: itself writeBytes(byte[] the value buff, int the offset off, int the length len) Write a number of bytes.
private void	writeByteScaleWithDefault(int scale)
private Transfer	Returns: itself writeDouble(double the value i) Write a double.
private Transfer	Returns: itself writeFloat(float the value i) Write a float.
public Transfer	Returns: itself writeInt(int the value x) Write an int.
public Transfer	Returns: itself writeLong(long the value x) Write a long.
public Transfer	Returns: itself writeRowCount(long the row count rowCount) Write a row count.
private Transfer	Returns: itself writeShort(short the value x) Write a short.
public Transfer	Returns: itself writeString(String the value s) Write a string.
public Transfer	Returns: itself writeTypeInfo(TypeInfo data type information type) Write value type, precision, and scale.
private void	writeTypeInfo19(TypeInfo type)
private void	writeTypeInfo20(TypeInfo type)
private void	writeTypeInfoEnum(TypeInfo type)
private void	writeTypeInfoGeometry(TypeInfo type)
private void	writeTypeInfoRow(TypeInfo type)
public void	writeValue(Value the value v) Write a value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ARRAY	back to summary
private static final int ARRAY

BIGINT	back to summary
private static final int BIGINT

BINARY	back to summary
private static final int BINARY

BLOB	back to summary
private static final int BLOB

BOOLEAN	back to summary
private static final int BOOLEAN

BUFFER_SIZE	back to summary
private static final int BUFFER_SIZE

CHAR	back to summary
private static final int CHAR

CLOB	back to summary
private static final int CLOB

DATE	back to summary
private static final int DATE

DECFLOAT	back to summary
private static final int DECFLOAT

DOUBLE	back to summary
private static final int DOUBLE

ENUM	back to summary
private static final int ENUM

GEOMETRY	back to summary
private static final int GEOMETRY

in	back to summary
private DataInputStream in

INTEGER	back to summary
private static final int INTEGER

INTERVAL	back to summary
private static final int INTERVAL

JAVA_OBJECT	back to summary
private static final int JAVA_OBJECT

JSON	back to summary
private static final int JSON

LOB_MAC_SALT_LENGTH	back to summary
private static final int LOB_MAC_SALT_LENGTH

LOB_MAGIC	back to summary
private static final int LOB_MAGIC

lobMacSalt	back to summary
private byte[] lobMacSalt

lock	back to summary
private final ReentrantLock lock

NULL	back to summary
private static final int NULL

NUMERIC	back to summary
private static final int NUMERIC

out	back to summary
private DataOutputStream out

REAL	back to summary
private static final int REAL

ROW	back to summary
private static final int ROW

session	back to summary
private Session session

SMALLINT	back to summary
private static final int SMALLINT

socket	back to summary
private Socket socket

ssl	back to summary
private boolean ssl

TI_TO_VALUE	back to summary
private static final int[] TI_TO_VALUE

TIME	back to summary
private static final int TIME

TIME_TZ	back to summary
private static final int TIME_TZ

TIMESTAMP	back to summary
private static final int TIMESTAMP

TIMESTAMP_TZ	back to summary
private static final int TIMESTAMP_TZ

TINYINT	back to summary
private static final int TINYINT

UUID	back to summary
private static final int UUID

VALUE_TO_TI	back to summary
private static final int[] VALUE_TO_TI

VARBINARY	back to summary
private static final int VARBINARY

VARCHAR	back to summary
private static final int VARCHAR

VARCHAR_IGNORECASE	back to summary
private static final int VARCHAR_IGNORECASE

version	back to summary
private int version

Constructor Detail

Transfer	back to summary
public Transfer(Session session, Socket s) Create a new transfer object for the specified session. Parameters session:Session the session s:Socket the socket

Transfer

back to summary

public Transfer(Session session, Socket s)

Create a new transfer object for the specified session.

Parameters

session:Session: the session
s:Socket: the socket

Method Detail

addType	back to summary
private static void addType(int typeInformationType, int valueType)

calculateLobMac	back to summary
private byte[] calculateLobMac(long lobId)

close	back to summary
public void close() Close the transfer object and the socket.

flush

back to summary

public void flush() throws IOException

Write pending changes.

Exceptions

IOException:: on failure

getSocket

back to summary

public Socket getSocket()

Get the socket.

Returns:Socket: the socket

getVersion	back to summary
public int getVersion()

init

back to summary

public void init() throws IOException

Initialize the transfer object. This method will try to open an input and output stream.

Exceptions

IOException:: on failure

isClosed	back to summary
public boolean isClosed()

lock

back to summary

private void lock()

Locks this object with a reentrant lock.

lock();
try {
    ...
} finally {
    unlock();
}

openNewConnection

back to summary

public Transfer openNewConnection() throws IOException

Open a new connection to the same address and port as this one.

Returns:Transfer

the new transfer object

Exceptions

IOException:: on failure

readArrayElements	back to summary
private Value[] readArrayElements(int len, TypeInfo elementType) throws IOException

readBoolean

back to summary

public boolean readBoolean() throws IOException

Read a boolean.

Returns:boolean

the value

Exceptions

IOException:: on failure

readByte

back to summary

public byte readByte() throws IOException

Read a byte.

Returns:byte

the value

Exceptions

IOException:: on failure

readBytes

back to summary

public byte[] readBytes() throws IOException

Read a byte array.

Returns:byte[]

the value

Exceptions

IOException:: on failure

readBytes

back to summary

public void readBytes(byte[] buff, int off, int len) throws IOException

Read a number of bytes.

Parameters

buff:byte[]: the target buffer
off:int: the offset
len:int: the number of bytes to read

Exceptions

IOException:: on failure

readDouble

back to summary

private double readDouble() throws IOException

Read a double.

Returns:double

the value

Exceptions

IOException:: on failure

readFloat

back to summary

private float readFloat() throws IOException

Read a float.

Returns:float

the value

Exceptions

IOException:: on failure

readInt

back to summary

public int readInt() throws IOException

Read an int.

Returns:int

the value

Exceptions

IOException:: on failure

readLong

back to summary

public long readLong() throws IOException

Read a long.

Returns:long

the value

Exceptions

IOException:: on failure

readRowCount

back to summary

public long readRowCount() throws IOException

Read a row count.

Returns:long

the row count

Exceptions

IOException:: on failure

readShort

back to summary

private short readShort() throws IOException

Read a short.

Returns:short

the value

Exceptions

IOException:: on failure

readString

back to summary

public String readString() throws IOException

Read a string.

Returns:String

the value

Exceptions

IOException:: on failure

readTypeInfo

back to summary

public TypeInfo readTypeInfo() throws IOException

Read a type information.

Returns:TypeInfo

the type information

Exceptions

IOException:: on failure

readTypeInfo19	back to summary
private TypeInfo readTypeInfo19() throws IOException

readTypeInfo20	back to summary
private TypeInfo readTypeInfo20() throws IOException

readTypeInfoEnum	back to summary
private ExtTypeInfo readTypeInfoEnum() throws IOException

readTypeInfoGeometry	back to summary
private ExtTypeInfo readTypeInfoGeometry() throws IOException

readTypeInfoRow	back to summary
private ExtTypeInfo readTypeInfoRow() throws IOException

readValue back to summary

public Value readValue(TypeInfo columnType) throws IOException

Read a value.

Parameters

columnType:TypeInfo: the data type of value, or null

Returns:Value

the value

Exceptions

IOException:: on failure

setSession

back to summary

public void setSession(Session session)

Set the session.

Parameters

session:Session: the session

setSSL

back to summary

public void setSSL(boolean ssl)

Enable or disable SSL.

Parameters

ssl:boolean: the new value

setVersion	back to summary
public void setVersion(int version)

unlock back to summary

private void unlock()

Unlocks this object.

See Also: lock()

verifyLobMac

back to summary

public void verifyLobMac(byte[] hmac, long lobId)

Verify the HMAC.

Parameters

hmac:byte[]: the message authentication code
lobId:long: the lobId

Exceptions

DbException:: if the HMAC does not match

writeBoolean

back to summary

public Transfer writeBoolean(boolean x) throws IOException

Write a boolean.

Parameters

x:boolean: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeByte

back to summary

public Transfer writeByte(byte x) throws IOException

Write a byte.

Parameters

x:byte: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeBytePrecisionWithDefault	back to summary
private void writeBytePrecisionWithDefault(long precision) throws IOException

writeBytes

back to summary

public Transfer writeBytes(byte[] data) throws IOException

Write a byte array.

Parameters

data:byte[]: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeBytes

back to summary

public Transfer writeBytes(byte[] buff, int off, int len) throws IOException

Write a number of bytes.

Parameters

buff:byte[]: the value
off:int: the offset
len:int: the length

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeByteScaleWithDefault	back to summary
private void writeByteScaleWithDefault(int scale) throws IOException

writeDouble

back to summary

private Transfer writeDouble(double i) throws IOException

Write a double.

Parameters

i:double: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeFloat

back to summary

private Transfer writeFloat(float i) throws IOException

Write a float.

Parameters

i:float: the value

Returns:Transfer

itself

writeInt

back to summary

public Transfer writeInt(int x) throws IOException

Write an int.

Parameters

x:int: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeLong

back to summary

public Transfer writeLong(long x) throws IOException

Write a long.

Parameters

x:long: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeRowCount

back to summary

public Transfer writeRowCount(long rowCount) throws IOException

Write a row count.

Parameters

rowCount:long: the row count

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeShort

back to summary

private Transfer writeShort(short x) throws IOException

Write a short.

Parameters

x:short: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeString

back to summary

public Transfer writeString(String s) throws IOException

Write a string. The maximum string length is Integer.MAX_VALUE.

Parameters

s:String: the value

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeTypeInfo

back to summary

public Transfer writeTypeInfo(TypeInfo type) throws IOException

Write value type, precision, and scale.

Parameters

type:TypeInfo: data type information

Returns:Transfer

itself

Exceptions

IOException:: on failure

writeTypeInfo19	back to summary
private void writeTypeInfo19(TypeInfo type) throws IOException

writeTypeInfo20	back to summary
private void writeTypeInfo20(TypeInfo type) throws IOException

writeTypeInfoEnum	back to summary
private void writeTypeInfoEnum(TypeInfo type) throws IOException

writeTypeInfoGeometry	back to summary
private void writeTypeInfoGeometry(TypeInfo type) throws IOException

writeTypeInfoRow	back to summary
private void writeTypeInfoRow(TypeInfo type) throws IOException

writeValue

back to summary

public void writeValue(Value v) throws IOException

Write a value.

Parameters

v:Value: the value

Exceptions

IOException:: on failure

public final Class Transfer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail