1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:47 EDT 2010 --> 6<TITLE> 7LockOperation (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="LockOperation (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LockOperation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/db/LockOperation.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="LockOperation.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.db</FONT> 92<BR> 93Class LockOperation</H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.LockOperation</B> 97</PRE> 98<HR> 99<DL> 100<DT><PRE>public final class <B>LockOperation</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> 101</PRE> 102 103<P> 104Operations that can be performed on locks. 105<P> 106 107<P> 108<HR> 109 110<P> 111<!-- =========== FIELD SUMMARY =========== --> 112 113<A NAME="field_summary"><!-- --></A> 114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 117<B>Field Summary</B></FONT></TH> 118</TR> 119<TR BGCOLOR="white" CLASS="TableRowColor"> 120<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 121<CODE>static <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A></CODE></FONT></TD> 122<TD><CODE><B><A HREF="../../../com/sleepycat/db/LockOperation.html#GET">GET</A></B></CODE> 123 124<BR> 125 Get the lock defined by the values of the mode and obj fields, for 126 the specified locker.</TD> 127</TR> 128<TR BGCOLOR="white" CLASS="TableRowColor"> 129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 130<CODE>static <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A></CODE></FONT></TD> 131<TD><CODE><B><A HREF="../../../com/sleepycat/db/LockOperation.html#GET_TIMEOUT">GET_TIMEOUT</A></B></CODE> 132 133<BR> 134 Identical to LockOperation GET except that the value in the timeout 135 field overrides any previously specified timeout value for this 136 lock.</TD> 137</TR> 138<TR BGCOLOR="white" CLASS="TableRowColor"> 139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 140<CODE>static <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A></CODE></FONT></TD> 141<TD><CODE><B><A HREF="../../../com/sleepycat/db/LockOperation.html#PUT">PUT</A></B></CODE> 142 143<BR> 144 The lock to which the lock field refers is released.</TD> 145</TR> 146<TR BGCOLOR="white" CLASS="TableRowColor"> 147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 148<CODE>static <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A></CODE></FONT></TD> 149<TD><CODE><B><A HREF="../../../com/sleepycat/db/LockOperation.html#PUT_ALL">PUT_ALL</A></B></CODE> 150 151<BR> 152 All locks held by the specified locker are released.</TD> 153</TR> 154<TR BGCOLOR="white" CLASS="TableRowColor"> 155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 156<CODE>static <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A></CODE></FONT></TD> 157<TD><CODE><B><A HREF="../../../com/sleepycat/db/LockOperation.html#PUT_OBJ">PUT_OBJ</A></B></CODE> 158 159<BR> 160 All locks held on obj are released.</TD> 161</TR> 162<TR BGCOLOR="white" CLASS="TableRowColor"> 163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 164<CODE>static <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A></CODE></FONT></TD> 165<TD><CODE><B><A HREF="../../../com/sleepycat/db/LockOperation.html#TIMEOUT">TIMEOUT</A></B></CODE> 166 167<BR> 168 Cause the specified locker to timeout immediately.</TD> 169</TR> 170</TABLE> 171 172<!-- ========== METHOD SUMMARY =========== --> 173 174<A NAME="method_summary"><!-- --></A> 175<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 176<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 177<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 178<B>Method Summary</B></FONT></TH> 179</TR> 180<TR BGCOLOR="white" CLASS="TableRowColor"> 181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 182<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 183<TD><CODE><B><A HREF="../../../com/sleepycat/db/LockOperation.html#toString()">toString</A></B>()</CODE> 184 185<BR> 186 </TD> 187</TR> 188</TABLE> 189 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 190<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 191<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 192<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 193</TR> 194<TR BGCOLOR="white" CLASS="TableRowColor"> 195<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 196</TR> 197</TABLE> 198 199<P> 200 201<!-- ============ FIELD DETAIL =========== --> 202 203<A NAME="field_detail"><!-- --></A> 204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 205<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 206<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 207<B>Field Detail</B></FONT></TH> 208</TR> 209</TABLE> 210 211<A NAME="GET"><!-- --></A><H3> 212GET</H3> 213<PRE> 214public static final <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A> <B>GET</B></PRE> 215<DL> 216<DD>Get the lock defined by the values of the mode and obj fields, for 217 the specified locker. Upon return from <A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><CODE>Environment.lockVector</CODE></A>, if the lock field is non-null, a reference to the 218 acquired lock is stored there. (This reference is invalidated by 219 any call to <A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><CODE>Environment.lockVector</CODE></A> or <A HREF="../../../com/sleepycat/db/Environment.html#putLock(com.sleepycat.db.Lock)"><CODE>Environment.putLock</CODE></A> that releases the lock.) 220<P> 221<DL> 222</DL> 223</DL> 224<HR> 225 226<A NAME="GET_TIMEOUT"><!-- --></A><H3> 227GET_TIMEOUT</H3> 228<PRE> 229public static final <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A> <B>GET_TIMEOUT</B></PRE> 230<DL> 231<DD>Identical to LockOperation GET except that the value in the timeout 232 field overrides any previously specified timeout value for this 233 lock. A value of 0 turns off any previously specified timeout. 234<P> 235<DL> 236</DL> 237</DL> 238<HR> 239 240<A NAME="PUT"><!-- --></A><H3> 241PUT</H3> 242<PRE> 243public static final <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A> <B>PUT</B></PRE> 244<DL> 245<DD>The lock to which the lock field refers is released. The locker, 246 mode and obj fields are ignored. 247<P> 248<DL> 249</DL> 250</DL> 251<HR> 252 253<A NAME="PUT_ALL"><!-- --></A><H3> 254PUT_ALL</H3> 255<PRE> 256public static final <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A> <B>PUT_ALL</B></PRE> 257<DL> 258<DD>All locks held by the specified locker are released. The lock, 259 mode, and obj fields are ignored. Locks acquired in operations 260 performed by the current call to <A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><CODE>Environment.lockVector</CODE></A> 261 which appear before the PUT_ALL operation are released; those 262 acquired in operations appearing after the PUT_ALL operation are not 263 released. 264<P> 265<DL> 266</DL> 267</DL> 268<HR> 269 270<A NAME="PUT_OBJ"><!-- --></A><H3> 271PUT_OBJ</H3> 272<PRE> 273public static final <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A> <B>PUT_OBJ</B></PRE> 274<DL> 275<DD>All locks held on obj are released. The locker parameter and the 276 lock and mode fields are ignored. Locks acquired in operations 277 performed by the current call to <A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><CODE>Environment.lockVector</CODE></A> 278 that appear before the PUT_OBJ operation operation are released; 279 those acquired in operations appearing after the PUT_OBJ operation 280 are not released. 281<P> 282<DL> 283</DL> 284</DL> 285<HR> 286 287<A NAME="TIMEOUT"><!-- --></A><H3> 288TIMEOUT</H3> 289<PRE> 290public static final <A HREF="../../../com/sleepycat/db/LockOperation.html" title="class in com.sleepycat.db">LockOperation</A> <B>TIMEOUT</B></PRE> 291<DL> 292<DD>Cause the specified locker to timeout immediately. If the database 293 environment has not configured automatic deadlock detection, the 294 transaction will timeout the next time deadlock detection is 295 performed. As transactions acquire locks on behalf of a single 296 locker ID, timing out the locker ID associated with a transaction 297 will time out the transaction itself. 298<P> 299<DL> 300</DL> 301</DL> 302 303<!-- ============ METHOD DETAIL ========== --> 304 305<A NAME="method_detail"><!-- --></A> 306<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 307<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 308<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 309<B>Method Detail</B></FONT></TH> 310</TR> 311</TABLE> 312 313<A NAME="toString()"><!-- --></A><H3> 314toString</H3> 315<PRE> 316public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> 317<DL> 318<DD> 319<P> 320<DD><DL> 321<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 322</DD> 323<DD><DL> 324</DL> 325</DD> 326</DL> 327<!-- ========= END OF CLASS DATA ========= --> 328<HR> 329 330 331<!-- ======= START OF BOTTOM NAVBAR ====== --> 332<A NAME="navbar_bottom"><!-- --></A> 333<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 334<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 335<TR> 336<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 337<A NAME="navbar_bottom_firstrow"><!-- --></A> 338<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 339 <TR ALIGN="center" VALIGN="top"> 340 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 341 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 342 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 343 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LockOperation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 344 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 345 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 346 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 347 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 348 </TR> 349</TABLE> 350</TD> 351<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 352<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 353</TD> 354</TR> 355 356<TR> 357<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 358 <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 359 <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 360<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 361 <A HREF="../../../index.html?com/sleepycat/db/LockOperation.html" target="_top"><B>FRAMES</B></A> 362 <A HREF="LockOperation.html" target="_top"><B>NO FRAMES</B></A> 363 <SCRIPT type="text/javascript"> 364 <!-- 365 if(window==top) { 366 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 367 } 368 //--> 369</SCRIPT> 370<NOSCRIPT> 371 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 372</NOSCRIPT> 373 374 375</FONT></TD> 376</TR> 377<TR> 378<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 379 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 380<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 381DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 382</TR> 383</TABLE> 384<A NAME="skip-navbar_bottom"></A> 385<!-- ======== END OF BOTTOM NAVBAR ======= --> 386 387<HR> 388<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 389</BODY> 390</HTML> 391
