<!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_75) on Fri May 13 13:32:16 PDT 2016 --> <title>LockRequest (Oracle - Berkeley DB Java API)</title> <meta name="date" content="2016-05-13"> <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="LockRequest (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/LockRequest.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.29</font></em></div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/sleepycat/db/LockRequestMode.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/LockRequest.html" target="_top">Frames</a></li> <li><a href="LockRequest.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 LockRequest" class="title">Class LockRequest</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.sleepycat.db.LockRequest</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">LockRequest</span> extends java.lang.Object</pre> <div class="block">The LockRequest object is used to encapsulate a single lock request.</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="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#LockRequest(com.sleepycat.db.LockOperation,%20com.sleepycat.db.LockRequestMode,%20com.sleepycat.db.DatabaseEntry)">LockRequest</a></strong>(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op, <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj)</code> <div class="block">Construct a LockRequest with the specified operation and mode for the specified object.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#LockRequest(com.sleepycat.db.LockOperation,%20com.sleepycat.db.LockRequestMode,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.Lock)">LockRequest</a></strong>(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op, <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj, <a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock)</code> <div class="block">Construct a LockRequest with the specified operation, mode and lock, for the specified object.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#LockRequest(com.sleepycat.db.LockOperation,%20com.sleepycat.db.LockRequestMode,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.Lock,%20int)">LockRequest</a></strong>(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op, <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj, <a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock, int timeout)</code> <div class="block">Construct a LockRequest with the specified operation, mode, lock and timeout for the specified object.</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><a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#getLock()">getLock</a></strong>()</code> <div class="block">Return the lock reference.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#getMode()">getMode</a></strong>()</code> <div class="block">Return the lock mode.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#getObj()">getObj</a></strong>()</code> <div class="block">Return the lock object.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a></code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#getOp()">getOp</a></strong>()</code> <div class="block">Return the lock operation.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#getTimeout()">getTimeout</a></strong>()</code> <div class="block">Return the lock timeout value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#setLock(com.sleepycat.db.Lock)">setLock</a></strong>(<a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock)</code> <div class="block">Set the lock reference.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#setMode(com.sleepycat.db.LockRequestMode)">setMode</a></strong>(<a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode)</code> <div class="block">Set the lock mode.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#setObj(com.sleepycat.db.DatabaseEntry)">setObj</a></strong>(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj)</code> <div class="block">Set the lock object.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#setOp(com.sleepycat.db.LockOperation)">setOp</a></strong>(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op)</code> <div class="block">Set the operation.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../com/sleepycat/db/LockRequest.html#setTimeout(int)">setTimeout</a></strong>(int timeout)</code> <div class="block">Set the lock timeout value.</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="LockRequest(com.sleepycat.db.LockOperation, com.sleepycat.db.LockRequestMode, com.sleepycat.db.DatabaseEntry)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>LockRequest</h4> <pre>public LockRequest(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op, <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj)</pre> <div class="block">Construct a LockRequest with the specified operation and mode for the specified object. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - The permissions mode for the object. <p></dd><dd><code>obj</code> - The object being locked. <p></dd><dd><code>op</code> - The operation being performed.</dd></dl> </li> </ul> <a name="LockRequest(com.sleepycat.db.LockOperation, com.sleepycat.db.LockRequestMode, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.Lock)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>LockRequest</h4> <pre>public LockRequest(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op, <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj, <a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock)</pre> <div class="block">Construct a LockRequest with the specified operation, mode and lock, for the specified object. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - The permissions mode for the object. <p></dd><dd><code>obj</code> - The object being locked. <p></dd><dd><code>op</code> - The operation being performed. <p></dd><dd><code>lock</code> - The lock type for the object.</dd></dl> </li> </ul> <a name="LockRequest(com.sleepycat.db.LockOperation, com.sleepycat.db.LockRequestMode, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.Lock, int)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>LockRequest</h4> <pre>public LockRequest(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op, <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode, <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj, <a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock, int timeout)</pre> <div class="block">Construct a LockRequest with the specified operation, mode, lock and timeout for the specified object. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lock</code> - The lock type for the object. <p></dd><dd><code>mode</code> - The permissions mode for the object. <p></dd><dd><code>obj</code> - The object being locked. <p></dd><dd><code>op</code> - The operation being performed. <p></dd><dd><code>timeout</code> - The timeout value for the lock.</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="setLock(com.sleepycat.db.Lock)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setLock</h4> <pre>public void setLock(<a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> lock)</pre> <div class="block">Set the lock reference. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lock</code> - The lock reference.</dd></dl> </li> </ul> <a name="setMode(com.sleepycat.db.LockRequestMode)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setMode</h4> <pre>public void setMode(<a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode)</pre> <div class="block">Set the lock mode. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - the lock mode.</dd></dl> </li> </ul> <a name="setObj(com.sleepycat.db.DatabaseEntry)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setObj</h4> <pre>public void setObj(<a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> obj)</pre> <div class="block">Set the lock object. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - The lock object.</dd></dl> </li> </ul> <a name="setOp(com.sleepycat.db.LockOperation)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setOp</h4> <pre>public void setOp(<a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> op)</pre> <div class="block">Set the operation. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>op</code> - The operation.</dd></dl> </li> </ul> <a name="setTimeout(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setTimeout</h4> <pre>public void setTimeout(int timeout)</pre> <div class="block">Set the lock timeout value. <p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - The lock timeout value.</dd></dl> </li> </ul> <a name="getLock()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLock</h4> <pre>public <a href="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</a> getLock()</pre> <div class="block">Return the lock reference.</div> </li> </ul> <a name="getMode()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getMode</h4> <pre>public <a href="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> getMode()</pre> <div class="block">Return the lock mode.</div> </li> </ul> <a name="getObj()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getObj</h4> <pre>public <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> getObj()</pre> <div class="block">Return the lock object.</div> </li> </ul> <a name="getOp()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOp</h4> <pre>public <a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</a> getOp()</pre> <div class="block">Return the lock operation.</div> </li> </ul> <a name="getTimeout()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getTimeout</h4> <pre>public int getTimeout()</pre> <div class="block">Return the lock timeout value.</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/LockRequest.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.29</font></em></div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> <li><a href="../../../com/sleepycat/db/LockRequestMode.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/LockRequest.html" target="_top">Frames</a></li> <li><a href="LockRequest.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, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p> </body> </html>