Modifier and Type	Class and Description
public static class	CharacterStreamDescriptor.Builder The builder for the `CharacterStreamDescriptor` class.

Modifier and Type	Field and Description
public static final long	BEFORE_FIRST Constant for the character position, when it is positioned before the first character in the stream (i.e. at the very beginning of the stream or in the header).
private final boolean	bufferable Tells if the stream can be buffered or not.
private final long	byteLength The byte length of the stream, `0` if unknown.
private final long	charLength The character length of the stream, `0` if unknown.
private final long	curBytePos The current byte position.
private final long	curCharPos The current character position.
private final long	dataOffset First data byte in the byte stream.
private final long	maxCharLength The maximum allowed character length.
private final boolean	positionAware Tells if the stream is aware of its own position.
private final InputStream	stream Reference to the stream we are describing.

Access	Constructor and Description
private	CharacterStreamDescriptor(CharacterStreamDescriptor.Builder object builder b) Creates a character stream descriptor, using the supplied builder.

Method Summary

Modifier and Type	Method and Description
public long	getByteLength()
public long	getCharLength()
public long	getCurBytePos()
public long	Returns: The current character position, where the first character is at position `1`, or `BEFORE_FIRST` if the stream is positioned before the first character. getCurCharPos() Returns the current character position.
public long	Returns: The first position in the stream containing real data. getDataOffset() Returns the first index of the described stream that contains real data.
public long	Returns: The max allowed character length of the stream, or `0` if no limit has been set. getMaxCharLength() Returns the imposed maximum character length on the described stream.
public PositionedStream	Returns: A `PositionedStream` reference. getPositionedStream() Returns the associated positioned stream, if the stream is position aware.
public InputStream	Returns: An `InputStream` reference. getStream() Returns the associated stream.
public boolean	Returns: `true` if the stream should be buffered for improved performance, `false` if it should not be buffered. isBufferable() Tells if the described stream should be buffered or not.
public boolean	Returns: `true` if the stream is position aware, @{code false} otherwise. isPositionAware() Tells if the described stream is aware of its own position, and that it can reposition itself on request.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

BEFORE_FIRST	back to summary
public static final long BEFORE_FIRST Constant for the character position, when it is positioned before the first character in the stream (i.e. at the very beginning of the stream or in the header).

bufferable	back to summary
private final boolean bufferable Tells if the stream can be buffered or not.

byteLength	back to summary
private final long byteLength The byte length of the stream, `0` if unknown.

charLength	back to summary
private final long charLength The character length of the stream, `0` if unknown.

curBytePos	back to summary
private final long curBytePos The current byte position.

curCharPos	back to summary
private final long curCharPos The current character position.

dataOffset	back to summary
private final long dataOffset First data byte in the byte stream.

maxCharLength	back to summary
private final long maxCharLength The maximum allowed character length.

positionAware	back to summary
private final boolean positionAware Tells if the stream is aware of its own position.

stream	back to summary
private final InputStream stream Reference to the stream we are describing.

CharacterStreamDescriptor	back to summary
private CharacterStreamDescriptor(CharacterStreamDescriptor.Builder b) Creates a character stream descriptor, using the supplied builder. Use the builder to create instances of this class. Parameters b:CharacterStreamDescriptor.Builder object builder See Also `Builder`

Method Detail

getByteLength	back to summary
public long getByteLength()

getCharLength	back to summary
public long getCharLength()

getCurBytePos	back to summary
public long getCurBytePos()

getCurCharPos back to summary

getCurCharPos	back to summary
public long getCurCharPos() Returns the current character position. Returns:long The current character position, where the first character is at position `1`, or `BEFORE_FIRST` if the stream is positioned before the first character.

public long getCurCharPos()

Returns the current character position.

Returns:long: The current character position, where the first character is at position 1, or BEFORE_FIRST if the stream is positioned before the first character.

getDataOffset	back to summary
public long getDataOffset() Returns the first index of the described stream that contains real data. The information is typically used to filter out meta data at the head of the stream, and to correctly reset the stream. Returns:long The first position in the stream containing real data.

getDataOffset

back to summary

public long getDataOffset()

