Top Description Fields Constructors Methods
org.apache.derby.client.am

pack-priv Class ClobLocatorOutputStream

extends OutputStream
Class Inheritance
Imports
java.io.IOException, .OutputStream
An OutputStream that will use an locator to write bytes to the Clob value on the server.

Closing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.

This OutputStream implementation is pretty basic. No buffering of data is done. Hence, for efficiency #write(byte[]) should be used instead of #write(int).

Field Summary

Modifier and TypeField and Description
private final ClientClob
clob

The Clob to be accessed.

private long
currentPos

Current position in the underlying Clob.

Constructor Summary

AccessConstructor and Description
pack-priv
ClobLocatorOutputStream(ClientClob
Clob object that contains locator for the Clob value on the server.
clob, long
the position in the CLOB value at which to start writing; the first position is 1
pos)

Create an OutputStream for writing to the Clob value represented by the given locator based Clob object.

Method Summary

Modifier and TypeMethod and Description
public void
flush()

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Flushes this output stream and forces any buffered output bytes to be written out.
public void
write(int
the byte.
b)

Implements abstract java.io.OutputStream.write.

Writes the specified byte to this output stream.
public void
write(byte[]
the data.
b)

Overrides java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream.
public void
write(byte[]
the data.
b, int
the start offset in the data.
off, int
the number of bytes to write.
len)

Overrides java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.
private void
writeBytes(byte[]
The byte array containing the bytes to be written
b)

Write the byte[] to the Clob value on the server; starting from the current position of this stream.

Inherited from java.io.OutputStream:
closenullOutputStream

Field Detail

clobback to summary
private final ClientClob clob

The Clob to be accessed.

currentPosback to summary
private long currentPos

Current position in the underlying Clob. Clobs are indexed from 1

Constructor Detail

ClobLocatorOutputStreamback to summary
pack-priv ClobLocatorOutputStream(ClientClob clob, long pos) throws SqlException

Create an OutputStream for writing to the Clob value represented by the given locator based Clob object.

Parameters
clob:ClientClob

Clob object that contains locator for the Clob value on the server.

pos:long

the position in the CLOB value at which to start writing; the first position is 1

Method Detail

flushback to summary
public void flush()

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

See Also
java.io.OutputStream#flush()
writeback to summary
public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.
See Also
This method writes one byte at a time to the server. For more efficient writing, use #write(byte[]).
writeback to summary
public void write(byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters
b:byte[]

the data.

Exceptions
IOException:
if an I/O error occurs.
See Also
java.io.OutputStream#write(byte[])
writeback to summary
public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Exceptions
IOException:
if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
See Also
java.io.OutputStream#write(byte[], int, int)
writeBytesback to summary
private void writeBytes(byte[] b) throws IOException

Write the byte[] to the Clob value on the server; starting from the current position of this stream.

Parameters
b:byte[]

The byte array containing the bytes to be written

Exceptions
IOException:
Wrapped SqlException if writing to server fails.