| <!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) on Sun Aug 28 20:42:18 EST 2016 --> | |
| <title>Referrer (Apache River v3.0.0 API Documentation (internals))</title> | |
| <meta name="date" content="2016-08-28"> | |
| <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="Referrer (Apache River v3.0.0 API Documentation (internals))"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; | |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Referrer.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/river/concurrent/ReferenceSortedSet.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/river/concurrent/ReferrerDecorator.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/river/concurrent/Referrer.html" target="_top">Frames</a></li> | |
| <li><a href="Referrer.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>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li>Constr | </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.river.concurrent</div> | |
| <h2 title="Interface Referrer" class="title">Interface Referrer<T></h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt><span class="paramLabel">Type Parameters:</span></dt> | |
| <dd><code>T</code> - Referent</dd> | |
| </dl> | |
| <dl> | |
| <dt>All Known Subinterfaces:</dt> | |
| <dd><a href="../../../../org/apache/river/concurrent/UntouchableReferrer.html" title="interface in org.apache.river.concurrent">UntouchableReferrer</a><T></dd> | |
| </dl> | |
| <dl> | |
| <dt>All Known Implementing Classes:</dt> | |
| <dd><a href="../../../../org/apache/river/concurrent/AbstractReferrerDecorator.html" title="class in org.apache.river.concurrent">AbstractReferrerDecorator</a>, <a href="../../../../org/apache/river/concurrent/ComparableReferrerDecorator.html" title="class in org.apache.river.concurrent">ComparableReferrerDecorator</a>, <a href="../../../../org/apache/river/concurrent/ReferenceSerializedForm.html" title="class in org.apache.river.concurrent">ReferenceSerializedForm</a>, <a href="../../../../org/apache/river/concurrent/ReferrerDecorator.html" title="class in org.apache.river.concurrent">ReferrerDecorator</a>, <a href="../../../../org/apache/river/concurrent/SoftEqualityReference.html" title="class in org.apache.river.concurrent">SoftEqualityReference</a>, <a href="../../../../org/apache/river/concurrent/SoftIdentityReference.html" title="class in org.apache.river.concurrent">SoftIdentityReference</a>, <a href="../../../../org/apache/river/concurrent/StrongReference.html" title="class in org.apache.river.concurrent">StrongReference</a>, <a href="../../../../org/apache/river/concurrent/TempComparableReferrer.html" title="class in org.apache.river.concurrent">TempComparableReferrer</a>, <a href="../../../../org/apache/river/concurrent/TempEqualReferrer.html" title="class in org.apache.river.concurrent">TempEqualReferrer</a>, <a href="../../../../org/apache/river/concurrent/TempIdentityReferrer.html" title="class in org.apache.river.concurrent">TempIdentityReferrer</a>, <a href="../../../../org/apache/river/concurrent/TimedComparableReferrerDecorator.html" title="class in org.apache.river.concurrent">TimedComparableReferrerDecorator</a>, <a href="../../../../org/apache/river/concurrent/TimedReferrer.html" title="class in org.apache.river.concurrent">TimedReferrer</a>, <a href="../../../../org/apache/river/concurrent/TimedReferrerDecorator.html" title="class in org.apache.river.concurrent">TimedReferrerDecorator</a>, <a href="../../../../org/apache/river/concurrent/WeakEqualityReference.html" title="class in org.apache.river.concurrent">WeakEqualityReference</a>, <a href="../../../../org/apache/river/concurrent/WeakIdentityReference.html" title="class in org.apache.river.concurrent">WeakIdentityReference</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public interface <span class="typeNameLabel">Referrer<T></span></pre> | |
| <div class="block"><p> | |
| The public API of package private Reference implementations, it defines the equals | |
| and hashCode contracts as well as methods identical to Reference. | |
| </p></div> | |
| <dl> | |
| <dt><span class="simpleTagLabel">Author:</span></dt> | |
| <dd>Peter Firmstone</dd> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/Reference.html?is-external=true" title="class or interface in java.lang.ref"><code>Reference</code></a>, | |
| <a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent"><code>Ref</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ========== 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></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>void</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/Referrer.html#clear--">clear</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/Referrer.html#enqueue--">enqueue</a></span>()</code> </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/Referrer.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> | |
| <div class="block"> | |
| Equals is calculated on IDENTITY or EQUALITY.</div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code><a href="../../../../org/apache/river/concurrent/Referrer.html" title="type parameter in Referrer">T</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/Referrer.html#get--">get</a></span>()</code> </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/river/concurrent/Referrer.html#hashCode--">hashCode</a></span>()</code> | |
| <div class="block"> | |
| Standard hashCode calculation for IDENTITY based references, where k | |
| is the referent.</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/Referrer.html#isEnqueued--">isEnqueued</a></span>()</code> </td> | |
| </tr> | |
| </table> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a name="get--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>get</h4> | |
| <pre><a href="../../../../org/apache/river/concurrent/Referrer.html" title="type parameter in Referrer">T</a> get()</pre> | |
| <dl> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/Reference.html?is-external=true#get--" title="class or interface in java.lang.ref"><code>Reference.get()</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="clear--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>clear</h4> | |
| <pre>void clear()</pre> | |
| <dl> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/Reference.html?is-external=true#clear--" title="class or interface in java.lang.ref"><code>Reference.clear()</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="isEnqueued--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>isEnqueued</h4> | |
| <pre>boolean isEnqueued()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true if enqueued.</dd> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/Reference.html?is-external=true#isEnqueued--" title="class or interface in java.lang.ref"><code>Reference.isEnqueued()</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="enqueue--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>enqueue</h4> | |
| <pre>boolean enqueue()</pre> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true if successfully enqueued.</dd> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/Reference.html?is-external=true#enqueue--" title="class or interface in java.lang.ref"><code>Reference.enqueue()</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="equals-java.lang.Object-"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>equals</h4> | |
| <pre>boolean equals(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> | |
| <div class="block"><p> | |
| Equals is calculated on IDENTITY or EQUALITY. | |
| </p> | |
| IDENTITY calculation:<BR> | |
| <BR><CODE> | |
| if (this == o) return true;<BR> | |
| if (!(o instanceof Referrer)) return false;<BR> | |
| Object k1 = get();<BR> | |
| Object k2 = ((Referrer) o).get();<BR> | |
| if ( k1 != null && k1 == k2 ) return true;<BR> | |
| return ( k1 == null && k2 == null && hashCode() == o.hashCode());<BR> | |
| </CODE> | |
| <BR> | |
| EQUALITY calculation:<BR> | |
| <BR><CODE> | |
| if (this == o) return true; // Same reference.<BR> | |
| if (!(o instanceof Referrer)) return false;<BR> | |
| Object k1 = get();<BR> | |
| Object k2 = ((Referrer) o).get();<BR> | |
| if ( k1 != null && k1.equals(k2)) return true;<BR> | |
| return ( k1 == null && k2 == null && hashCode() == o.hashCode());<BR> | |
| <BR></div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.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></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>o</code> - </dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>true if equal</dd> | |
| <dt><span class="seeLabel">See Also:</span></dt> | |
| <dd><a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent"><code>Ref</code></a></dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="hashCode--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>hashCode</h4> | |
| <pre>int hashCode()</pre> | |
| <div class="block"><p> | |
| Standard hashCode calculation for IDENTITY based references, where k | |
| is the referent. This may be stored in a final field: | |
| </p> | |
| <BR><CODE> | |
| int hash = 7;<BR> | |
| hash = 29 * hash + System.identityHashCode(k);<BR> | |
| hash = 29 * hash + k.getClass().hashCode();<BR> | |
| </CODE> | |
| <BR> | |
| <p> | |
| Standard hashCode calculation for EQUALITY based references, where k | |
| is the referent: | |
| </p> | |
| <BR><CODE> | |
| int hash = 7;<BR> | |
| hash = 29 * hash + k.hashCode();<BR> | |
| hash = 29 * hash + k.getClass().hashCode();<BR> | |
| </CODE> | |
| <BR> | |
| <p> | |
| The hash must be calculated during construction and if the reference is | |
| cleared, the recorded hashCode returned. While the referent remains | |
| reachable the hashCode must be calculated each time. | |
| </p></div> | |
| <dl> | |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> | |
| <dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>hash</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/Referrer.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/river/concurrent/ReferenceSortedSet.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/river/concurrent/ReferrerDecorator.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/river/concurrent/Referrer.html" target="_top">Frames</a></li> | |
| <li><a href="Referrer.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>Constr | </li> | |
| <li><a href="#method.summary">Method</a></li> | |
| </ul> | |
| <ul class="subNavList"> | |
| <li>Detail: </li> | |
| <li>Field | </li> | |
| <li>Constr | </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-2013, multiple authors.<br>Licensed under the <a href=http://www.apache.org/licenses/LICENSE-2.0 target=child >Apache License, Version 2.0</a>, see the <a href=../../../../doc-files/NOTICE target=child >NOTICE</a> file for attributions.</small></p> | |
| </body> | |
| </html> |