Returns the first index of the described stream that contains real data.

The information is typically used to filter out meta data at the head of the stream, and to correctly reset the stream.

Returns:long: The first position in the stream containing real data.

getMaxCharLength back to summary

getMaxCharLength	back to summary
public long getMaxCharLength() Returns the imposed maximum character length on the described stream. The default value is `Long.MAX_VALUE`. Returns:long The max allowed character length of the stream, or `0` if no limit has been set.

public long getMaxCharLength()

Returns the imposed maximum character length on the described stream.

The default value is Long.MAX_VALUE.

Returns:long: The max allowed character length of the stream, or 0 if no limit has been set.

getPositionedStream back to summary

getPositionedStream	back to summary
public PositionedStream getPositionedStream() Returns the associated positioned stream, if the stream is position aware. Returns:PositionedStream A `PositionedStream` reference. Exceptions ClassCastException: if the stream cannot be cast to `PositionedStream` IllegalArgumentException: if the method is called and the assoicated stream isn't described as position aware. See Also `isPositionAware`

public PositionedStream getPositionedStream()

Returns the associated positioned stream, if the stream is position aware.

Returns:PositionedStream

A PositionedStream reference.

Exceptions

ClassCastException:: if the stream cannot be cast to PositionedStream
IllegalArgumentException:: if the method is called and the assoicated stream isn't described as position aware.

See Also

isPositionAware

getStream back to summary

getStream	back to summary
public InputStream getStream() Returns the associated stream. Returns:InputStream An `InputStream` reference.

public InputStream getStream()

Returns the associated stream.

Returns:InputStream: An InputStream reference.

isBufferable back to summary

isBufferable	back to summary
public boolean isBufferable() Tells if the described stream should be buffered or not. Some of the reasons a stream should not be buffered at this level, are the stream is already buffered, or it serves bytes directly from a byte array in memory. Returns:boolean `true` if the stream should be buffered for improved performance, `false` if it should not be buffered.

public boolean isBufferable()

Tells if the described stream should be buffered or not.

Some of the reasons a stream should not be buffered at this level, are the stream is already buffered, or it serves bytes directly from a byte array in memory.

Returns:boolean: true if the stream should be buffered for improved performance, false if it should not be buffered.

isPositionAware back to summary

isPositionAware	back to summary
public boolean isPositionAware() Tells if the described stream is aware of its own position, and that it can reposition itself on request. Returns:boolean `true` if the stream is position aware, @{code false} otherwise.

public boolean isPositionAware()

Tells if the described stream is aware of its own position, and that it can reposition itself on request.

Returns:boolean: true if the stream is position aware, @{code false} otherwise.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String: a string representation of the object

org.apache.derby.iapi.jdbc back to summary

public Class CharacterStreamDescriptor.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.derby.iapi.jdbc.CharacterStreamDescriptor.Builder

The builder for the CharacterStreamDescriptor class. The builder is used to avoid having a large set of constructors. See the build method for pre-build field validation. Note that the validation is only performed in sane builds.

Field Summary

Modifier and Type	Field and Description
private boolean	bufferable
private long	byteLength
private long	charLength
private long	curBytePos
private long	curCharPos
private long	dataOffset
private static final long	DEFAULT_MAX_CHAR_LENGTH Default max character length is unlimited.
private long	maxCharLength
private boolean	positionAware
private InputStream	stream

Constructor Summary

Access	Constructor and Description
public	Builder() Creates a builder object.

Method Summary

