solr-4.6.0/docs/solr-core/org/apache/solr/store/blockcache/BlockLocks.html

   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_30) on Tue Nov 19 11:16:55 CET 2013 -->
   6 <META http-equiv="Content-Type" content="text/html; charset=utf-8">
   7 <TITLE>
   8 BlockLocks (Solr 4.6.0 API)
   9 </TITLE>
  10
  11 <META NAME="date" CONTENT="2013-11-19">
  12
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
  14
  15 <SCRIPT type="text/javascript">
  16 function windowTitle()
  17 {
  18     if (location.href.indexOf('is-external=true') == -1) {
  19         parent.document.title="BlockLocks (Solr 4.6.0 API)";
  20     }
  21 }
  22 </SCRIPT>
  23 <NOSCRIPT>
  24 </NOSCRIPT>
  25
  26 </HEAD>
  27
  28 <BODY BGCOLOR="white" onload="windowTitle();">
  29 <HR>
  30
  31
  32 <!-- ========= START OF TOP NAVBAR ======= -->
  33 <A NAME="navbar_top"><!-- --></A>
  34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  36 <TR>
  37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  38 <A NAME="navbar_top_firstrow"><!-- --></A>
  39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  40   <TR ALIGN="center" VALIGN="top">
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BlockLocks.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  48   </TR>
  49 </TABLE>
  50 </TD>
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  52 </EM>
  53 </TD>
  54 </TR>
  55
  56 <TR>
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  58 &nbsp;<A HREF="../../../../../org/apache/solr/store/blockcache/BlockDirectoryCache.html" title="class in org.apache.solr.store.blockcache"><B>PREV CLASS</B></A>&nbsp;
  59 &nbsp;<A HREF="../../../../../org/apache/solr/store/blockcache/BufferStore.html" title="class in org.apache.solr.store.blockcache"><B>NEXT CLASS</B></A></FONT></TD>
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  61   <A HREF="../../../../../index.html?org/apache/solr/store/blockcache/BlockLocks.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  62 &nbsp;<A HREF="BlockLocks.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  63 &nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
  91 org.apache.solr.store.blockcache</FONT>
  92 <BR>
  93 Class BlockLocks</H2>
  94 <PRE>
  95 <A HREF="http://download.oracle.com/javase/6/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>org.apache.solr.store.blockcache.BlockLocks</B>
  97 </PRE>
  98 <HR>
  99 <DL>
 100 <DT><PRE>public class <B>BlockLocks</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
 101 </PRE>
 102
 103 <P>
 104 <HR>
 105
 106 <P>
 107
 108 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 109
 110 <A NAME="constructor_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>Constructor Summary</B></FONT></TH>
 115 </TR>
 116 <TR BGCOLOR="white" CLASS="TableRowColor">
 117 <TD><CODE><B><A HREF="../../../../../org/apache/solr/store/blockcache/BlockLocks.html#BlockLocks(long)">BlockLocks</A></B>(long&nbsp;numBits)</CODE>
 118
 119 <BR>
 120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 121 </TR>
 122 </TABLE>
 123 &nbsp;
 124 <!-- ========== METHOD SUMMARY =========== -->
 125
 126 <A NAME="method_summary"><!-- --></A>
 127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 129 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 130 <B>Method Summary</B></FONT></TH>
 131 </TR>
 132 <TR BGCOLOR="white" CLASS="TableRowColor">
 133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 134 <CODE>&nbsp;void</CODE></FONT></TD>
 135 <TD><CODE><B><A HREF="../../../../../org/apache/solr/store/blockcache/BlockLocks.html#clear(int)">clear</A></B>(int&nbsp;index)</CODE>
 136
 137 <BR>
 138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
 139 </TR>
 140 <TR BGCOLOR="white" CLASS="TableRowColor">
 141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 142 <CODE>&nbsp;int</CODE></FONT></TD>
 143 <TD><CODE><B><A HREF="../../../../../org/apache/solr/store/blockcache/BlockLocks.html#nextClearBit(int)">nextClearBit</A></B>(int&nbsp;index)</CODE>
 144
 145 <BR>
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Find the next clear bit in the bit set.</TD>
 147 </TR>
 148 <TR BGCOLOR="white" CLASS="TableRowColor">
 149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 150 <CODE>&nbsp;boolean</CODE></FONT></TD>
 151 <TD><CODE><B><A HREF="../../../../../org/apache/solr/store/blockcache/BlockLocks.html#set(int)">set</A></B>(int&nbsp;index)</CODE>
 152
 153 <BR>
 154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Thread safe set operation that will set the bit if and only if the bit was
 155  not previously set.</TD>
 156 </TR>
 157 </TABLE>
 158 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 159 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 160 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 161 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
 162 </TR>
 163 <TR BGCOLOR="white" CLASS="TableRowColor">
 164 <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
 165 </TR>
 166 </TABLE>
 167 &nbsp;
 168 <P>
 169
 170 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 171
 172 <A NAME="constructor_detail"><!-- --></A>
 173 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 174 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 175 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 176 <B>Constructor Detail</B></FONT></TH>
 177 </TR>
 178 </TABLE>
 179
 180 <A NAME="BlockLocks(long)"><!-- --></A><H3>
 181 BlockLocks</H3>
 182 <PRE>
 183 public <B>BlockLocks</B>(long&nbsp;numBits)</PRE>
 184 <DL>
 185 </DL>
 186
 187 <!-- ============ METHOD DETAIL ========== -->
 188
 189 <A NAME="method_detail"><!-- --></A>
 190 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 191 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 192 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 193 <B>Method Detail</B></FONT></TH>
 194 </TR>
 195 </TABLE>
 196
 197 <A NAME="nextClearBit(int)"><!-- --></A><H3>
 198 nextClearBit</H3>
 199 <PRE>
 200 public int <B>nextClearBit</B>(int&nbsp;index)</PRE>
 201 <DL>
 202 <DD>Find the next clear bit in the bit set.
 203 <P>
 204 <DD><DL>
 205 <DT><B>Parameters:</B><DD><CODE>index</CODE> - index
 206 <DT><B>Returns:</B><DD>next next bit</DL>
 207 </DD>
 208 </DL>
 209 <HR>
 210
 211 <A NAME="set(int)"><!-- --></A><H3>
 212 set</H3>
 213 <PRE>
 214 public boolean <B>set</B>(int&nbsp;index)</PRE>
 215 <DL>
 216 <DD>Thread safe set operation that will set the bit if and only if the bit was
 217  not previously set.
 218 <P>
 219 <DD><DL>
 220 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index position to set.
 221 <DT><B>Returns:</B><DD>returns true if the bit was set and false if it was already set.</DL>
 222 </DD>
 223 </DL>
 224 <HR>
 225
 226 <A NAME="clear(int)"><!-- --></A><H3>
 227 clear</H3>
 228 <PRE>
 229 public void <B>clear</B>(int&nbsp;index)</PRE>
 230 <DL>
 231 <DD><DL>
 232 </DL>
 233 </DD>
 234 </DL>
 235 <!-- ========= END OF CLASS DATA ========= -->
 236 <HR>
 237
 238
 239 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 240 <A NAME="navbar_bottom"><!-- --></A>
 241 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 242 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 243 <TR>
 244 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 245 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 246 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 247   <TR ALIGN="center" VALIGN="top">
 248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 249   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 250   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 251   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/BlockLocks.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 252   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 253   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 255   </TR>
 256 </TABLE>
 257 </TD>
 258 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 259 </EM>
 260 </TD>
 261 </TR>
 262
 263 <TR>
 264 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 265 &nbsp;<A HREF="../../../../../org/apache/solr/store/blockcache/BlockDirectoryCache.html" title="class in org.apache.solr.store.blockcache"><B>PREV CLASS</B></A>&nbsp;
 266 &nbsp;<A HREF="../../../../../org/apache/solr/store/blockcache/BufferStore.html" title="class in org.apache.solr.store.blockcache"><B>NEXT CLASS</B></A></FONT></TD>
 267 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 268   <A HREF="../../../../../index.html?org/apache/solr/store/blockcache/BlockLocks.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 269 &nbsp;<A HREF="BlockLocks.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 270 &nbsp;<SCRIPT type="text/javascript">
 271   <!--
 272   if(window==top) {
 273     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 274   }
 275   //-->
 276 </SCRIPT>
 277 <NOSCRIPT>
 278   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 279 </NOSCRIPT>
 280
 281
 282 </FONT></TD>
 283 </TR>
 284 <TR>
 285 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 286   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 287 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 288 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 289 </TR>
 290 </TABLE>
 291 <A NAME="skip-navbar_bottom"></A>
 292 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 293
 294 <HR>
 295
 296           <i>Copyright &copy; 2000-2013 Apache Software Foundation.  All Rights Reserved.</i>
 297           <script src='../../../../../prettify.js' type='text/javascript'></script>
 298           <script type='text/javascript'>
 299             (function(){
 300               var oldonload = window.onload;
 301               if (typeof oldonload != 'function') {
 302                 window.onload = prettyPrint;
 303               } else {
 304                 window.onload = function() {
 305                   oldonload();
 306                   prettyPrint();
 307                 }
 308               }
 309             })();
 310           </script>
 311
 312 </BODY>
 313 </HTML>