blob: 21b686a7a7b6926c50da4850bfeb046f6c30404b [file] [log] [blame]
<!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:16 EST 2016 -->
<title>RC (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="RC (Apache River v3.0.0 API Documentation (internals))";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/RC.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/NullIterator.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/river/concurrent/ReadResolveFixCollectionCircularReferences.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/river/concurrent/RC.html" target="_top">Frames</a></li>
<li><a href="RC.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.river.concurrent</div>
<h2 title="Class RC" class="title">Class RC</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/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.river.concurrent.RC</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">RC</span>
extends <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></pre>
<div class="block"><p>
This class contains static methods for decorating collections
with reference capability. Classes implementing Interfaces from the Java Collections Framework
are supported. Freshly constructed empty collections are passed to these
static methods as parameters and returned decorated with the desired
reference capability. <a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent"><code>Referrer</code></a> is an interface equivalent to
<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>, as terms they are used interchangeably.
</p><p>
Referents in these collections may implement <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a> or
a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a> may be used for sorting. When Comparator's are utilised,
they must first be encapsulated <a href="../../../../org/apache/river/concurrent/RC.html#comparator-java.util.Comparator-"><code>comparator(java.util.Comparator)</code></a>,
before passing to a constructor for your preferred underlying Collection
implementation.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a> is not supported for IDENTITY == referenced Collections,
in this case a Comparator must be used.
</p><p>
All other references support <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a>, if the referent Object
doesn't implement <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a>, then <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"><code>Object.hashCode()</code></a> is used
for sorting. If two referent Objects have identical hashCodes,
but are unequal and do not implement <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang"><code>Comparable</code></a>, their references
will also have identical hashCodes, so only one of the referents can
be added to a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><code>SortedSet</code></a> or <a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><code>SortedMap</code></a>. This can be fixed by using a
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util"><code>Comparator</code></a>.
</p><p>
For all intents and purposes these utilities behave the same as your preferred
underlying <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> implementation, with the exception of
<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> reachability. An Object or Key,Value entry is removed
from a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> or <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>, upon becoming eligible for
garbage collection. The parameter gcCycle controls how often the underlying
collection is cleaned of enqueued references. TIME references are collected
after one gcCycle of no access, shorter cycle times will cause increased
collection and removal of TIME based references, but have no effect on
collection of soft or weak references, only the rate of removal of enqueued
references.
</p><p>
Note that TIME based references with rapid gcCycle's will not scale well.
Longer gcCycle's will scale.
</p><p>
Synchronisation must be implemented by the encapsulated <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>,
removal of enqued references is performed by background Executor threads.
Your chosen encapsulated <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> must also be mutable.
Objects will be removed automatically from encapsulated Collections when
they are eligible for garbage collection, external synchronisation of
decorated collections is not supported.
</p><p>
If you're using Iterators, you must synchronise on the underlying Collection
or Map, if iterating through keys or values, this doesn't apply to
concurrent collections that are guaranteed not to throw a
ConcurrentModificationException.
</p><p>
An Unmodifiable wrapper <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collections.html?is-external=true#unmodifiableCollection-java.util.Collection-" title="class or interface in java.util"><code>Collections.unmodifiableCollection(java.util.Collection)</code></a>
may be used externally to prevent additions to the underlying Collections,
referents will still be removed as they become unreachable however.
</p><p>
Note that any Sub List, Sub Set or Sub Map obtained by any of the Java
Collections Framework interfaces, must be views of the underlying
Collection, if the Collection uses defensive copies instead of views,
References could potentially remain in one copy after garbage collection,
causing null returns. If using standard Java Collections Framework
implementations, these problems don't occur as all Sub Lists,
Sub Sets or Sub Maps are views only.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true#entrySet--" title="class or interface in java.util"><code>Map.entrySet()</code></a> view instances returned preserve your chosen reference
behaviour, they even support <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true#add-E-" title="class or interface in java.util"><code>Set.add(java.lang.Object)</code></a> or
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true#addAll-java.util.Collection-" title="class or interface in java.util"><code>Set.addAll(java.util.Collection)</code></a> methods, although you'll be hard
pressed to find a standard java implementation that does. If you have a
Map with a Set of Entry's implementing add, the implementation will need a
Comparator, that compares Entry's only by their keys, to avoid duplicating
keys, primarily because an Entry hashCode includes the both key and value in its
calculation. <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true#hashCode--" title="class or interface in java.util"><code>Map.Entry.hashCode()</code></a>
</p><p>
All other <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true#entrySet--" title="class or interface in java.util"><code>Map.entrySet()</code></a> methods are fully implemented and supported.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util"><code>Map.Entry</code></a> view instances returned by these methods preserve reference
behaviour, all methods are fully implemented and supported.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><code>Set</code></a> and it's sub interfaces <a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><code>SortedSet</code></a> and
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util"><code>NavigableSet</code></a>, return views that preserve reference behaviour,
all methods are fully implemented and supported.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> and it's sub interfaces <a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><code>SortedMap</code></a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util"><code>NavigableMap</code></a>,
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentMap.html?is-external=true" title="class or interface in java.util"><code>ConcurrentMap</code></a> and <a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentNavigableMap.html?is-external=true" title="class or interface in java.util"><code>ConcurrentNavigableMap</code></a> return
views that preserve reference behaviour, all methods are fully implemented
and supported.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> returns views that preserve reference behaviour, all methods are
fully implemented and supported.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util"><code>Queue</code></a> and it's sub interfaces <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Deque.html?is-external=true" title="class or interface in java.util"><code>Deque</code></a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingQueue.html?is-external=true" title="class or interface in java.util"><code>BlockingQueue</code></a> and
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingDeque.html?is-external=true" title="class or interface in java.util"><code>BlockingDeque</code></a> return views that preserve reference behaviour,
all methods are fully implemented and supported.
</p><p>
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> and <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ListIterator.html?is-external=true" title="class or interface in java.util"><code>ListIterator</code></a> views preserve reference behaviour, all methods
are fully implemented and supported.
</p><p>
Serialisation is supported, provided it is also supported by underlying
collections. Collections are not defensively copied during de-serialisation,
due in part to an inability of determining whether a Comparator is
used and in part, that if it is, it prevents Class.newInstance() construction.
</p><p>
Note that when a collection is first de-serialised, it's contents are
strongly referenced, then changed to the correct reference type. This
will still occur, even if the Collection is immutable.
</p><p>
Map's don't currently support Serialization.
</p><p>
RC stands for Referrer Collection and is abbreviated due to the length of
generic parameter arguments typically required.
</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="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent"><code>Ref</code></a>,
<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent"><code>Referrer</code></a>,
<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></dd>
</dl>
</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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#RC--">RC</a></span>()</code>&nbsp;</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingDeque.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingDeque</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#blockingDeque-java.util.concurrent.BlockingDeque-org.apache.river.concurrent.Ref-long-">blockingDeque</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingDeque.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingDeque</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a BlockingDeque for holding references so it appears as a BlockingDeque
containing referents.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingQueue.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingQueue</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#blockingQueue-java.util.concurrent.BlockingQueue-org.apache.river.concurrent.Ref-long-">blockingQueue</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingQueue.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingQueue</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a BlockingQueue for holding references so it appears as a BlockingQueue
containing referents.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#collection-java.util.Collection-org.apache.river.concurrent.Ref-long-">collection</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a Collection for holding references so it appears as a Collection
containing referents.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#comparator-java.util.Comparator-">comparator</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;? super T&gt;&nbsp;comparator)</code>
<div class="block">When using a Comparator in SortedSet's and SortedMap's, the Comparator
must be encapsulated using this method, to order the Set or Map
by referents and not References.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static &lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentMap</a>&lt;K,V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#concurrentMap-java.util.concurrent.ConcurrentMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">concurrentMap</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</code>
<div class="block">Decorate a ConcurrentMap for holding references so it appears as a ConcurrentMap
containing referents.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static &lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentNavigableMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentNavigableMap</a>&lt;K,V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#concurrentNavigableMap-java.util.concurrent.ConcurrentNavigableMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">concurrentNavigableMap</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentNavigableMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentNavigableMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</code>
<div class="block">Decorate a ConcurrentNavigableMap for holding references so it appears as a
ConcurrentNavigableMap containing referents.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Deque.html?is-external=true" title="class or interface in java.util">Deque</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#deque-java.util.Deque-org.apache.river.concurrent.Ref-long-">deque</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Deque.html?is-external=true" title="class or interface in java.util">Deque</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a Deque for holding references so it appears as a Deque
containing referents.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#list-java.util.List-org.apache.river.concurrent.Ref-long-">list</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a List for holding references so it appears as a List
containing referents.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static &lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;K,V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#map-java.util.Map-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">map</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</code>
<div class="block">Decorate a Map for holding references so it appears as a Map
containing referents.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static &lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;K,V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#navigableMap-java.util.NavigableMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">navigableMap</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</code>
<div class="block">Decorate a NavigableMap for holding Referrers so it appears as a NavigableMap
containing referents.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#navigableSet-java.util.NavigableSet-org.apache.river.concurrent.Ref-long-">navigableSet</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a NavigableSet for holding references so it appears as a NavigableSet
containing referents.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#queue-java.util.Queue-org.apache.river.concurrent.Ref-long-">queue</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a Queue for holding references so it appears as a Queue
containing referents.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#set-java.util.Set-org.apache.river.concurrent.Ref-long-">set</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a Set for holding references so it appears as a Set
containing referents.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static &lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;K,V&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#sortedMap-java.util.SortedMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">sortedMap</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</code>
<div class="block">Decorate a SortedMap for holding references so it appears as a SortedMap
containing referents.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a>&lt;T&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/river/concurrent/RC.html#sortedSet-java.util.SortedSet-org.apache.river.concurrent.Ref-long-">sortedSet</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</code>
<div class="block">Decorate a SortedSet for holding references so it appears as a SortedSet
containing referents.</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="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://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>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></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="RC--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RC</h4>
<pre>private&nbsp;RC()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="comparator-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comparator</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;comparator(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a>&lt;? super T&gt;&nbsp;comparator)</pre>
<div class="block">When using a Comparator in SortedSet's and SortedMap's, the Comparator
must be encapsulated using this method, to order the Set or Map
by referents and not References.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>comparator</code> - for referents.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated Comparator for Referrers</dd>
</dl>
</li>
</ul>
<a name="collection-java.util.Collection-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collection</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;T&gt;&nbsp;collection(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a Collection for holding references so it appears as a Collection
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - Collection for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated Collection.</dd>
</dl>
</li>
</ul>
<a name="list-java.util.List-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>list</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;list(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a List for holding references so it appears as a List
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - List for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated List.</dd>
</dl>
</li>
</ul>
<a name="set-java.util.Set-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;T&gt;&nbsp;set(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a Set for holding references so it appears as a Set
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - Set for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated Set.</dd>
</dl>
</li>
</ul>
<a name="sortedSet-java.util.SortedSet-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortedSet</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a>&lt;T&gt;&nbsp;sortedSet(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util">SortedSet</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a SortedSet for holding references so it appears as a SortedSet
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - SortedSet for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated SortedSet</dd>
</dl>
</li>
</ul>
<a name="navigableSet-java.util.NavigableSet-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>navigableSet</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;T&gt;&nbsp;navigableSet(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableSet.html?is-external=true" title="class or interface in java.util">NavigableSet</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a NavigableSet for holding references so it appears as a NavigableSet
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - NavigableSet for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>NavigableSet<Referrer<T>> decorated as NavigableSet<T></dd>
</dl>
</li>
</ul>
<a name="queue-java.util.Queue-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queue</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;T&gt;&nbsp;queue(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a Queue for holding references so it appears as a Queue
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - Queue for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated Queue.</dd>
</dl>
</li>
</ul>
<a name="deque-java.util.Deque-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deque</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Deque.html?is-external=true" title="class or interface in java.util">Deque</a>&lt;T&gt;&nbsp;deque(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Deque.html?is-external=true" title="class or interface in java.util">Deque</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a Deque for holding references so it appears as a Deque
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - Deque for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Deque<Referrer<T>> decorated as Deque<T></dd>
</dl>
</li>
</ul>
<a name="blockingQueue-java.util.concurrent.BlockingQueue-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blockingQueue</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingQueue.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingQueue</a>&lt;T&gt;&nbsp;blockingQueue(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingQueue.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingQueue</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a BlockingQueue for holding references so it appears as a BlockingQueue
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - BlockingQueue for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated BlockingQueue</dd>
</dl>
</li>
</ul>
<a name="blockingDeque-java.util.concurrent.BlockingDeque-org.apache.river.concurrent.Ref-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blockingDeque</h4>
<pre>public static&nbsp;&lt;T&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingDeque.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingDeque</a>&lt;T&gt;&nbsp;blockingDeque(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.BlockingDeque.html?is-external=true" title="class or interface in java.util">java.util.concurrent.BlockingDeque</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;T&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;type,
long&nbsp;gcCycle)</pre>
<div class="block">Decorate a BlockingDeque for holding references so it appears as a BlockingDeque
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - referent type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - BlockingDeque for holding Referrer objects.</dd>
<dd><code>type</code> - Referrer implementation required.</dd>
<dd><code>gcCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated BlockingDeque</dd>
</dl>
</li>
</ul>
<a name="map-java.util.Map-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>map</h4>
<pre>public static&nbsp;&lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;K,V&gt;&nbsp;map(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</pre>
<div class="block">Decorate a Map for holding references so it appears as a Map
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - key referent type</dd>
<dd><code>V</code> - value referent type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - Map for holding Referrer objects</dd>
<dd><code>key</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>value</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>gcKeyCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dd><code>gcValCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated Map</dd>
</dl>
</li>
</ul>
<a name="sortedMap-java.util.SortedMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortedMap</h4>
<pre>public static&nbsp;&lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;K,V&gt;&nbsp;sortedMap(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util">SortedMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</pre>
<div class="block">Decorate a SortedMap for holding references so it appears as a SortedMap
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - key referent type</dd>
<dd><code>V</code> - value referent type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - SortedMap for holding Referrer objects</dd>
<dd><code>key</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>value</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>gcKeyCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dd><code>gcValCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated SortedMap</dd>
</dl>
</li>
</ul>
<a name="navigableMap-java.util.NavigableMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>navigableMap</h4>
<pre>public static&nbsp;&lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;K,V&gt;&nbsp;navigableMap(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/NavigableMap.html?is-external=true" title="class or interface in java.util">NavigableMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</pre>
<div class="block">Decorate a NavigableMap for holding Referrers so it appears as a NavigableMap
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - key referent type</dd>
<dd><code>V</code> - value referent type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - NavigableMap for holding Referrer objects</dd>
<dd><code>key</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>value</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>gcKeyCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dd><code>gcValCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated NavigableMap</dd>
</dl>
</li>
</ul>
<a name="concurrentMap-java.util.concurrent.ConcurrentMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>concurrentMap</h4>
<pre>public static&nbsp;&lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentMap</a>&lt;K,V&gt;&nbsp;concurrentMap(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</pre>
<div class="block">Decorate a ConcurrentMap for holding references so it appears as a ConcurrentMap
containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - - key type.</dd>
<dd><code>V</code> - - value type.</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - - for holding references.</dd>
<dd><code>key</code> - - key reference type.</dd>
<dd><code>value</code> - - value reference type.</dd>
<dd><code>gcKeyCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dd><code>gcValCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated ConcurrentMap</dd>
</dl>
</li>
</ul>
<a name="concurrentNavigableMap-java.util.concurrent.ConcurrentNavigableMap-org.apache.river.concurrent.Ref-org.apache.river.concurrent.Ref-long-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>concurrentNavigableMap</h4>
<pre>public static&nbsp;&lt;K,V&gt;&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentNavigableMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentNavigableMap</a>&lt;K,V&gt;&nbsp;concurrentNavigableMap(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent.ConcurrentNavigableMap.html?is-external=true" title="class or interface in java.util">java.util.concurrent.ConcurrentNavigableMap</a>&lt;<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;K&gt;,<a href="../../../../org/apache/river/concurrent/Referrer.html" title="interface in org.apache.river.concurrent">Referrer</a>&lt;V&gt;&gt;&nbsp;internal,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;key,
<a href="../../../../org/apache/river/concurrent/Ref.html" title="enum in org.apache.river.concurrent">Ref</a>&nbsp;value,
long&nbsp;gcKeyCycle,
long&nbsp;gcValCycle)</pre>
<div class="block">Decorate a ConcurrentNavigableMap for holding references so it appears as a
ConcurrentNavigableMap containing referents.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - key referent type</dd>
<dd><code>V</code> - value referent type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>internal</code> - NavigableMap for holding Referrer objects</dd>
<dd><code>key</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>value</code> - Referrer implementation required, as defined by Ref</dd>
<dd><code>gcKeyCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dd><code>gcValCycle</code> - scheduled cleaning task interval in milliseconds.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Decorated ConcurrentNavigableMap</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/RC.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/NullIterator.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/river/concurrent/ReadResolveFixCollectionCircularReferences.html" title="class in org.apache.river.concurrent"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/river/concurrent/RC.html" target="_top">Frames</a></li>
<li><a href="RC.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 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>