CharArrayClob (Carbonado 1.2.3 API)

java.lang.Object
+
- com.amazon.carbonado.lob.AbstractClob
- +
  - com.amazon.carbonado.lob.CharArrayClob
  +
+

+
+
All Implemented Interfaces:
+
Clob, Lob
+
+
+
+
```
public class CharArrayClob
+extends AbstractClob
```
+
Implementation of a Clob which is backed by a growable in-memory character + array.
+
Author:
+
Brian S O'Neill
+

+ +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`CharArrayClob(char[] data)` + Construct a CharArrayClob initially backed by the given character array. +
`CharArrayClob(char[] data, + int length)` + Construct a CharArrayClob initially backed by the given character array. +
`CharArrayClob(int capacity)` + Construct a CharArrayClob with the given initial capacity. +

+ +

+ + +

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. +

+ + +
Methods inherited from class com.amazon.carbonado.lob.AbstractClob
+equals, hashCode, setValue, toString

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    CharArrayClob
    +
```
public CharArrayClob(int capacity)
```
    +
    Construct a CharArrayClob with the given initial capacity.
    +
    Parameters:
    capacity - initial capacity of internal character array
    +
  + + + +
  - +
    CharArrayClob
    +
```
public CharArrayClob(char[] data)
```
    +
    Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.
    +
    Parameters:
    data - initial data backing the Clob
    +
  + + + +
  - +
    CharArrayClob
    +
```
public CharArrayClob(char[] data,
+             int length)
```
    +
    Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.
    +
    Parameters:
    data - initial data backing the Clob
    length - initial length of data
    +
  +
+ +
- + + +
  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)
```
    +
    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
    +
  + + + +
  - +
    openReader
    +
```
public java.io.Reader openReader(long pos,
+                        int bufferSize)
```
    +
    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
    +
  + + + +
  - +
    getLength
    +
```
public long getLength()
```
    +
    Description copied from interface: Clob
    +
    Returns the length of this Clob, in characters.
    +
  + + + +
  - +
    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()
```
    +
    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
    +
  + + + +
  - +
    openWriter
    +
```
public java.io.Writer openWriter(long pos)
```
    +
    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
    +
  + + + +
  - +
    openWriter
    +
```
public java.io.Writer openWriter(long pos,
+                        int bufferSize)
```
    +
    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
    +
  + + + +
  - +
    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
    +
  + + + +
  - +
    getLocator
    +
```
public java.lang.Object getLocator()
```
    +
    Always returns null.
    +
  +
+

Class CharArrayClob

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

CharArrayClob

CharArrayClob

CharArrayClob

Method Detail

openReader

openReader

openReader

getLength

asString

openWriter

openWriter

openWriter

setLength

getLocator