| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ObjectPool (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <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="ObjectPool (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":10,"i2":6,"i3":10,"i4":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ObjectPool.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/hbase/util/ObjectIntPair.html" title="class in org.apache.hadoop.hbase.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/util/ObjectPool.html" target="_top">Frames</a></li> |
| <li><a href="ObjectPool.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.hbase.util</div> |
| <h2 title="Class ObjectPool" class="title">Class ObjectPool<K,V></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.hbase.util.ObjectPool<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/util/SoftObjectPool.html" title="class in org.apache.hadoop.hbase.util">SoftObjectPool</a>, <a href="../../../../../org/apache/hadoop/hbase/util/WeakObjectPool.html" title="class in org.apache.hadoop.hbase.util">WeakObjectPool</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public abstract class <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.36">ObjectPool</a><K,V> |
| 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></pre> |
| <div class="block">A thread-safe shared object pool in which object creation is expected to be lightweight, and the |
| objects may be excessively created and discarded.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="type parameter in ObjectPool.ObjectFactory">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="type parameter in ObjectPool.ObjectFactory">V</a>></span></code> |
| <div class="block">An <code>ObjectFactory</code> object is used to create |
| new shared objects on demand.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#DEFAULT_CONCURRENCY_LEVEL">DEFAULT_CONCURRENCY_LEVEL</a></span></code> |
| <div class="block">The default concurrency level, |
| used when not otherwise specified in a constructor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#DEFAULT_INITIAL_CAPACITY">DEFAULT_INITIAL_CAPACITY</a></span></code> |
| <div class="block">The default initial capacity, |
| used when not otherwise specified in a constructor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#objectFactory">objectFactory</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private <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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#purgeLock">purgeLock</a></span></code> |
| <div class="block">For preventing parallel purge</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/Reference.html?is-external=true" title="class or interface in java.lang.ref">Reference</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#referenceCache">referenceCache</a></span></code> |
| <div class="block">Does not permit null keys.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/ReferenceQueue.html?is-external=true" title="class or interface in java.lang.ref">ReferenceQueue</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#staleRefQueue">staleRefQueue</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/hbase/util/ObjectPool.html#ObjectPool-org.apache.hadoop.hbase.util.ObjectPool.ObjectFactory-">ObjectPool</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> objectFactory)</code> |
| <div class="block">Creates a new pool with the default initial capacity (16) |
| and the default concurrency level (16).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#ObjectPool-org.apache.hadoop.hbase.util.ObjectPool.ObjectFactory-int-">ObjectPool</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> objectFactory, |
| int initialCapacity)</code> |
| <div class="block">Creates a new pool with the given initial capacity |
| and the default concurrency level (16).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#ObjectPool-org.apache.hadoop.hbase.util.ObjectPool.ObjectFactory-int-int-">ObjectPool</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> objectFactory, |
| int initialCapacity, |
| int concurrencyLevel)</code> |
| <div class="block">Creates a new pool with the given initial capacity |
| and the given concurrency level.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/Reference.html?is-external=true" title="class or interface in java.lang.ref">Reference</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#createReference-K-V-">createReference</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a> key, |
| <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a> obj)</code> |
| <div class="block">Create a reference associated with the given object</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#get-K-">get</a></span>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a> key)</code> |
| <div class="block">Returns a shared object associated with the given <code>key</code>, |
| which is identified by the <code>equals</code> method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#getReferenceKey-java.lang.ref.Reference-">getReferenceKey</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/Reference.html?is-external=true" title="class or interface in java.lang.ref">Reference</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> ref)</code> |
| <div class="block">Get key of the given reference</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/hbase/util/ObjectPool.html#purge--">purge</a></span>()</code> |
| <div class="block">Removes stale references of shared objects from the pool.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#size--">size</a></span>()</code> |
| <div class="block">Returns an estimated count of objects kept in the pool.</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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="staleRefQueue"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>staleRefQueue</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/ReferenceQueue.html?is-external=true" title="class or interface in java.lang.ref">ReferenceQueue</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.51">staleRefQueue</a></pre> |
| </li> |
| </ul> |
| <a name="objectFactory"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>objectFactory</h4> |
| <pre>private final <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.53">objectFactory</a></pre> |
| </li> |
| </ul> |
| <a name="referenceCache"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>referenceCache</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ConcurrentMap.html?is-external=true" title="class or interface in java.util.concurrent">ConcurrentMap</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/Reference.html?is-external=true" title="class or interface in java.lang.ref">Reference</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.56">referenceCache</a></pre> |
| <div class="block">Does not permit null keys.</div> |
| </li> |
| </ul> |
| <a name="purgeLock"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>purgeLock</h4> |
| <pre>private final <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> <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.59">purgeLock</a></pre> |
| <div class="block">For preventing parallel purge</div> |
| </li> |
| </ul> |
| <a name="DEFAULT_INITIAL_CAPACITY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_INITIAL_CAPACITY</h4> |
| <pre>public static final int <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.65">DEFAULT_INITIAL_CAPACITY</a></pre> |
| <div class="block">The default initial capacity, |
| used when not otherwise specified in a constructor.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ObjectPool.DEFAULT_INITIAL_CAPACITY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_CONCURRENCY_LEVEL"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_CONCURRENCY_LEVEL</h4> |
| <pre>public static final int <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.71">DEFAULT_CONCURRENCY_LEVEL</a></pre> |
| <div class="block">The default concurrency level, |
| used when not otherwise specified in a constructor.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.ObjectPool.DEFAULT_CONCURRENCY_LEVEL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ObjectPool-org.apache.hadoop.hbase.util.ObjectPool.ObjectFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ObjectPool</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.81">ObjectPool</a>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> objectFactory)</pre> |
| <div class="block">Creates a new pool with the default initial capacity (16) |
| and the default concurrency level (16).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objectFactory</code> - the factory to supply new objects on demand</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>objectFactory</code> is <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ObjectPool-org.apache.hadoop.hbase.util.ObjectPool.ObjectFactory-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ObjectPool</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.95">ObjectPool</a>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> objectFactory, |
| int initialCapacity)</pre> |
| <div class="block">Creates a new pool with the given initial capacity |
| and the default concurrency level (16).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objectFactory</code> - the factory to supply new objects on demand</dd> |
| <dd><code>initialCapacity</code> - the initial capacity to keep objects in the pool</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>objectFactory</code> is <code>null</code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>initialCapacity</code> is negative</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ObjectPool-org.apache.hadoop.hbase.util.ObjectPool.ObjectFactory-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ObjectPool</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.111">ObjectPool</a>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util">ObjectPool.ObjectFactory</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a>,<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> objectFactory, |
| int initialCapacity, |
| int concurrencyLevel)</pre> |
| <div class="block">Creates a new pool with the given initial capacity |
| and the given concurrency level.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>objectFactory</code> - the factory to supply new objects on demand</dd> |
| <dd><code>initialCapacity</code> - the initial capacity to keep objects in the pool</dd> |
| <dd><code>concurrencyLevel</code> - the estimated count of concurrently accessing threads</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>objectFactory</code> is <code>null</code></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>initialCapacity</code> is negative or |
| <code>concurrencyLevel</code> is non-positive</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="purge--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>purge</h4> |
| <pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.130">purge</a>()</pre> |
| <div class="block">Removes stale references of shared objects from the pool. References newly becoming stale may |
| still remain. |
| <p/> |
| The implementation of this method is expected to be lightweight when there is no stale |
| reference with the Oracle (Sun) implementation of <code>ReferenceQueue</code>, because |
| <code>ReferenceQueue.poll</code> just checks a volatile instance variable in <code>ReferenceQueue</code>.</div> |
| </li> |
| </ul> |
| <a name="createReference-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="createReference-K-V-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createReference</h4> |
| <pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/Reference.html?is-external=true" title="class or interface in java.lang.ref">Reference</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.153">createReference</a>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a> key, |
| <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a> obj)</pre> |
| <div class="block">Create a reference associated with the given object</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the key to store in the reference</dd> |
| <dd><code>obj</code> - the object to associate with</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the reference instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getReferenceKey-java.lang.ref.Reference-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReferenceKey</h4> |
| <pre>public abstract <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.160">getReferenceKey</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ref/Reference.html?is-external=true" title="class or interface in java.lang.ref">Reference</a><<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a>> ref)</pre> |
| <div class="block">Get key of the given reference</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ref</code> - The reference</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>key of the reference</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get-java.lang.Object-"> |
| <!-- --> |
| </a><a name="get-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">V</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.167">get</a>(<a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html" title="type parameter in ObjectPool">K</a> key)</pre> |
| <div class="block">Returns a shared object associated with the given <code>key</code>, |
| which is identified by the <code>equals</code> method.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>key</code> is <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="size--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/util/ObjectPool.html#line.198">size</a>()</pre> |
| <div class="block">Returns an estimated count of objects kept in the pool. |
| This also counts stale references, |
| and you might want to call <a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.html#purge--"><code>purge()</code></a> beforehand.</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> |
| <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/ObjectPool.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/hbase/util/ObjectIntPair.html" title="class in org.apache.hadoop.hbase.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/util/ObjectPool.ObjectFactory.html" title="interface in org.apache.hadoop.hbase.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/util/ObjectPool.html" target="_top">Frames</a></li> |
| <li><a href="ObjectPool.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
