diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/lob')
24 files changed, 7279 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/lob/AbstractBlob.html b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html new file mode 100644 index 0000000..0764636 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractBlob.html @@ -0,0 +1,523 @@ +<!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>AbstractBlob (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="AbstractBlob (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/AbstractBlob.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>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.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/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class AbstractBlob" class="title">Class AbstractBlob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.AbstractBlob</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a>, <a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractBlob</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></pre> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#AbstractBlob()">AbstractBlob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#AbstractBlob(com.amazon.carbonado.Repository)">AbstractBlob</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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/AbstractBlob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString</a></strong>(java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.lang.String)">asString</a></strong>(java.lang.String charsetName)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></strong>(java.lang.String value, + java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue</a></strong>(java.lang.String value, + java.lang.String charsetName)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Blob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">getLength</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">openInputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">openInputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">openInputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">openOutputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">openOutputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">openOutputStream</a>, <a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">setLength</a></code></li> +</ul> +<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#getLocator()">getLocator</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractBlob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AbstractBlob</h4> +<pre>protected AbstractBlob()</pre> +</li> +</ul> +<a name="AbstractBlob(com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractBlob</h4> +<pre>protected AbstractBlob(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</pre> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - optional repository to use for performing string conversion + within transactions</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString()">Blob</a></code></strong></div> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding. Call within a transaction scope to ensure the + data does not change while the String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<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(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString(java.lang.String charsetName) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.lang.String)">Blob</a></code></strong></div> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.lang.String)">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>charsetName</code> - name of character set to decode String</dd> +<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(java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString(java.nio.charset.Charset charset) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.nio.charset.Charset)">Blob</a></code></strong></div> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.nio.charset.Charset)">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>charset</code> - character set to decode String</dd> +<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="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">Blob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded String value. Call within a transaction scope to + ensure the data and length does not change while the value is set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd> +<dt><span class="strong">Throws:</span></dt> +<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, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(java.lang.String value, + java.lang.String charsetName) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">Blob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd><dd><code>charsetName</code> - name of character set to encode String</dd> +<dt><span class="strong">Throws:</span></dt> +<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, java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public void setValue(java.lang.String value, + java.nio.charset.Charset charset) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">Blob</a></code></strong></div> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded String value. Call within a transaction + scope to ensure the data and length does not change while the value is + set.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Blob is overwritten with this value</dd><dd><code>charset</code> - character set to encode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">Lob</a></code></strong></div> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/AbstractBlob.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>Prev Class</li> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.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/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> diff --git a/apidocs/com/amazon/carbonado/lob/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/AbstractClob.html new file mode 100644 index 0000000..75110e3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/AbstractClob.html @@ -0,0 +1,406 @@ +<!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>AbstractClob (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="AbstractClob (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/AbstractClob.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/AbstractBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface 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/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class AbstractClob" class="title">Class AbstractClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.AbstractClob</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><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 abstract class <span class="strong">AbstractClob</span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></pre> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#AbstractClob()">AbstractClob</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#AbstractClob(com.amazon.carbonado.Repository)">AbstractClob</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</code> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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/AbstractClob.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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.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> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.Clob"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">getLength</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">openReader</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">openReader</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">openReader</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">openWriter</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">openWriter</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">openWriter</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">setLength</a></code></li> +</ul> +<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#getLocator()">getLocator</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractClob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AbstractClob</h4> +<pre>protected AbstractClob()</pre> +</li> +</ul> +<a name="AbstractClob(com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractClob</h4> +<pre>protected AbstractClob(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> repo)</pre> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction. A Repository is passed in for entering the transaction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - optional repository to use for performing string conversion + within transactions</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">Clob</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<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="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">Clob</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<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><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">Lob</a></code></strong></div> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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/AbstractClob.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/AbstractBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface 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/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> diff --git a/apidocs/com/amazon/carbonado/lob/Blob.html b/apidocs/com/amazon/carbonado/lob/Blob.html new file mode 100644 index 0000000..40d1dc6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Blob.html @@ -0,0 +1,564 @@ +<!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>Blob (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="Blob (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/Blob.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/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/BlobClob.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/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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 Blob" class="title">Interface Blob</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/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a>, <a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a>, <a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">Blob</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 BLOBs, which are Binary Large OBjects. Consider accessing + Blobs 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/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clob</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/Blob.html#asString()">asString</a></strong>()</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.nio.charset.Charset)">asString</a></strong>(java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#asString(java.lang.String)">asString</a></strong>(java.lang.String charsetName)</code> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">openInputStream</a></strong>()</code> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">openOutputStream</a></strong>()</code> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an OutputStream for writing Blob 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/Blob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a></strong>(java.lang.String value, + java.nio.charset.Charset charset)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">setValue</a></strong>(java.lang.String value, + java.lang.String charsetName)</code> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</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="openInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>java.io.InputStream openInputStream() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>InputStream 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="openInputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>java.io.InputStream openInputStream(long pos) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block">Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</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>InputStream 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="openInputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>java.io.InputStream openInputStream(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 an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob 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 input stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream 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 Blob, in bytes.</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 Blob data as a single String, + assuming UTF-8 encoding. 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 resulting String length would be + greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Blob 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="asString(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>java.lang.String asString(java.lang.String charsetName) + 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 Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charsetName</code> - name of character set to decode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.nio.charset.IllegalCharsetNameException</code> - if the given charset name is illegal</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if resulting String length would be + greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Blob 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="asString(java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>java.lang.String asString(java.nio.charset.Charset charset) + 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 Blob data as a single String, + decoded against the given charset. Call within a transaction scope to + ensure the data does not change while the String is being built.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charset</code> - character set to decode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if resulting String length would be + greater than Integer.MAX_VALUE</dd> +<dd><code>java.lang.OutOfMemoryError</code> - if not enough memory to hold Blob 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="openOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>java.io.OutputStream openOutputStream() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>OutputStream 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="openOutputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>java.io.OutputStream openOutputStream(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</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>OutputStream 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="openOutputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>java.io.OutputStream openOutputStream(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 an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob 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 output stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream 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 Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.</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 Blob 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="blockList"> +<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 Blob data with the value of a single + String, applying UTF-8 encoding. The Blob length may grow or shrink, to + match the encoded 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> - Blob 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> +<a name="setValue(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>void setValue(java.lang.String value, + java.lang.String charsetName) + 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 Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded 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> - Blob is overwritten with this value</dd><dd><code>charsetName</code> - name of character set to encode String</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.nio.charset.IllegalCharsetNameException</code> - if the given charset name is illegal</dd> +<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> +<a name="setValue(java.lang.String, java.nio.charset.Charset)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setValue</h4> +<pre>void setValue(java.lang.String value, + java.nio.charset.Charset charset) + 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 Blob data with the value of a single + String, applying the given charset encoding. The Blob length may grow or + shrink, to match the encoded 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> - Blob is overwritten with this value</dd><dd><code>charset</code> - character set to encode String</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/Blob.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/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/BlobClob.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/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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> diff --git a/apidocs/com/amazon/carbonado/lob/BlobClob.html b/apidocs/com/amazon/carbonado/lob/BlobClob.html new file mode 100644 index 0000000..2b0adc3 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/BlobClob.html @@ -0,0 +1,482 @@ +<!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>BlobClob (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="BlobClob (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/BlobClob.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/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.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/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class BlobClob" class="title">Class BlobClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractClob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.BlobClob</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">BlobClob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></pre> +<div class="block">A Clob implementation which is backed by a Blob. Data is stored in the Blob + using UTF-16BE encoding.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Bob Loblaw</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#BlobClob(com.amazon.carbonado.lob.Blob)">BlobClob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Clob, in characters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#getWrappedBlob()">getWrappedBlob</a></strong>()</code> </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/BlobClob.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="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</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/BlobClob.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="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.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="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</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/BlobClob.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="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/BlobClob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractClob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BlobClob(com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BlobClob</h4> +<pre>public BlobClob(<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blob</code> - blob to wrap</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ 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>public java.io.Reader openReader() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">Clob</a></code></strong></div> +<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><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>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">Clob</a></code></strong></div> +<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><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>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">Clob</a></code></strong></div> +<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><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>public long getLength() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">Clob</a></code></strong></div> +<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="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">Clob</a></code></strong></div> +<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><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>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">Clob</a></code></strong></div> +<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><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>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">Clob</a></code></strong></div> +<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><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>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">Clob</a></code></strong></div> +<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><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="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">Lob</a></code></strong></div> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</li> +</ul> +<a name="getWrappedBlob()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getWrappedBlob</h4> +<pre>protected <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> getWrappedBlob()</pre> +</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/BlobClob.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/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.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/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> diff --git a/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html new file mode 100644 index 0000000..0a3f8be --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/ByteArrayBlob.html @@ -0,0 +1,487 @@ +<!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>ByteArrayBlob (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="ByteArrayBlob (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/ByteArrayBlob.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/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.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/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class ByteArrayBlob" class="title">Class ByteArrayBlob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractBlob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.ByteArrayBlob</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ByteArrayBlob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></pre> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(byte[])">ByteArrayBlob</a></strong>(byte[] data)</code> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(byte[], int)">ByteArrayBlob</a></strong>(byte[] data, + int length)</code> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(int)">ByteArrayBlob</a></strong>(int capacity)</code> +<div class="block">Construct a ByteArrayBlob with the given initial capacity.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream()">openInputStream</a></strong>()</code> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream()">openOutputStream</a></strong>()</code> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an OutputStream for writing Blob 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/ByteArrayBlob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Blob, in bytes.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractBlob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString()">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.lang.String)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#toString()">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ByteArrayBlob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ByteArrayBlob</h4> +<pre>public ByteArrayBlob(int capacity)</pre> +<div class="block">Construct a ByteArrayBlob with the given initial capacity.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capacity</code> - initial capacity of internal byte array</dd></dl> +</li> +</ul> +<a name="ByteArrayBlob(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ByteArrayBlob</h4> +<pre>public ByteArrayBlob(byte[] data)</pre> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Blob</dd></dl> +</li> +</ul> +<a name="ByteArrayBlob(byte[], int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ByteArrayBlob</h4> +<pre>public ByteArrayBlob(byte[] data, + int length)</pre> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array. The + byte array is not cloned until this ByteArrayBlob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Blob</dd><dd><code>length</code> - initial length of data</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="openInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openInputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</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>InputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openInputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob 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 input stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">Blob</a></code></strong></div> +<div class="block">Returns the length of this Blob, in bytes.</div> +</li> +</ul> +<a name="openOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openOutputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</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>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="openOutputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob 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 output stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd></dl> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">Blob</a></code></strong></div> +<div class="block">Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.</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><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Blob 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="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/ByteArrayBlob.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/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.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/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> diff --git a/apidocs/com/amazon/carbonado/lob/CharArrayClob.html b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html new file mode 100644 index 0000000..7e24d4a --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/CharArrayClob.html @@ -0,0 +1,509 @@ +<!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>CharArrayClob (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="CharArrayClob (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/CharArrayClob.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/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface 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/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class CharArrayClob" class="title">Class CharArrayClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractClob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.CharArrayClob</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">CharArrayClob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></pre> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(char[])">CharArrayClob</a></strong>(char[] data)</code> +<div class="block">Construct a CharArrayClob initially backed by the given character array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(char[], int)">CharArrayClob</a></strong>(char[] data, + int length)</code> +<div class="block">Construct a CharArrayClob initially backed by the given character array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(int)">CharArrayClob</a></strong>(int capacity)</code> +<div class="block">Construct a CharArrayClob with the given initial capacity.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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/CharArrayClob.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/CharArrayClob.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.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</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/CharArrayClob.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="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</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/CharArrayClob.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="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.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="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</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/CharArrayClob.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="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Clob, in characters.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractClob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CharArrayClob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CharArrayClob</h4> +<pre>public CharArrayClob(int capacity)</pre> +<div class="block">Construct a CharArrayClob with the given initial capacity.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capacity</code> - initial capacity of internal character array</dd></dl> +</li> +</ul> +<a name="CharArrayClob(char[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CharArrayClob</h4> +<pre>public CharArrayClob(char[] data)</pre> +<div class="block">Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Clob</dd></dl> +</li> +</ul> +<a name="CharArrayClob(char[], int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CharArrayClob</h4> +<pre>public CharArrayClob(char[] data, + int length)</pre> +<div class="block">Construct a CharArrayClob initially backed by the given character array. The + character array is not cloned until this CharArrayClob grows or shrinks.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - initial data backing the Clob</dd><dd><code>length</code> - initial length of data</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ 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>public java.io.Reader openReader()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">Clob</a></code></strong></div> +<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></dl> +</li> +</ul> +<a name="openReader(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">Clob</a></code></strong></div> +<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></dl> +</li> +</ul> +<a name="openReader(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public java.io.Reader openReader(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">Clob</a></code></strong></div> +<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></dl> +</li> +</ul> +<a name="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">Clob</a></code></strong></div> +<div class="block">Returns the length of this Clob, in characters.</div> +</li> +</ul> +<a name="asString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>asString</h4> +<pre>public java.lang.String asString()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">Clob</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a></code> in class <code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></code></dd> +</dl> +</li> +</ul> +<a name="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">Clob</a></code></strong></div> +<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></dl> +</li> +</ul> +<a name="openWriter(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">Clob</a></code></strong></div> +<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></dl> +</li> +</ul> +<a name="openWriter(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter(long pos, + int bufferSize)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">Clob</a></code></strong></div> +<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></dl> +</li> +</ul> +<a name="setLength(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLength</h4> +<pre>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">Clob</a></code></strong></div> +<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><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="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/CharArrayClob.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/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface 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/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> 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> diff --git a/apidocs/com/amazon/carbonado/lob/FileBlob.html b/apidocs/com/amazon/carbonado/lob/FileBlob.html new file mode 100644 index 0000000..4f41f03 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/FileBlob.html @@ -0,0 +1,468 @@ +<!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>FileBlob (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="FileBlob (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/FileBlob.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/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface 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/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class FileBlob" class="title">Class FileBlob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractBlob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.FileBlob</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FileBlob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></pre> +<div class="block">Implementation of a Blob which is backed by a File.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#FileBlob(java.io.File)">FileBlob</a></strong>(java.io.File file)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#getLength()">getLength</a></strong>()</code> +<div class="block">Returns the length of this Blob, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream()">openInputStream</a></strong>()</code> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long)">openInputStream</a></strong>(long pos)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.InputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long, int)">openInputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an InputStream for reading Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream()">openOutputStream</a></strong>()</code> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long)">openOutputStream</a></strong>(long pos)</code> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long, int)">openOutputStream</a></strong>(long pos, + int bufferSize)</code> +<div class="block">Returns an OutputStream for writing Blob 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/FileBlob.html#setLength(long)">setLength</a></strong>(long length)</code> +<div class="block">Set the length of this Blob, in bytes.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.lob.AbstractBlob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString()">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.lang.String)">asString</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html#toString()">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FileBlob(java.io.File)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileBlob</h4> +<pre>public FileBlob(java.io.File file)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="openInputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream()">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<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="openInputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</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>InputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<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="openInputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openInputStream</h4> +<pre>public java.io.InputStream openInputStream(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob 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 input stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>InputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<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="getLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLength</h4> +<pre>public long getLength() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#getLength()">Blob</a></code></strong></div> +<div class="block">Returns the length of this Blob, in bytes.</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="openOutputStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream()">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openOutputStream(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.</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>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="openOutputStream(long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openOutputStream</h4> +<pre>public java.io.OutputStream openOutputStream(long pos, + int bufferSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">Blob</a></code></strong></div> +<div class="block">Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob 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 output stream buffer be at least this large (in bytes)</dd> +<dt><span class="strong">Returns:</span></dt><dd>OutputStream for this Blob, which is not guaranteed to be thread-safe</dd> +<dt><span class="strong">Throws:</span></dt> +<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>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Blob.html#setLength(long)">Blob</a></code></strong></div> +<div class="block">Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.</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><a href="../../../../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></code> - if Blob 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="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/FileBlob.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/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface 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/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> diff --git a/apidocs/com/amazon/carbonado/lob/Lob.html b/apidocs/com/amazon/carbonado/lob/Lob.html new file mode 100644 index 0000000..69e3d8e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/Lob.html @@ -0,0 +1,249 @@ +<!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>Lob (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="Lob (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/Lob.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/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/StringClob.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/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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 Lob" class="title">Interface Lob</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>, <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a>, <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/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a>, <a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a>, <a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</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">Lob</span></pre> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</td> +</tr> +</table> +</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="getLocator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>java.lang.Object getLocator()</pre> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>boolean equals(java.lang.Object obj)</pre> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content. Lob data is not compared, as that would + be expensive or it may result in a fetch exception.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</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/Lob.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/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/lob/StringClob.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/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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> diff --git a/apidocs/com/amazon/carbonado/lob/StringClob.html b/apidocs/com/amazon/carbonado/lob/StringClob.html new file mode 100644 index 0000000..6a2a54e --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/StringClob.html @@ -0,0 +1,516 @@ +<!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>StringClob (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="StringClob (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/StringClob.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/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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="Class StringClob" class="title">Class StringClob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">com.amazon.carbonado.lob.AbstractClob</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.lob.StringClob</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>, <a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StringClob</span> +extends <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></pre> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#StringClob(java.lang.String)">StringClob</a></strong>(java.lang.String str)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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/StringClob.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/StringClob.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.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#getLocator()">getLocator</a></strong>()</code> +<div class="block">Always returns null.</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/StringClob.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="altColor"> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openReader(long)">openReader</a></strong>(long pos)</code> +<div class="block">Returns a Reader for reading Clob data.</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/StringClob.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="altColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.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="rowColor"> +<td class="colFirst"><code>java.io.Writer</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.html#openWriter(long)">openWriter</a></strong>(long pos)</code> +<div class="block">Returns a Writer for writing Clob data.</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/StringClob.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="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.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="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/lob/StringClob.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.AbstractClob"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></h3> +<code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode</a>, <a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StringClob(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StringClob</h4> +<pre>public StringClob(java.lang.String str)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ 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>public java.io.Reader openReader()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader()">Clob</a></code></strong></div> +<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></dl> +</li> +</ul> +<a name="openReader(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openReader</h4> +<pre>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long)">Clob</a></code></strong></div> +<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><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>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">Clob</a></code></strong></div> +<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><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>public long getLength() + throws <a href="../../../../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#getLength()">Clob</a></code></strong></div> +<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>public java.lang.String asString()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">Clob</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#asString()">asString</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString</a></code> in class <code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></code></dd> +</dl> +</li> +</ul> +<a name="openWriter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openWriter</h4> +<pre>public java.io.Writer openWriter() + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter()">Clob</a></code></strong></div> +<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><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>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long)">Clob</a></code></strong></div> +<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><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>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">Clob</a></code></strong></div> +<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><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>public void setLength(long length) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setLength(long)">Clob</a></code></strong></div> +<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><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="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public 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"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">Clob</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue</a></code> in interface <code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue</a></code> in class <code><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></code></dd> +<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><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getLocator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public java.lang.Object getLocator()</pre> +<div class="block">Always returns null.</div> +</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/StringClob.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/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html new file mode 100644 index 0000000..c426a4c --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/AbstractBlob.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.AbstractBlob (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="Uses of Class com.amazon.carbonado.lob.AbstractBlob (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><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.lob.AbstractBlob" class="title">Uses of Class<br>com.amazon.carbonado.lob.AbstractBlob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractBlob.html" target="_top">Frames</a></li> +<li><a href="AbstractBlob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html new file mode 100644 index 0000000..9764bbe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/AbstractClob.html @@ -0,0 +1,174 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.AbstractClob (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="Uses of Class com.amazon.carbonado.lob.AbstractClob (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><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.lob.AbstractClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.AbstractClob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></strong></code> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/AbstractClob.html" target="_top">Frames</a></li> +<li><a href="AbstractClob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Blob.html b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html new file mode 100644 index 0000000..9419f63 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Blob.html @@ -0,0 +1,379 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.lob.Blob (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="Uses of Interface com.amazon.carbonado.lob.Blob (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><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.lob.Blob" class="title">Uses of Interface<br>com.amazon.carbonado.lob.Blob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToBlob(java.lang.String)">adaptToBlob</a></strong>(java.lang.String text)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Blob)">adaptToString</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that implement <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></strong></code> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">BlobClob.</span><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html#getWrappedBlob()">getWrappedBlob</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html#BlobClob(com.amazon.carbonado.lob.Blob)">BlobClob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">RawSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html#getBlob(S, java.lang.String, long)">getBlob</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, + java.lang.String name, + long locator)</code> +<div class="block">Returns the Blob for the given locator, returning null if not found.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Blob)">getLocator</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> +<div class="block">Returns the locator for the given Blob, returning zero if null.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertBlob(java.sql.Blob, com.amazon.carbonado.repo.jdbc.JDBCBlobLoader)">convertBlob</a></strong>(java.sql.Blob blob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a> loader)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> blob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateBlob(com.amazon.carbonado.lob.Blob, com.amazon.carbonado.lob.Blob)">updateBlob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> oldBlob, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> newBlob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#createNewBlob(int)">createNewBlob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Blob whose length is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#getBlobValue(long)">getBlobValue</a></strong>(long locator)</code> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(long locator, + <a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Blob.html" target="_top">Frames</a></li> +<li><a href="Blob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html b/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html new file mode 100644 index 0000000..258d0b0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/BlobClob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.BlobClob (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="Uses of Class com.amazon.carbonado.lob.BlobClob (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><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.lob.BlobClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.BlobClob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.BlobClob</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/BlobClob.html" target="_top">Frames</a></li> +<li><a href="BlobClob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html new file mode 100644 index 0000000..955f5b9 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/ByteArrayBlob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.ByteArrayBlob (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="Uses of Class com.amazon.carbonado.lob.ByteArrayBlob (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><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.lob.ByteArrayBlob" class="title">Uses of Class<br>com.amazon.carbonado.lob.ByteArrayBlob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.ByteArrayBlob</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/ByteArrayBlob.html" target="_top">Frames</a></li> +<li><a href="ByteArrayBlob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html b/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html new file mode 100644 index 0000000..1b6cadf --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/CharArrayClob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.CharArrayClob (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="Uses of Class com.amazon.carbonado.lob.CharArrayClob (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><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.lob.CharArrayClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.CharArrayClob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.CharArrayClob</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/CharArrayClob.html" target="_top">Frames</a></li> +<li><a href="CharArrayClob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Clob.html b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html new file mode 100644 index 0000000..04b5b7f --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Clob.html @@ -0,0 +1,362 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.lob.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="Uses of Interface com.amazon.carbonado.lob.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><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.lob.Clob" class="title">Uses of Interface<br>com.amazon.carbonado.lob.Clob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToClob(java.lang.String)">adaptToClob</a></strong>(java.lang.String text)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><span class="strong">TextAdapter.Adapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Clob)">adaptToString</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that implement <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></strong></code> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></strong></code> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><span class="strong">RawSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html#getClob(S, java.lang.String, long)">getClob</a></strong>(<a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> storable, + java.lang.String name, + long locator)</code> +<div class="block">Returns the Clob for the given locator, returning null if not found.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">RawSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Clob)">getLocator</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> +<div class="block">Returns the locator for the given Clob, returning zero if null.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertClob(java.sql.Clob, com.amazon.carbonado.repo.jdbc.JDBCClobLoader)">convertClob</a></strong>(java.sql.Clob clob, + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a> loader)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(java.sql.PreparedStatement ps, + int column, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> clob)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">JDBCSupport.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateClob(com.amazon.carbonado.lob.Clob, com.amazon.carbonado.lob.Clob)">updateClob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> oldClob, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> newClob)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#createNewClob(int)">createNewClob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Clob whose length is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#getClobValue(long)">getClobValue</a></strong>(long locator)</code> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(long locator, + <a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html b/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html new file mode 100644 index 0000000..a78da2a --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/FileBlob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.FileBlob (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="Uses of Class com.amazon.carbonado.lob.FileBlob (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><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.lob.FileBlob" class="title">Uses of Class<br>com.amazon.carbonado.lob.FileBlob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.FileBlob</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/FileBlob.html" target="_top">Frames</a></li> +<li><a href="FileBlob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/Lob.html b/apidocs/com/amazon/carbonado/lob/class-use/Lob.html new file mode 100644 index 0000000..d632b81 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/Lob.html @@ -0,0 +1,251 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Interface com.amazon.carbonado.lob.Lob (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="Uses of Interface com.amazon.carbonado.lob.Lob (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><a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Interface com.amazon.carbonado.lob.Lob" class="title">Uses of Interface<br>com.amazon.carbonado.lob.Lob</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></strong></code> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></strong></code> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> that implement <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></strong></code> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></strong></code> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></strong></code> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></strong></code> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></strong></code> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(com.amazon.carbonado.lob.Lob)">deleteLob</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><span class="strong">LobEngine.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/LobEngine.html#getLocator(com.amazon.carbonado.lob.Lob)">getLocator</a></strong>(<a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/Lob.html" target="_top">Frames</a></li> +<li><a href="Lob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html b/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html new file mode 100644 index 0000000..ff9db45 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/class-use/StringClob.html @@ -0,0 +1,117 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Class com.amazon.carbonado.lob.StringClob (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="Uses of Class com.amazon.carbonado.lob.StringClob (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><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class com.amazon.carbonado.lob.StringClob" class="title">Uses of Class<br>com.amazon.carbonado.lob.StringClob</h2> +</div> +<div class="classUseContainer">No usage of com.amazon.carbonado.lob.StringClob</div> +<!-- ======= 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><a href="../../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/lob/class-use/StringClob.html" target="_top">Frames</a></li> +<li><a href="StringClob.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/package-frame.html b/apidocs/com/amazon/carbonado/lob/package-frame.html new file mode 100644 index 0000000..5cd4200 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-frame.html @@ -0,0 +1,32 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.lob (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/lob/package-summary.html" target="classFrame">com.amazon.carbonado.lob</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Blob.html" title="interface in com.amazon.carbonado.lob" target="classFrame"><i>Blob</i></a></li> +<li><a href="Clob.html" title="interface in com.amazon.carbonado.lob" target="classFrame"><i>Clob</i></a></li> +<li><a href="Lob.html" title="interface in com.amazon.carbonado.lob" target="classFrame"><i>Lob</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AbstractBlob.html" title="class in com.amazon.carbonado.lob" target="classFrame">AbstractBlob</a></li> +<li><a href="AbstractClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">AbstractClob</a></li> +<li><a href="BlobClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">BlobClob</a></li> +<li><a href="ByteArrayBlob.html" title="class in com.amazon.carbonado.lob" target="classFrame">ByteArrayBlob</a></li> +<li><a href="CharArrayClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">CharArrayClob</a></li> +<li><a href="FileBlob.html" title="class in com.amazon.carbonado.lob" target="classFrame">FileBlob</a></li> +<li><a href="StringClob.html" title="class in com.amazon.carbonado.lob" target="classFrame">StringClob</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/lob/package-summary.html b/apidocs/com/amazon/carbonado/lob/package-summary.html new file mode 100644 index 0000000..93d2196 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-summary.html @@ -0,0 +1,234 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.lob (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="com.amazon.carbonado.lob (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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/layout/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package com.amazon.carbonado.lob</h1> +<div class="docSummary"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></td> +<td class="colLast"> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></td> +<td class="colLast"> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></td> +<td class="colLast"> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></td> +<td class="colLast"> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></td> +<td class="colLast"> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></td> +<td class="colLast"> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></td> +<td class="colLast"> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.lob Description">Package com.amazon.carbonado.lob Description</h2> +<div class="block">Support for LOB property types, which are Large OBjects. Properties declared + as <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blob</code></a> or <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clob</code></a> are treated differently than regular + properties. In particular: + + <ul> + <li>Repository typically stores LOB data external from enclosing storable + <li>LOBs are accessed in a manner similar to how files are accessed + <li>LOB data is often read/written in chunks, so consider accessing in a transaction scope + <li>LOBs cannot be annotated with <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><code>PrimaryKey</code></a>, <a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado"><code>Key</code></a>, <a href="../../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><code>Index</code></a>, <a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a>, + <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a>, or <a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a> + <li>LOBs cannot be used in a <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>query filter</code></a> + </ul> + + <p>Also, setting a LOB property does not dirty that property unless the new + LOB is unequal. Updating a LOB property typically involves operating on the + LOB itself. Setting the LOB property again is useful only when completely + replacing the data, which can be a relatively expensive operation. + + <p>Some repositories require that large text data be stored as a LOB. If the + text property is intended to fit entirely in memory, consider defining the + property as a String instead of a LOB. This allows the repository to decide + if it is appropriate to store it as a LOB. If explicit control over charset + encoding is required, add a <a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TextAdapter</code></a> annotation.</div> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.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/layout/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/package-tree.html b/apidocs/com/amazon/carbonado/lob/package-tree.html new file mode 100644 index 0000000..8300746 --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-tree.html @@ -0,0 +1,151 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.lob Class Hierarchy (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="com.amazon.carbonado.lob Class Hierarchy (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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/layout/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package com.amazon.carbonado.lob</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">AbstractBlob</span></a> (implements com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a>) +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">ByteArrayBlob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">FileBlob</span></a></li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">AbstractClob</span></a> (implements com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a>) +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">BlobClob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">CharArrayClob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">StringClob</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Lob</span></a> +<ul> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Blob</span></a></li> +<li type="circle">com.amazon.carbonado.lob.<a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Clob</span></a></li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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/layout/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/qe/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<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> diff --git a/apidocs/com/amazon/carbonado/lob/package-use.html b/apidocs/com/amazon/carbonado/lob/package-use.html new file mode 100644 index 0000000..20b3ebe --- /dev/null +++ b/apidocs/com/amazon/carbonado/lob/package-use.html @@ -0,0 +1,293 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Uses of Package com.amazon.carbonado.lob (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="Uses of Package com.amazon.carbonado.lob (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</li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Uses of Package com.amazon.carbonado.lob" class="title">Uses of Package<br>com.amazon.carbonado.lob</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.adapter">com.amazon.carbonado.adapter</a></td> +<td class="colLast"> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.lob">com.amazon.carbonado.lob</a></td> +<td class="colLast"> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.adapter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.adapter">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.adapter">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.lob"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/AbstractBlob.html#com.amazon.carbonado.lob">AbstractBlob</a> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/AbstractClob.html#com.amazon.carbonado.lob">AbstractClob</a> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.lob">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.lob">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Lob.html#com.amazon.carbonado.lob">Lob</a> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.raw">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.raw">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.repo.jdbc">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.repo.jdbc">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Blob.html#com.amazon.carbonado.spi">Blob</a> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Clob.html#com.amazon.carbonado.spi">Clob</a> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/lob/class-use/Lob.html#com.amazon.carbonado.spi">Lob</a> +<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<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> |