org.apache.derby.iapi.types
Class SQLClob.HeaderInfo

java.lang.Object
  org.apache.derby.iapi.types.SQLClob.HeaderInfo

Enclosing class:

SQLClob

private static class SQLClob.HeaderInfo
extends java.lang.Object

Holder class for header information gathered from the raw byte header in the stream.

Field Summary

private int	headerLength The header length in bytes.
private int	valueLength The value length, either in bytes or characters.

Constructor Summary

SQLClob.HeaderInfo(int headerLength, int valueLength)
Creates a new header info object.

Method Summary

(package private) int	byteLength() Returns the byte length encoded in the header, if any.
(package private) int	charLength() Returns the character length encoded in the header, if any.
(package private) int	headerLength() Returns the header length in bytes.
(package private) boolean	isCharLength() Tells whether the encoded length was in characters or bytes.
java.lang.String	toString() Returns a textual representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

valueLength

private final int valueLength

The value length, either in bytes or characters.

headerLength

private final int headerLength

The header length in bytes.

Constructor Detail

SQLClob.HeaderInfo

SQLClob.HeaderInfo(int headerLength,
                   int valueLength)

Creates a new header info object.

Parameters:

headerLength - the header length in bytes

valueLength - the value length (chars or bytes)

Method Detail

headerLength

int headerLength()

Returns the header length in bytes.

Returns:

Number of bytes occupied by the header.

charLength

int charLength()

Returns the character length encoded in the header, if any.

Returns:

A positive integer if a character count was encoded in the header, or 0 (zero) if the header contained byte length information.

byteLength

int byteLength()

Returns the byte length encoded in the header, if any.

Returns:

A positive integer if a byte count was encoded in the header, or 0 (zero) if the header contained character length information.

isCharLength

boolean isCharLength()

Tells whether the encoded length was in characters or bytes.

Returns:

true if the header contained a character count, false if it contained a byte count.

toString

public java.lang.String toString()

Returns a textual representation.

Overrides:

toString in class java.lang.Object