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