diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/lob/Clob.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/lob/Clob.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/lob/Clob.html | 447 |
1 files changed, 447 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/lob/Clob.html b/apidocs/com/amazon/carbonado/lob/Clob.html new file mode 100644 index 0000000..f2e49a0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Clob.html @@ -0,0 +1,447 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Clob (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Clob (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Clob.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Clob.html" target="_top">Frames</a></li> +<li><a href="Clob.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.lob</div> +<h2 title="Interface Clob" class="title">Interface Clob</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a>, <a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a>, <a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a>, <a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Clob</span> +extends <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></pre> +<div class="block">Provides access to CLOBs, which are Character Large OBjects. Consider + accessing Clobs within a <a href="../../../../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><code>transaction</code></a> scope, to prevent unexpected updates.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blob</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Clob data as a single String.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">openReader</a></strong>()</code> +<div class="block">Returns a Reader for reading Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">openReader</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Reader for reading Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">openWriter</a></strong>()</code> +<div class="block">Returns a Writer for writing Clob data, positioned at the start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">openWriter</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns a Writer for writing Clob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Lob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="openReader()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>java.io.Reader openReader() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a Reader for reading Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openReader(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>java.io.Reader openReader(long pos) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a Reader for reading Clob data. The Clob implementation selects + an appropriate buffer size for the reader.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openReader(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>java.io.Reader openReader(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns a Reader for reading Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to read from</dd><dd><code>bufferSize</code> - suggest that the reader buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Reader for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>long getLength() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns the length of this Clob, in characters.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>java.lang.String asString() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if Clob length is greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Clob as a single String</dd> +<dd><code><a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></code></dd></dl> +</li> +</ul> +<a name="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>java.io.Writer openWriter() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a Writer for writing Clob data, positioned at the start. The + Clob implementation selects an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openWriter(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>java.io.Writer openWriter(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a Writer for writing Clob data. The Clob implementation selects + an appropriate buffer size for the writer.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openWriter(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>java.io.Writer openWriter(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a Writer for writing Clob data. A suggested buffer size must be + provided, but it might be ignored by the Clob implementation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pos</code> - desired zero-based position to write to</dd><dd><code>bufferSize</code> - suggest that the writer buffer be at least this large (in characters)</dd> +<dt><span class="strong">Returns:</span></dt><dd>Writer for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if position is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - new length to set to</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if length is negative</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Clob is read-only</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setValue</h4> +<pre>void setValue(java.lang.String value) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">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.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Clob is overwritten with this value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if value is null</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Clob.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/Clob.html" target="_top">Frames</a></li> +<li><a href="Clob.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |