Class ClobLocatorWriter

java.lang.Object

java.io.Writer

org.apache.derby.client.am.ClobLocatorWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

class ClobLocatorWriter
extends Writer

An Writer that will use an locator to write the Clob value into the server.

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

Field Summary

Fields

Modifier and Type	Field	Description
private final ClientClob	clob	The Clob to be accessed.
private final ClientConnection	connection	Connection used to read Clob from server.
private long	currentPos	Current position in the underlying Clob.
private boolean	isClosed	Stores the information to whether this Writer has been closed or not.

Fields inherited from class Writer

lock

Constructor Summary

Constructors

Constructor	Description
ClobLocatorWriter(ClientConnection connection, ClientClob clob, long pos)	Create a Writer for writing to the Clob value represented by the given locator based Clob object.

Method Summary

Modifier and Type	Method	Description
private void	checkClosed()	Check to see if this Writer is closed.
void	close()
void	flush()
void	write(char[] c)
void	write(char[] c, int off, int len)
void	write(int c)
private void	writeCharacters(char[] c, int off, int len)	Write the char[] to the Clob value on the server; starting from the current position of this stream.

Methods inherited from class Writer

append, append, append, nullWriter, write, write

Methods inherited from class Object

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

Field Details

connection

private final ClientConnection connection

Connection used to read Clob from server.

clob

private final ClientClob clob

The Clob to be accessed.

currentPos

private long currentPos

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

isClosed

private boolean isClosed

Stores the information to whether this Writer has been closed or not. Is set to true if close() has been called. Is false otherwise.

Constructor Details

ClobLocatorWriter

ClobLocatorWriter(ClientConnection connection,
 ClientClob clob,
 long pos)
           throws SqlException

Create a Writer for writing to the Clob value represented by the given locator based Clob object.

Parameters:

connection - connection to be used to write to the Clob value on the server

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

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

Throws:

SqlException

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException

See Also:

• Writer.close()

checkClosed

private void checkClosed()
                  throws IOException

Check to see if this Writer is closed. If it is closed throw an IOException that states that the stream is closed.

Throws:

IOException - if isClosed = true.

write

public void write(int c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

See Also:

• This method writes one Character at a time to the server. For more efficient writing, use #write(char[]).

write

public void write(char[] c)
           throws IOException

Overrides:

write in class Writer

Throws:

IOException

See Also:

• Writer.write(char[])

flush

public void flush()

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

See Also:

• Writer.flush()

write

public void write(char[] c,
 int off,
 int len)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

See Also:

• Writer.write(char[], int, int)

writeCharacters

private void writeCharacters(char[] c,
 int off,
 int len)
                      throws IOException

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

Parameters:

c - The character array containing the chars to be written

Throws:

IOException - Wrapped SqlException if writing to server fails.