com.amazon.carbonado.lob

Class StringClob

java.lang.Object

com.amazon.carbonado.lob.AbstractClob

com.amazon.carbonado.lob.StringClob

All Implemented Interfaces:

Clob, Lob

public class StringClob
extends AbstractClob

Implementation of a Clob which is backed by a read-only String.

Author:

Brian S O'Neill

Constructor Summary

Constructors

Constructor and Description
StringClob(java.lang.String str)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	asString() Convenience method to capture all the Clob data as a single String.
long	getLength() Returns the length of this Clob, in characters.
java.lang.Object	getLocator() Always returns null.
java.io.Reader	openReader() Returns a Reader for reading Clob data, positioned at the start.
java.io.Reader	openReader(long pos) Returns a Reader for reading Clob data.
java.io.Reader	openReader(long pos, int bufferSize) Returns a Reader for reading Clob data.
java.io.Writer	openWriter() Returns a Writer for writing Clob data, positioned at the start.
java.io.Writer	openWriter(long pos) Returns a Writer for writing Clob data.
java.io.Writer	openWriter(long pos, int bufferSize) Returns a Writer for writing Clob data.
void	setLength(long length) Set the length of this Clob, in characters.
void	setValue(java.lang.String value) Convenience method to overwrite all Clob data with the value of a single String.

Methods inherited from class com.amazon.carbonado.lob.AbstractClob

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StringClob

public StringClob(java.lang.String str)

Method Detail

openReader

public java.io.Reader openReader()

Description copied from interface: Clob

Returns a Reader for reading Clob data, positioned at the start. The Clob implementation selects an appropriate buffer size for the reader.

Returns:

Reader for this Blob, which is not guaranteed to be thread-safe

openReader

public java.io.Reader openReader(long pos)
                          throws FetchException

Description copied from interface: Clob

Returns a Reader for reading Clob data. The Clob implementation selects an appropriate buffer size for the reader.

Parameters:

pos - desired zero-based position to read from

Returns:

Reader for this Blob, which is not guaranteed to be thread-safe

Throws:

FetchException

openReader

public java.io.Reader openReader(long pos,
                        int bufferSize)
                          throws FetchException

Description copied from interface: Clob

Returns a Reader for reading Clob data. A suggested buffer size must be provided, but it might be ignored by the Clob implementation.

Parameters:

pos - desired zero-based position to read from

bufferSize - suggest that the reader buffer be at least this large (in characters)

Returns:

Reader for this Blob, which is not guaranteed to be thread-safe

Throws:

FetchException

getLength

public long getLength()
               throws FetchException

Description copied from interface: Clob

Returns the length of this Clob, in characters.

Throws:

FetchException

asString

public java.lang.String asString()

Description copied from interface: Clob

Convenience method to capture all the Clob data as a single String. Call within a transaction scope to ensure the data does not change while the String is being built.

Specified by:

asString in interface Clob

Overrides:

asString in class AbstractClob

openWriter

public java.io.Writer openWriter()
                          throws PersistException

Description copied from interface: Clob

Returns a Writer for writing Clob data, positioned at the start. The Clob implementation selects an appropriate buffer size for the writer.

Returns:

Writer for this Blob, which is not guaranteed to be thread-safe

Throws:

PersistException

openWriter

public java.io.Writer openWriter(long pos)
                          throws PersistException

Description copied from interface: Clob

Returns a Writer for writing Clob data. The Clob implementation selects an appropriate buffer size for the writer.

Parameters:

pos - desired zero-based position to write to

Returns:

Writer for this Blob, which is not guaranteed to be thread-safe

Throws:

PersistException

openWriter

public java.io.Writer openWriter(long pos,
                        int bufferSize)
                          throws PersistException

Description copied from interface: Clob

Returns a Writer for writing Clob data. A suggested buffer size must be provided, but it might be ignored by the Clob implementation.

Parameters:

pos - desired zero-based position to write to

bufferSize - suggest that the writer buffer be at least this large (in characters)

Returns:

Writer for this Blob, which is not guaranteed to be thread-safe

Throws:

PersistException

setLength

public void setLength(long length)
               throws PersistException

Description copied from interface: Clob

Set the length of this Clob, in characters. If the new length is shorter, the Clob is truncated. If the new length is longer, the Clob is padded with '\0' characters.

Parameters:

length - new length to set to

Throws:

PersistDeniedException - if Clob is read-only

PersistException

setValue

public void setValue(java.lang.String value)
              throws PersistException

Description copied from interface: Clob

Convenience method to overwrite all Clob data with the value of a single String. The Clob length may grow or shrink, to match the String value. Call within a transaction scope to ensure the data and length does not change while the value is set.

Specified by:

setValue in interface Clob

Overrides:

setValue in class AbstractClob

Parameters:

value - Clob is overwritten with this value

Throws:

PersistException

getLocator

public java.lang.Object getLocator()

Always returns null.