Modifier and Type	Method and Description
public CharacterStreamDescriptor.Builder	Returns: The builder. bufferable(boolean `true` if buffering is advised, `false` if not bufferable) Sets if the stream should be buffered, defaults to `false`.
public CharacterStreamDescriptor	Returns: A character stream descriptor instance. build() Creates a descriptor object based on the parameters kept in the builder instance.
public CharacterStreamDescriptor.Builder	Returns: The builder. byteLength(long the byte length of the stream (including header) length) Sets the byte length of the stream, defaults to `0`.
public CharacterStreamDescriptor.Builder	Returns: The builder. charLength(long the character length of the stream length) Sets the character length of the stream, defaults to `0`.
public CharacterStreamDescriptor.Builder	Returns: The builder. copyState(CharacterStreamDescriptor the descriptor to copy csd) Copies the state of the specified descriptor.
public CharacterStreamDescriptor.Builder	Returns: The builder. curBytePos(long the current byte position pos) Sets the current byte position, defaults to `0`.
public CharacterStreamDescriptor.Builder	Returns: The builder. curCharPos(long the current character position,starting at `1` pos) Sets the current character position, defaults to `1`.
public CharacterStreamDescriptor.Builder	Returns: The builder. dataOffset(long first index with user data, zero based offset) Sets the offset of the user data, defaults to `0`.
public CharacterStreamDescriptor.Builder	Returns: The builder. maxCharLength(long maximum number of characters length) Imposes a length limit on the stream, expressed in number of characters, defaults to `Long.MAX_VALUE`.
public CharacterStreamDescriptor.Builder	Returns: The builder. positionAware(boolean `true` if the stream can reposition itself, `false` if not positionAware) Sets if the stream can reposition itself or not, defaults to `false`.
public CharacterStreamDescriptor.Builder	Returns: The builder. stream(InputStream the stream stream) Sets the stream described by the descriptor.
public String	Returns: The textual representation of the builder. toString() Overrides java.lang.Object.toString. Returns a textual representation of the builder.

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

Field Detail

bufferable	back to summary
private boolean bufferable

byteLength	back to summary
private long byteLength

charLength	back to summary
private long charLength

curBytePos	back to summary
private long curBytePos

curCharPos	back to summary
private long curCharPos

dataOffset	back to summary
private long dataOffset

DEFAULT_MAX_CHAR_LENGTH	back to summary
private static final long DEFAULT_MAX_CHAR_LENGTH Default max character length is unlimited.

maxCharLength	back to summary
private long maxCharLength

positionAware	back to summary
private boolean positionAware

stream	back to summary
private InputStream stream

Constructor Detail

Builder	back to summary
public Builder() Creates a builder object.

Method Detail

bufferable back to summary

bufferable	back to summary
public CharacterStreamDescriptor.Builder bufferable(boolean bufferable) Sets if the stream should be buffered, defaults to `false`. Parameters bufferable:boolean `true` if buffering is advised, `false` if not Returns:CharacterStreamDescriptor.Builder The builder.

public CharacterStreamDescriptor.Builder bufferable(boolean bufferable)

Sets if the stream should be buffered, defaults to false.

Parameters

bufferable:boolean: true if buffering is advised, false if not

Returns:CharacterStreamDescriptor.Builder

The builder.

build	back to summary
public CharacterStreamDescriptor build() Creates a descriptor object based on the parameters kept in the builder instance. Default values will be used for parameters for which a value hasn't been set. Note Parameter validation is only performed in sane builds. Returns:CharacterStreamDescriptor A character stream descriptor instance.

build

back to summary

public CharacterStreamDescriptor build()

Creates a descriptor object based on the parameters kept in the builder instance.

Default values will be used for parameters for which a value hasn't been set.

Note

Parameter validation is only performed in sane builds.

Returns:CharacterStreamDescriptor: A character stream descriptor instance.

byteLength back to summary

byteLength	back to summary
public CharacterStreamDescriptor.Builder byteLength(long length) Sets the byte length of the stream, defaults to `0`. A length of `0` means the length is unknown. Parameters length:long the byte length of the stream (including header) Returns:CharacterStreamDescriptor.Builder The builder.

public CharacterStreamDescriptor.Builder byteLength(long length)

Sets the byte length of the stream, defaults to 0.

A length of 0 means the length is unknown.

Parameters

length:long: the byte length of the stream (including header)

Returns:CharacterStreamDescriptor.Builder

The builder.

charLength back to summary

charLength	back to summary
public CharacterStreamDescriptor.Builder charLength(long length) Sets the character length of the stream, defaults to `0`. Headers are not included in this length, only the user data. A length of `0` means the length is unknown. Parameters length:long the character length of the stream Returns:CharacterStreamDescriptor.Builder The builder.

public CharacterStreamDescriptor.Builder charLength(long length)

