diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/lob/FileBlob.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/lob/FileBlob.html | 468 |
1 files changed, 468 insertions, 0 deletions
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> |