content/docs/r3.3.1/hadoop-project-dist/hadoop-common/build/source/hadoop-common-project/hadoop-common/target/api/org/apache/hadoop/util/AutoCloseableLock.html - hadoop-site - Git at Google

 <!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 (1.8.0_292) on Tue Jun 15 06:01:49 GMT 2021 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>AutoCloseableLock (Apache Hadoop Common 3.3.1 API)</title>
 <meta name="date" content="2021-06-15">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="AutoCloseableLock (Apache Hadoop Common 3.3.1 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <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/AutoCloseableLock.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>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/apache/hadoop/util/ApplicationClassLoader.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/hadoop/util/BasicDiskValidator.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/hadoop/util/AutoCloseableLock.html" target="_top">Frames</a></li>
 <li><a href="AutoCloseableLock.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">org.apache.hadoop.util</div>
 <h2 title="Class AutoCloseableLock" class="title">Class AutoCloseableLock</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li>org.apache.hadoop.util.AutoCloseableLock</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public class <span class="typeNameLabel">AutoCloseableLock</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
 implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
 <div class="block">This is a wrap class of a ReentrantLock. Extending AutoCloseable
  interface such that the users can use a try-with-resource syntax.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#AutoCloseableLock--">AutoCloseableLock</a></span>()</code>
 <div class="block">Creates an instance of <code>AutoCloseableLock</code>, initializes
  the underlying lock instance with a new <code>ReentrantLock</code>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#AutoCloseableLock-java.util.concurrent.locks.Lock-">AutoCloseableLock</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a>&nbsp;lock)</code>
 <div class="block">Wrap provided Lock instance.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html" title="class in org.apache.hadoop.util">AutoCloseableLock</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#acquire--">acquire</a></span>()</code>
 <div class="block">A wrapper method that makes a call to <code>lock()</code> of the underlying
  <code>ReentrantLock</code> object.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#close--">close</a></span>()</code>
 <div class="block">Attempts to release the lock by making a call to <code>release()</code>.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Condition.html?is-external=true" title="class or interface in java.util.concurrent.locks">Condition</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#newCondition--">newCondition</a></span>()</code>
 <div class="block">See <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantLock.html?is-external=true#newCondition--" title="class or interface in java.util.concurrent.locks"><code>ReentrantLock.newCondition()</code></a>.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#release--">release</a></span>()</code>
 <div class="block">A wrapper method that makes a call to <code>unlock()</code> of the
  underlying <code>ReentrantLock</code> object.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#tryLock--">tryLock</a></span>()</code>
 <div class="block">A wrapper method that makes a call to <code>tryLock()</code> of
  the underlying <code>Lock</code> object.</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&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="AutoCloseableLock--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>AutoCloseableLock</h4>
 <pre>public&nbsp;AutoCloseableLock()</pre>
 <div class="block">Creates an instance of <code>AutoCloseableLock</code>, initializes
  the underlying lock instance with a new <code>ReentrantLock</code>.</div>
 </li>
 </ul>
 <a name="AutoCloseableLock-java.util.concurrent.locks.Lock-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>AutoCloseableLock</h4>
 <pre>public&nbsp;AutoCloseableLock(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a>&nbsp;lock)</pre>
 <div class="block">Wrap provided Lock instance.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>lock</code> - Lock instance to wrap in AutoCloseable API.</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="acquire--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>acquire</h4>
 <pre>public&nbsp;<a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html" title="class in org.apache.hadoop.util">AutoCloseableLock</a>&nbsp;acquire()</pre>
 <div class="block">A wrapper method that makes a call to <code>lock()</code> of the underlying
  <code>ReentrantLock</code> object.

  Acquire teh lock it is not held by another thread, then sets
  lock held count to one, then returns immediately.

  If the current thread already holds the lock, increase the lock
  help count by one and returns immediately.

  If the lock is held by another thread, the current thread is
  suspended until the lock has been acquired by current thread.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The <code>ReentrantLock</code> object itself. This is to
  support try-with-resource syntax.</dd>
 </dl>
 </li>
 </ul>
 <a name="release--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>release</h4>
 <pre>public&nbsp;void&nbsp;release()</pre>
 <div class="block">A wrapper method that makes a call to <code>unlock()</code> of the
  underlying <code>ReentrantLock</code> object.

  Attempts to release the lock.

  If the current thread holds the lock, decrements the hold
  count. If the hold count reaches zero, the lock is released.

  If the current thread does not hold the lock, then
  <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalMonitorStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalMonitorStateException</code></a> is thrown.</div>
 </li>
 </ul>
 <a name="close--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>close</h4>
 <pre>public&nbsp;void&nbsp;close()</pre>
 <div class="block">Attempts to release the lock by making a call to <code>release()</code>.

  This is to implement <code>close()</code> method from <code>AutoCloseable</code>
  interface. This allows users to user a try-with-resource syntax, where
  the lock can be automatically released.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
 </dl>
 </li>
 </ul>
 <a name="tryLock--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>tryLock</h4>
 <pre>public&nbsp;boolean&nbsp;tryLock()</pre>
 <div class="block">A wrapper method that makes a call to <code>tryLock()</code> of
  the underlying <code>Lock</code> object.

  If the lock is not held by another thread, acquires the lock, set the
  hold count to one and returns <code>true</code>.

  If the current thread already holds the lock, the increment the hold
  count by one and returns <code>true</code>.

  If the lock is held by another thread then the method returns
  immediately with <code>false</code>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd><code>true</code> if the lock was free and was acquired by the
           current thread, or the lock was already held by the current
           thread; and <code>false</code> otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a name="newCondition--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>newCondition</h4>
 <pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Condition.html?is-external=true" title="class or interface in java.util.concurrent.locks">Condition</a>&nbsp;newCondition()</pre>
 <div class="block">See <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantLock.html?is-external=true#newCondition--" title="class or interface in java.util.concurrent.locks"><code>ReentrantLock.newCondition()</code></a>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the Condition object</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>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <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/AutoCloseableLock.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>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/apache/hadoop/util/ApplicationClassLoader.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/hadoop/util/BasicDiskValidator.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/hadoop/util/AutoCloseableLock.html" target="_top">Frames</a></li>
 <li><a href="AutoCloseableLock.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>
	<!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 (1.8.0_292) on Tue Jun 15 06:01:49 GMT 2021 -->
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<title>AutoCloseableLock (Apache Hadoop Common 3.3.1 API)</title>
	<meta name="date" content="2021-06-15">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="AutoCloseableLock (Apache Hadoop Common 3.3.1 API)";
	}
	}
	catch(err) {
	}
	//-->
	var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a name="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<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/AutoCloseableLock.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>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../../org/apache/hadoop/util/ApplicationClassLoader.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../org/apache/hadoop/util/BasicDiskValidator.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?org/apache/hadoop/util/AutoCloseableLock.html" target="_top">Frames</a></li>
	<li><a href="AutoCloseableLock.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">org.apache.hadoop.util</div>
	<h2 title="Class AutoCloseableLock" class="title">Class AutoCloseableLock</h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
	<li>
	<ul class="inheritance">
	<li>org.apache.hadoop.util.AutoCloseableLock</li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<dl>
	<dt>All Implemented Interfaces:</dt>
	<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
	</dl>
	<hr>
	<br>
	<pre>public class <span class="typeNameLabel">AutoCloseableLock</span>
	extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
	implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></pre>
	<div class="block">This is a wrap class of a ReentrantLock. Extending AutoCloseable
	interface such that the users can use a try-with-resource syntax.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#AutoCloseableLock--">AutoCloseableLock</a></span>()</code>
	<div class="block">Creates an instance of <code>AutoCloseableLock</code>, initializes
	the underlying lock instance with a new <code>ReentrantLock</code>.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#AutoCloseableLock-java.util.concurrent.locks.Lock-">AutoCloseableLock</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a> lock)</code>
	<div class="block">Wrap provided Lock instance.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
	<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Method and Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html" title="class in org.apache.hadoop.util">AutoCloseableLock</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#acquire--">acquire</a></span>()</code>
	<div class="block">A wrapper method that makes a call to <code>lock()</code> of the underlying
	<code>ReentrantLock</code> object.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>void</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#close--">close</a></span>()</code>
	<div class="block">Attempts to release the lock by making a call to <code>release()</code>.</div>
	</td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Condition.html?is-external=true" title="class or interface in java.util.concurrent.locks">Condition</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#newCondition--">newCondition</a></span>()</code>
	<div class="block">See <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantLock.html?is-external=true#newCondition--" title="class or interface in java.util.concurrent.locks"><code>ReentrantLock.newCondition()</code></a>.</div>
	</td>
	</tr>
	<tr id="i3" class="rowColor">
	<td class="colFirst"><code>void</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#release--">release</a></span>()</code>
	<div class="block">A wrapper method that makes a call to <code>unlock()</code> of the
	underlying <code>ReentrantLock</code> object.</div>
	</td>
	</tr>
	<tr id="i4" class="altColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html#tryLock--">tryLock</a></span>()</code>
	<div class="block">A wrapper method that makes a call to <code>tryLock()</code> of
	the underlying <code>Lock</code> object.</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.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
	<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="AutoCloseableLock--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>AutoCloseableLock</h4>
	<pre>public AutoCloseableLock()</pre>
	<div class="block">Creates an instance of <code>AutoCloseableLock</code>, initializes
	the underlying lock instance with a new <code>ReentrantLock</code>.</div>
	</li>
	</ul>
	<a name="AutoCloseableLock-java.util.concurrent.locks.Lock-">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>AutoCloseableLock</h4>
	<pre>public AutoCloseableLock(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Lock.html?is-external=true" title="class or interface in java.util.concurrent.locks">Lock</a> lock)</pre>
	<div class="block">Wrap provided Lock instance.</div>
	<dl>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>lock</code> - Lock instance to wrap in AutoCloseable API.</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="acquire--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>acquire</h4>
	<pre>public <a href="../../../../org/apache/hadoop/util/AutoCloseableLock.html" title="class in org.apache.hadoop.util">AutoCloseableLock</a> acquire()</pre>
	<div class="block">A wrapper method that makes a call to <code>lock()</code> of the underlying
	<code>ReentrantLock</code> object.

	Acquire teh lock it is not held by another thread, then sets
	lock held count to one, then returns immediately.

	If the current thread already holds the lock, increase the lock
	help count by one and returns immediately.

	If the lock is held by another thread, the current thread is
	suspended until the lock has been acquired by current thread.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The <code>ReentrantLock</code> object itself. This is to
	support try-with-resource syntax.</dd>
	</dl>
	</li>
	</ul>
	<a name="release--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>release</h4>
	<pre>public void release()</pre>
	<div class="block">A wrapper method that makes a call to <code>unlock()</code> of the
	underlying <code>ReentrantLock</code> object.

	Attempts to release the lock.

	If the current thread holds the lock, decrements the hold
	count. If the hold count reaches zero, the lock is released.

	If the current thread does not hold the lock, then
	<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalMonitorStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalMonitorStateException</code></a> is thrown.</div>
	</li>
	</ul>
	<a name="close--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>close</h4>
	<pre>public void close()</pre>
	<div class="block">Attempts to release the lock by making a call to <code>release()</code>.

	This is to implement <code>close()</code> method from <code>AutoCloseable</code>
	interface. This allows users to user a try-with-resource syntax, where
	the lock can be automatically released.</div>
	<dl>
	<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
	<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
	</dl>
	</li>
	</ul>
	<a name="tryLock--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>tryLock</h4>
	<pre>public boolean tryLock()</pre>
	<div class="block">A wrapper method that makes a call to <code>tryLock()</code> of
	the underlying <code>Lock</code> object.

	If the lock is not held by another thread, acquires the lock, set the
	hold count to one and returns <code>true</code>.

	If the current thread already holds the lock, the increment the hold
	count by one and returns <code>true</code>.

	If the lock is held by another thread then the method returns
	immediately with <code>false</code>.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd><code>true</code> if the lock was free and was acquired by the
	current thread, or the lock was already held by the current
	thread; and <code>false</code> otherwise.</dd>
	</dl>
	</li>
	</ul>
	<a name="newCondition--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>newCondition</h4>
	<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Condition.html?is-external=true" title="class or interface in java.util.concurrent.locks">Condition</a> newCondition()</pre>
	<div class="block">See <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/ReentrantLock.html?is-external=true#newCondition--" title="class or interface in java.util.concurrent.locks"><code>ReentrantLock.newCondition()</code></a>.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>the Condition object</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>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<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/AutoCloseableLock.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>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../../org/apache/hadoop/util/ApplicationClassLoader.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../org/apache/hadoop/util/BasicDiskValidator.html" title="class in org.apache.hadoop.util"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?org/apache/hadoop/util/AutoCloseableLock.html" target="_top">Frames</a></li>
	<li><a href="AutoCloseableLock.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>Copyright © 2008–2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
	</body>
	</html>