blob: dca35e5702127b0c314a9c69f4c25c7f549c82e2 [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:13 EST 2016 -->
<title>JavaSpace05 (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="JavaSpace05 (Apache River v3.0.0 API Documentation (internals))";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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/JavaSpace05.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="../../../net/jini/space/JavaSpace.html" title="interface in net.jini.space"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/space/JavaSpace05.html" target="_top">Frames</a></li>
<li><a href="JavaSpace05.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>Constr&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>Constr&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">net.jini.space</div>
<h2 title="Interface JavaSpace05" class="title">Interface JavaSpace05</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../net/jini/space/JavaSpace.html" title="interface in net.jini.space">JavaSpace</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/river/outrigger/ConstrainableSpaceProxy2.html" title="class in org.apache.river.outrigger">ConstrainableSpaceProxy2</a>, <a href="../../../org/apache/river/outrigger/SpaceProxy2.html" title="class in org.apache.river.outrigger">SpaceProxy2</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">JavaSpace05</span>
extends <a href="../../../net/jini/space/JavaSpace.html" title="interface in net.jini.space">JavaSpace</a></pre>
<div class="block">The <code>JavaSpace05</code> interface extends the <a href="../../../net/jini/space/JavaSpace.html" title="interface in net.jini.space"><code>JavaSpace</code></a> interface to provide methods that allow clients to
perform batch operations on the space (which are generally more
efficient than performing an equivalent set of singleton
operations) and to more easily develop applications where a
given <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a> needs to be read by multiple clients.
Implementations of the <code>JavaSpace</code> interface are not
required to implement this interface.<p>
Unless otherwise noted, the effects of any invocation of a
method defined by this interface must be visible to any
operation on the space that is started after the invocation
returns normally. Note, the effects of a method invocation that
throws a <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi"><code>RemoteException</code></a> are not necessarily visible
when the exception is thrown. <p>
All of the methods of this interface take one or more <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>s as arguments. Each such <code>Collection</code>
must be treated as immutable by implementations and must not be
changed by the client during the course of any method
invocation to which they have been passed.<p>
This interface is not a remote interface. Each implementation of
this interface exports a proxy object that implements this
interface local to the client. Each method of the interface
takes as one of its arguments a <code>Collection</code> of
<code>Entry</code> instances. The entries themselves must be
serialized in accordance with the <a
href=http://www.jini.org/standards/index.html>Jini Entry
Specification</a> and will not be altered by the
call. Typically, the <code>Collection</code> holding the entries
will not be serialized at all. If one of these entries can't be
serialized, a <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/MarshalException.html?is-external=true" title="class or interface in java.rmi"><code>MarshalException</code></a> will be thrown. Aside
from the handling of these <code>Collection</code> of
<code>Entry</code> parameters, all methods defined by this
interface otherwise obey normal Java(TM) Remote Method
Invocation remote interface semantics.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href=http://www.jini.org/standards/index.html>
JavaSpaces Service Specification</a>,
<a href=http://www.jini.org/standards/index.html>
Jini Entry Specification</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.net.jini.space.JavaSpace">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;net.jini.space.<a href="../../../net/jini/space/JavaSpace.html" title="interface in net.jini.space">JavaSpace</a></h3>
<code><a href="../../../net/jini/space/JavaSpace.html#NO_WAIT">NO_WAIT</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space">MatchSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/space/JavaSpace05.html#contents-java.util.Collection-net.jini.core.transaction.Transaction-long-long-">contents</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>&nbsp;tmpls,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
long&nbsp;leaseDuration,
long&nbsp;maxEntries)</code>
<div class="block">Creates a <a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space">match set</a> that can be used to
exhaustively read through all of the matching entries in
the space that are visible to the passed <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a> and remain visible for the lifetime of the
match set.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../net/jini/core/event/EventRegistration.html" title="class in net.jini.core.event">EventRegistration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/space/JavaSpace05.html#registerForAvailabilityEvent-java.util.Collection-net.jini.core.transaction.Transaction-boolean-net.jini.core.event.RemoteEventListener-long-java.rmi.MarshalledObject-">registerForAvailabilityEvent</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>&nbsp;tmpls,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
boolean&nbsp;visibilityOnly,
<a href="../../../net/jini/core/event/RemoteEventListener.html" title="interface in net.jini.core.event">RemoteEventListener</a>&nbsp;listener,
long&nbsp;leaseDuration,
<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/MarshalledObject.html?is-external=true" title="class or interface in java.rmi">MarshalledObject</a>&nbsp;handback)</code>
<div class="block">Register for events triggered when a matching <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a>
transitions from unavailable to available.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/space/JavaSpace05.html#take-java.util.Collection-net.jini.core.transaction.Transaction-long-long-">take</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>&nbsp;tmpls,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
long&nbsp;timeout,
long&nbsp;maxEntries)</code>
<div class="block">This method provides an overload of the <a href="../../../net/jini/space/JavaSpace.html#take-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-"><code>JavaSpace.take</code></a> method that attempts to
remove, optionally under a <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a>, and return
one or more entries from the space.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/space/JavaSpace05.html#write-java.util.List-net.jini.core.transaction.Transaction-java.util.List-">write</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>&nbsp;entries,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
<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>&nbsp;leaseDurations)</code>
<div class="block">This method provides an overload of the <a href="../../../net/jini/space/JavaSpace.html#write-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-"><code>JavaSpace.write</code></a> method that allows new
copies of multiple <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a> instances to be stored in
the space using a single call.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.net.jini.space.JavaSpace">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;net.jini.space.<a href="../../../net/jini/space/JavaSpace.html" title="interface in net.jini.space">JavaSpace</a></h3>
<code><a href="../../../net/jini/space/JavaSpace.html#notify-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-net.jini.core.event.RemoteEventListener-long-java.rmi.MarshalledObject-">notify</a>, <a href="../../../net/jini/space/JavaSpace.html#read-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-">read</a>, <a href="../../../net/jini/space/JavaSpace.html#readIfExists-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-">readIfExists</a>, <a href="../../../net/jini/space/JavaSpace.html#snapshot-net.jini.core.entry.Entry-">snapshot</a>, <a href="../../../net/jini/space/JavaSpace.html#take-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-">take</a>, <a href="../../../net/jini/space/JavaSpace.html#takeIfExists-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-">takeIfExists</a>, <a href="../../../net/jini/space/JavaSpace.html#write-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-">write</a></code></li>
</ul>
</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="write-java.util.List-net.jini.core.transaction.Transaction-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>write</h4>
<pre><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>&nbsp;write(<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>&nbsp;entries,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
<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>&nbsp;leaseDurations)
throws <a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a>,
<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">This method provides an overload of the <a href="../../../net/jini/space/JavaSpace.html#write-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-"><code>JavaSpace.write</code></a> method that allows new
copies of multiple <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a> instances to be stored in
the space using a single call. The client may specify a
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a> for the operation to be performed
under. Each <code>Entry</code> to be stored in the space
has a separate requested initial lease duration. <p>
The effect on the space of an invocation of this method
successfully storing an <code>Entry</code> is the same as if
the <code>Entry</code> had been successfully stored by a
call to the singleton form of <code>write</code> under
<code>txn</code> with the given requested initial lease
duration. This method returns the proxies to the leases for
each newly stored <code>Entry</code> by returning a <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> of <a href="../../../net/jini/core/lease/Lease.html" title="interface in net.jini.core.lease"><code>Lease</code></a> instances. The <em>i</em> th element
of the returned <code>List</code> will be a proxy for the
lease on the <code>Entry</code> created from the <em>i</em>
th element of <code>entries</code>. <p>
If an invocation of this method returns normally, then a new
copy of each element of <code>entries</code> must have been
stored in the space. A new copy of each element will be
stored even if there are duplicates (either in terms of
object identity or of entry equivalence) in
<code>entries</code>. <p>
The order in which the entries stored by an invocation of
this method will become visible in the space is unspecified,
and different observers may see the entries become visible
in different orders.<p>
If a <a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction"><code>TransactionException</code></a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang"><code>SecurityException</code></a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a>, or
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a> is thrown, no entries will
have been added to the space by this operation. If a <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi"><code>RemoteException</code></a> is thrown, either new copies of all of the
elements of <code>entries</code> will have been stored or
no entries will have been stored; that is, in the case of a
<code>RemoteException</code>, the storing of new entries in
the space will either fail or succeed as a unit. <p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entries</code> - a <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> of <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a> instances to
be written to the space</dd>
<dd><code>txn</code> - the <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a> this operation should be
performed under, may be <code>null</code></dd>
<dd><code>leaseDurations</code> - a <code>List</code> of
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang"><code>Long</code></a>s representing the
requested initial lease durations</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>List</code> of <a href="../../../net/jini/core/lease/Lease.html" title="interface in net.jini.core.lease"><code>Lease</code></a> instances, one
for each element of <code>entries</code>, may be
immutable. The space will not keep a reference to
the result</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a></code> - if <code>txn</code> is
non-<code>null</code> and is not usable by the
space</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - if a communication error occurs</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>entries</code> and
<code>leaseDurations</code> are not the same length
or are empty, if any element of <code>entries</code>
is not an instance of <code>Entry</code>, if any
element of <code>leaseDurations</code> is not an
instance of <code>Long</code>, or if any element of
<code>leaseDurations</code> is a negative value
other than <a href="../../../net/jini/core/lease/Lease.html#ANY"><code>Lease.ANY</code></a></dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either <code>entries</code>
or <code>leaseDurations</code> is <code>null</code>
or contains a <code>null</code> value</dd>
</dl>
</li>
</ul>
<a name="take-java.util.Collection-net.jini.core.transaction.Transaction-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>take</h4>
<pre><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>&nbsp;take(<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>&nbsp;tmpls,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
long&nbsp;timeout,
long&nbsp;maxEntries)
throws <a href="../../../net/jini/entry/UnusableEntriesException.html" title="class in net.jini.entry">UnusableEntriesException</a>,
<a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a>,
<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">This method provides an overload of the <a href="../../../net/jini/space/JavaSpace.html#take-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-"><code>JavaSpace.take</code></a> method that attempts to
remove, optionally under a <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a>, and return
one or more entries from the space. Each <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a>
taken will match one or more elements of the passed <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> of templates, and all of the taken entries will
be visible to the passed <code>Transaction</code>. If there
are initially no matches in the space that are visible to
the passed <code>Transaction</code>, an invocation of this
method will block for up to a specified timeout for one or
more matches to appear. <p>
The effect on the space of an invocation of this method
successfully taking an <code>Entry</code> will be the same
as if the <code>Entry</code> had been taken using the
singleton version of this method and passing
<code>txn</code> as the <code>Transaction</code>. <p>
The <code>tmpls</code> parameter must be a
<code>Collection</code> of <code>Entry</code> instances to
be used as templates. All of the entries taken must match
one or more of these templates. The <code>tmpls</code>
parameter may contain <code>null</code> values and may
contain duplicates. An <code>Entry</code> is said to be
<em>available</em> to an invocation of this method if the
<code>Entry</code> could have been returned by an
invocation of the singleton <code>take</code> method using
<code>txn</code>. <p>
If the method succeeds, a non-<code>null</code>
<code>Collection</code> will be returned. The
<code>Collection</code> will contain a copy of each
<code>Entry</code> that was taken. If no entries were taken,
the <code>Collection</code> will be empty. Each
<code>Entry</code> taken will be represented by a distinct
<code>Entry</code> instance in the returned
<code>Collection</code>, even if some of the entries are
equivalent to others taken by the operation. There will be
no <code>null</code> elements in the returned
<code>Collection</code>.<p>
If one or more of the entries taken cannot be unmarshalled
in the client, an <a href="../../../net/jini/entry/UnusableEntriesException.html" title="class in net.jini.entry"><code>UnusableEntriesException</code></a> is
thrown. The exception's <a href="../../../net/jini/entry/UnusableEntriesException.html#getEntries--"><code>UnusableEntriesException.getEntries</code></a> method will return a
<code>Collection</code> with a copy of each
<code>Entry</code> that could be unmarshalled. The <a href="../../../net/jini/entry/UnusableEntriesException.html#getUnusableEntryExceptions--"><code>UnusableEntriesException.getUnusableEntryExceptions</code></a> method
will return a <code>Collection</code> with an <a href="../../../net/jini/core/entry/UnusableEntryException.html" title="class in net.jini.core.entry"><code>UnusableEntryException</code></a> for each <code>Entry</code> that
could not be unmarshalled. Every <code>Entry</code> taken
by the invocation will either be represented in the
<code>Collection</code> returned by <code>getEntries</code>
or in the <code>Collection</code> returned by
<code>getUnusableEntryExceptions</code>. <p>
If there is at least one matching <code>Entry</code>
available in the space, an invocation of this method must
take at least one <code>Entry</code>. If more than one
matching <code>Entry</code> is available, the invocation may
take additional entries. It must not take more than
<code>maxEntries</code>, but an implementation may chose to
take fewer entries from the space than the maximum available or
the maximum allowed by <code>maxEntries</code>. If for
whatever reason, an invocation of this method takes fewer
entries than the maximum number of available matching
entries, how an implementation selects which entries should be
taken by the invocation and which are left in the space is
unspecified. How consumption of entries is arbitrated
between conflicting queries is also unspecified. <p>
If there are initially no matching entries in the space, an
invocation of this method should block for up to
<code>timeout</code> milliseconds for a match to appear. If
one or more matches become available before
<code>timeout</code> expires, one or more of the newly
available entries should be taken and the method should
return without further blocking. If for some reason the
invocation can't block for the full timeout and no entries
have been taken, the invocation must fail with a <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi"><code>RemoteException</code></a> or <a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction"><code>TransactionException</code></a> as
appropriate. <p>
If an invocation of this method removes (or locks) more than
one <code>Entry</code>, the order in which the removal (or
locking) occurs is undefined, and different observers may see
the removal or locking of the entries in different
orders. <p>
If a <code>TransactionException</code>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang"><code>SecurityException</code></a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a>, or
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a> is thrown, no entries will
have been taken. If a <code>RemoteException</code> is
thrown, up to <code>maxEntries</code> may have been taken
by this operation. <p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tmpls</code> - 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> of <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a>
instances, each representing a template. All
of the entries taken by an invocation of this
method will match one or more elements of
<code>tmpls</code></dd>
<dd><code>txn</code> - the <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a> this operation should be
performed under, may be <code>null</code></dd>
<dd><code>timeout</code> - if there are initially no available
matches in the space, the maximum number of
milliseconds to block waiting for a match to
become available</dd>
<dd><code>maxEntries</code> - the maximum number of entries that may be
taken by this method</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>Collection</code> that contains a copy of each
<code>Entry</code> taken from the space by this
method. The space will not keep a reference to
this <code>Collection</code>. May be immutable</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../net/jini/entry/UnusableEntriesException.html" title="class in net.jini.entry">UnusableEntriesException</a></code> - if one or more of the
entries taken can't be unmarshalled in the client</dd>
<dd><code><a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a></code> - if <code>txn</code> is
non-<code>null</code> and is not usable by the
space.</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - if a communication error occurs</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if any non-<code>null</code>
element of <code>tmpls</code> is not an instance of
<code>Entry</code>, if <code>tmpls</code> is empty,
if <code>timeout</code> is negative, or if
<code>maxEntries</code> is non-positive</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>tmpls</code> is null</dd>
</dl>
</li>
</ul>
<a name="contents-java.util.Collection-net.jini.core.transaction.Transaction-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contents</h4>
<pre><a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space">MatchSet</a>&nbsp;contents(<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>&nbsp;tmpls,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
long&nbsp;leaseDuration,
long&nbsp;maxEntries)
throws <a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a>,
<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">Creates a <a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space">match set</a> that can be used to
exhaustively read through all of the matching entries in
the space that are visible to the passed <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a> and remain visible for the lifetime of the
match set. May also yield additional entries that match but
are only visible for part of the lifetime of the match
set. <p>
The <code>tmpls</code> parameter must be 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> of <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a> instances to be used as
templates. All of the entries placed in the match set will
match one or more of these templates. <code>tmpls</code> may
contain <code>null</code> values and may contain
duplicates. An <code>Entry</code> is said to be
<em>visible</em> to an invocation of this method if the
<code>Entry</code> could have been returned by a singleton
<a href="../../../net/jini/space/JavaSpace.html#read-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-"><code>JavaSpace.read</code></a> using the same
transaction. <p>
The resulting match set must initially contain all of the
visible matching entries in the space. During the lifetime
of the match set an <code>Entry</code> may be, but is not
required to be, added to the match set if it becomes
visible. If the match set becomes empty, no more entries can
be added and the match set enters the <a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space">exhausted</a> state.<p>
Normally there are three conditions under which an
<code>Entry</code> might be removed from the match set:
<ul>
<li> Any <code>Entry</code> yielded by an invocation of the
<a href="../../../net/jini/space/MatchSet.html#next--"><code>MatchSet.next</code></a> method on the match
set (either as the return value of a successful call or
embedded in an <a href="../../../net/jini/core/entry/UnusableEntryException.html" title="class in net.jini.core.entry"><code>UnusableEntryException</code></a>) must be
removed from the match set.
<li> Any <code>Entry</code> that remains in the match set
after <code>maxEntries</code> entries are yielded by
<code>next</code> invocations must be removed from the
match set. In such a case, the criteria used to select which
entries are yielded by <code>next</code> calls and which
get removed from the set at the end is unspecified.
<li> Any <code>Entry</code> that during the lifetime of the
match set becomes invisible may at the discretion of the
implementation be removed from the match set.
</ul>
<p>
An implementation may decide to remove an <code>Entry</code>
from the set for other reasons. If it does so, however, it
must <a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space">invalidate</a> the set.<p>
If <code>txn</code> is non-<code>null</code> and still
active, any <code>Entry</code> removed from the match set by
a <code>next</code> call must be locked as if it had been
returned by a read operation using <code>txn</code>. An
implementation may establish the read lock on the
<code>Entry</code> any time between when the
<code>Entry</code> is added to the match set and when the
<code>Entry</code> is removed from the match set by an
invocation of <code>next</code>. These read locks are not
released when the match set reaches either the exhausted
state or the invalidated state. If from the space's
perspective the <code>txn</code> leaves the active state,
the space must remove from the match set any entries in the
match set that have not yet been read locked. This may
require the match set to be invalidated. <p>
If the match set is leased and <code>leaseDuration</code>
is positive, the initial duration of the lease must be less
than or equal to <code>leaseDuration</code>. If
<code>leaseDuration</code> is <a href="../../../net/jini/core/lease/Lease.html#ANY"><code>Lease.ANY</code></a>,
the initial duration of the lease can be any positive value
desired by the implementation. <p>
If there are <a href="../../../net/jini/core/constraint/package-summary.html">remote
method constraints</a> associated with an invocation of this
method, any remote communications performed by or on behalf
of the match set's <code>next</code> method will be
performed in compliance with these constraints, not with the
constraints (if any) associated with <code>next</code>. <p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tmpls</code> - 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> of <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a>
instances, each representing a template. All
the entries added to the resulting match set will
match one or more elements of <code>tmpls</code></dd>
<dd><code>txn</code> - the <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a> this operation should be
performed under, may be <code>null</code></dd>
<dd><code>leaseDuration</code> - the requested initial lease time on
the resulting match set</dd>
<dd><code>maxEntries</code> - the maximum number of entries to remove
from the set via <a href="../../../net/jini/space/MatchSet.html#next--"><code>MatchSet.next</code></a>
calls</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A proxy to the newly created <a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space">match set</a></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a></code> - if <code>txn</code> is
non-<code>null</code> and is not usable by the
space</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - if a communication error occurs</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if any non-<code>null</code>
element of <code>tmpls</code> is not an instance of
<code>Entry</code>, if <code>tmpls</code> is empty,
if <code>leaseDuration</code> is neither positive
nor <a href="../../../net/jini/core/lease/Lease.html#ANY"><code>Lease.ANY</code></a>, or if
<code>maxEntries</code> is non-positive</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>tmpls</code> is
<code>null</code></dd>
</dl>
</li>
</ul>
<a name="registerForAvailabilityEvent-java.util.Collection-net.jini.core.transaction.Transaction-boolean-net.jini.core.event.RemoteEventListener-long-java.rmi.MarshalledObject-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>registerForAvailabilityEvent</h4>
<pre><a href="../../../net/jini/core/event/EventRegistration.html" title="class in net.jini.core.event">EventRegistration</a>&nbsp;registerForAvailabilityEvent(<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>&nbsp;tmpls,
<a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction">Transaction</a>&nbsp;txn,
boolean&nbsp;visibilityOnly,
<a href="../../../net/jini/core/event/RemoteEventListener.html" title="interface in net.jini.core.event">RemoteEventListener</a>&nbsp;listener,
long&nbsp;leaseDuration,
<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/MarshalledObject.html?is-external=true" title="class or interface in java.rmi">MarshalledObject</a>&nbsp;handback)
throws <a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a>,
<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">Register for events triggered when a matching <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a>
transitions from unavailable to available. The resulting
events will be instances of the <a href="../../../net/jini/space/AvailabilityEvent.html" title="class in net.jini.space"><code>AvailabilityEvent</code></a>
class and the <a href="../../../net/jini/space/AvailabilityEvent.html#getEntry--"><code>AvailabilityEvent.getEntry</code></a> method will return a copy of
the <code>Entry</code> whose transition triggered the
event.<p>
An <code>Entry</code> makes a transition from
<em>unavailable to available</em> when it goes from being in
a state where it could not be returned by a <a href="../../../net/jini/space/JavaSpace.html#take-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-"><code>JavaSpace.take</code></a> using <code>txn</code> to a
state where it could be returned. An <code>Entry</code>
makes a transition from <em>invisible to visible</em> when
it goes from being in a state where it could not be returned
by a <a href="../../../net/jini/space/JavaSpace.html#read-net.jini.core.entry.Entry-net.jini.core.transaction.Transaction-long-"><code>JavaSpace.read</code></a> using
<code>txn</code> to a state where it could be
returned. Note, any transition from invisible to visible is
also a transition from unavailable to available, but an
already visible entry can be unavailable and then make a
transition from unavailable to available. Because the entry
was already visible, this transition would not be a
transition from invisible to visible.<p>
The <code>tmpls</code> parameter must be 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> of <code>Entry</code> instances to be used as
templates. Events will be generated when an
<code>Entry</code> that matches one or more of these
templates makes an appropriate transition. A single
transition will generate only one event per registration, in
particular the transition of an <code>Entry</code> that
matches multiple elements of <code>tmpls</code> must still
generate exactly one event for this registration. If a given
<code>Entry</code> undergoes multiple applicable transitions
while the registration is active, each must generate a
separate event.<p>
Events are not generated directly by the transition of
matching entries, but instead by an abstract observer set up
in the space for each registration. The observer may see the
transitions out of order and as a result the order of the
events generated for this registration (as determined by the
sequence numbers assigned to the events) may be different
from the order of the transitions themselves. Additionally,
each registration will have its own abstract observer and
different observers may see the same sequence of transitions
in different orders. As a result, given a set of transitions
that trigger events for two different registrations, the
order of the events generated for one registration may
differ from the order of the events generated for the
other. <p>
A non-<code>null</code> <a href="../../../net/jini/core/event/EventRegistration.html" title="class in net.jini.core.event"><code>EventRegistration</code></a> object
will be returned. Each registration will be assigned an
event ID. The event ID will be unique at least with respect
to all other active event registrations for
<code>AvailabilityEvent</code>s on this space with a
non-equivalent set of templates, a different transaction,
and/or a different value for the
<code>visibilityOnly</code> flag. The event ID can be
obtained by calling the <a href="../../../net/jini/core/event/EventRegistration.html#getID--"><code>EventRegistration.getID</code></a> method on the returned
<code>EventRegistration</code>. The returned
<code>EventRegistration</code> object's <a href="../../../net/jini/core/event/EventRegistration.html#getSource--"><code>EventRegistration.getSource</code></a>
method will return a reference to the space.<p>
Registrations are leased. <code>leaseDurations</code>
represents the client's desired initial lease duration. If
<code>leaseDuration</code> is positive, the initial lease
duration will be a positive value less than or equal to
<code>leaseDuration</code>. If <code>leaseDuration</code> is
<a href="../../../net/jini/core/lease/Lease.html#ANY"><code>Lease.ANY</code></a>, the space is free to pick any
positive initial lease duration it desires. A proxy for the
lease associated with the registration can be obtained by
calling the returned <code>EventRegistration</code>'s <a href="../../../net/jini/core/event/EventRegistration.html#getLease--"><code>EventRegistration.getLease</code></a>
method.<p>
A registration made with a non-<code>null</code> value for
<code>txn</code> is implicitly dropped when the space
observes <code>txn</code> has left the active state.<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tmpls</code> - 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> of <a href="../../../net/jini/core/entry/Entry.html" title="interface in net.jini.core.entry"><code>Entry</code></a>
instances, each representing a
template. Events for this registration will be
generated by the transitions of entries
matching one or more elements of
<code>tmpls</code></dd>
<dd><code>txn</code> - the <a href="../../../net/jini/core/transaction/Transaction.html" title="interface in net.jini.core.transaction"><code>Transaction</code></a> this operation should be
performed under, may be <code>null</code></dd>
<dd><code>visibilityOnly</code> - if <code>true</code>, events will
be generated for this registration only when a
matching <code>Entry</code> transitions from
invisible to visible, otherwise events will be
generated when a matching <code>Entry</code>
makes any transition from unavailable to
available</dd>
<dd><code>listener</code> - the object to which events generated for
this registration should be delivered</dd>
<dd><code>leaseDuration</code> - the requested initial lease time on
the resulting event registration</dd>
<dd><code>handback</code> - the <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/MarshalledObject.html?is-external=true" title="class or interface in java.rmi"><code>MarshalledObject</code></a> to be
returned by the <a href="../../../net/jini/core/event/RemoteEvent.html#getRegistrationObject--"><code>RemoteEvent.getRegistrationObject</code></a> method of
the events generated for this registration</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an <a href="../../../net/jini/core/event/EventRegistration.html" title="class in net.jini.core.event"><code>EventRegistration</code></a> object with
information on this registration</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../net/jini/core/transaction/TransactionException.html" title="class in net.jini.core.transaction">TransactionException</a></code> - if <code>txn</code> is
non-<code>null</code> and is not usable by the
space</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - if a communication error occurs</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if any non-<code>null</code>
element of <code>tmpls</code> is not an instance of
<code>Entry</code>, if <code>tmpls</code> is empty,
or if <code>leaseDuration</code> is neither
positive nor <a href="../../../net/jini/core/lease/Lease.html#ANY"><code>Lease.ANY</code></a></dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>tmpls</code> or
<code>listener</code> is <code>null</code></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/JavaSpace05.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="../../../net/jini/space/JavaSpace.html" title="interface in net.jini.space"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../net/jini/space/MatchSet.html" title="interface in net.jini.space"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/space/JavaSpace05.html" target="_top">Frames</a></li>
<li><a href="JavaSpace05.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>Constr&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>Constr&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>