Sets the character length of the stream, defaults to 0.

Headers are not included in this length, only the user data. A length of 0 means the length is unknown.

Parameters

length:long: the character length of the stream

Returns:CharacterStreamDescriptor.Builder

The builder.

copyState	back to summary
public CharacterStreamDescriptor.Builder copyState(CharacterStreamDescriptor csd) Copies the state of the specified descriptor. Parameters csd:CharacterStreamDescriptor the descriptor to copy Returns:CharacterStreamDescriptor.Builder The builder.

copyState

back to summary

public CharacterStreamDescriptor.Builder copyState(CharacterStreamDescriptor csd)

Copies the state of the specified descriptor.

Parameters

csd:CharacterStreamDescriptor: the descriptor to copy

Returns:CharacterStreamDescriptor.Builder

The builder.

curBytePos back to summary

curBytePos	back to summary
public CharacterStreamDescriptor.Builder curBytePos(long pos) Sets the current byte position, defaults to `0`. Parameters pos:long the current byte position Returns:CharacterStreamDescriptor.Builder The builder.

public CharacterStreamDescriptor.Builder curBytePos(long pos)

Sets the current byte position, defaults to 0.

Parameters

pos:long: the current byte position

Returns:CharacterStreamDescriptor.Builder

The builder.

curCharPos back to summary

curCharPos	back to summary
public CharacterStreamDescriptor.Builder curCharPos(long pos) Sets the current character position, defaults to `1`. There is a special value for when the stream is position in the header area - `BEFORE_FIRST`. Parameters pos:long the current character position,starting at `1` Returns:CharacterStreamDescriptor.Builder The builder. See Also `BEFORE_FIRST`

public CharacterStreamDescriptor.Builder curCharPos(long pos)

Sets the current character position, defaults to 1.

There is a special value for when the stream is position in the header area - BEFORE_FIRST.

Parameters

pos:long: the current character position,starting at 1

Returns:CharacterStreamDescriptor.Builder

The builder.

See Also

BEFORE_FIRST

dataOffset back to summary

dataOffset	back to summary
public CharacterStreamDescriptor.Builder dataOffset(long offset) Sets the offset of the user data, defaults to `0`. Parameters offset:long first index with user data, zero based Returns:CharacterStreamDescriptor.Builder The builder.

public CharacterStreamDescriptor.Builder dataOffset(long offset)

Sets the offset of the user data, defaults to 0.

Parameters

offset:long: first index with user data, zero based

Returns:CharacterStreamDescriptor.Builder

The builder.

maxCharLength back to summary

maxCharLength	back to summary
public CharacterStreamDescriptor.Builder maxCharLength(long length) Imposes a length limit on the stream, expressed in number of characters, defaults to `Long.MAX_VALUE`. Parameters length:long maximum number of characters Returns:CharacterStreamDescriptor.Builder The builder.

public CharacterStreamDescriptor.Builder maxCharLength(long length)

Imposes a length limit on the stream, expressed in number of characters, defaults to Long.MAX_VALUE.

Parameters

length:long: maximum number of characters

Returns:CharacterStreamDescriptor.Builder

The builder.

positionAware back to summary

positionAware	back to summary
public CharacterStreamDescriptor.Builder positionAware(boolean positionAware) Sets if the stream can reposition itself or not, defaults to `false`. Parameters positionAware:boolean `true` if the stream can reposition itself, `false` if not Returns:CharacterStreamDescriptor.Builder The builder.

public CharacterStreamDescriptor.Builder positionAware(boolean positionAware)

Sets if the stream can reposition itself or not, defaults to false.

Parameters

positionAware:boolean: true if the stream can reposition itself, false if not

Returns:CharacterStreamDescriptor.Builder

The builder.

stream back to summary

public CharacterStreamDescriptor.Builder stream(InputStream stream)

Sets the stream described by the descriptor.

The stream is not allowed to be null.

Parameters

stream:InputStream: the stream

Returns:CharacterStreamDescriptor.Builder

The builder.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a textual representation of the builder.

Returns:String: The textual representation of the builder.

public Class CharacterStreamDescriptor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CharacterStreamDescriptor.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail