diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/DatabaseStream.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/DatabaseStream.html | 425 |
1 files changed, 425 insertions, 0 deletions
diff --git a/docs/java/com/sleepycat/db/DatabaseStream.html b/docs/java/com/sleepycat/db/DatabaseStream.html new file mode 100644 index 00000000..bcb4661d --- /dev/null +++ b/docs/java/com/sleepycat/db/DatabaseStream.html @@ -0,0 +1,425 @@ +<!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_60) on Tue Feb 17 12:25:53 EST 2015 --> +<title>DatabaseStream (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DatabaseStream (Oracle - Berkeley DB Java 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/DatabaseStream.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/DatabaseStats.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/DatabaseStreamConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/DatabaseStream.html" target="_top">Frames</a></li> +<li><a href="DatabaseStream.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.sleepycat.db</div> +<h2 title="Class DatabaseStream" class="title">Class DatabaseStream</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.db.DatabaseStream</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DatabaseStream</span> +extends java.lang.Object</pre> +<div class="block">A database stream. The database stream is used to access the blob. +<p> +Once the database stream close method has been called, the handle may not +be accessed again. +<p> +To obtain a database stream with default attributes: +<blockquote><pre> + DatabaseStream dbs = myCursor.openDatabaseStream(null); +</pre></blockquote> +To customize the attributes of a database stream, +use a DatabaseStreamConfig object. +<blockquote><pre> + DatabaseStreamConfig config = new DatabaseStreamConfig(); + config.setReadOnly(true); + DatabaseStream dbs = myCursor.openDatabaseStream(config); +</pre></blockquote></div> +</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/sleepycat/db/DatabaseStream.html#DatabaseStream(com.sleepycat.db.Cursor,%20com.sleepycat.db.DatabaseStreamConfig)">DatabaseStream</a></strong>(<a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a> cursor, + <a href="../../../com/sleepycat/db/DatabaseStreamConfig.html" title="class in com.sleepycat.db">DatabaseStreamConfig</a> config)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseStream.html#close()">close</a></strong>()</code> +<div class="block">Discard the database stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/DatabaseStreamConfig.html" title="class in com.sleepycat.db">DatabaseStreamConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseStream.html#getConfig()">getConfig</a></strong>()</code> +<div class="block">Return this database stream configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseStream.html#getCursor()">getCursor</a></strong>()</code> +<div class="block">Return the <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handle associated + with this database stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseStream.html#read(com.sleepycat.db.DatabaseEntry,%20long,%20int)">read</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + long offset, + int size)</code> +<div class="block">Read from the blob accessed by this database stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseStream.html#size()">size</a></strong>()</code> +<div class="block">Return the size in bytes of the blob accessed by the database stream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseStream.html#write(com.sleepycat.db.DatabaseEntry,%20long)">write</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + long offset)</code> +<div class="block">Write to the blob accessed by the database stream.</div> +</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="DatabaseStream(com.sleepycat.db.Cursor, com.sleepycat.db.DatabaseStreamConfig)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DatabaseStream</h4> +<pre>protected DatabaseStream(<a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a> cursor, + <a href="../../../com/sleepycat/db/DatabaseStreamConfig.html" title="class in com.sleepycat.db">DatabaseStreamConfig</a> config)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Discard the database stream. + <p> + After the close method has been called, you cannot use the database stream + handle again. + <p> + It is recommended to always close all database stream handles immediately + after their use to release resources. + <p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfig</h4> +<pre>public <a href="../../../com/sleepycat/db/DatabaseStreamConfig.html" title="class in com.sleepycat.db">DatabaseStreamConfig</a> getConfig()</pre> +<div class="block">Return this database stream configuration. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>This database stream configuration. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getCursor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCursor</h4> +<pre>public <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a> getCursor()</pre> +<div class="block">Return the <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handle associated + with this database stream. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The cursor handle associated with this database stream.</dd></dl> +</li> +</ul> +<a name="read(com.sleepycat.db.DatabaseEntry, long, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> read(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + long offset, + int size) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.lang.IllegalArgumentException</pre> +<div class="block">Read from the blob accessed by this database stream. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - the data read from the blob + returned as output. Its byte array does not need to be initialized by the + caller. + <p></dd><dd><code>offset</code> - the position in bytes in the blob where the reading starts. + <p></dd><dd><code>size</code> - the number of bytes to read. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a> + if the operation succeeds. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if a failure occurs. + <p></dd> +<dd><code>java.lang.IllegalArgumentException</code> - if the operation fails. + <p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public long size() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the size in bytes of the blob accessed by the database stream. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The size in bytes of the blob accessed by the database stream. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="write(com.sleepycat.db.DatabaseEntry, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>write</h4> +<pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> write(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + long offset) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.lang.IllegalArgumentException</pre> +<div class="block">Write to the blob accessed by the database stream. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - the data <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> + to write into the blob. + <p></dd><dd><code>offset</code> - the position in bytes in the blob where the writing starts. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a> + if the operation succeeds. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if the operation fails. + <p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</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/DatabaseStream.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-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/DatabaseStats.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/DatabaseStreamConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/DatabaseStream.html" target="_top">Frames</a></li> +<li><a href="DatabaseStream.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><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |