blob: e3d2bfeba2bd9cac9e4c251da08b5b8dc99dc599 [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>
<title>TransactionPolicy</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TransactionPolicy";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":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="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/openejb/core/transaction/SimpleWorkManager.WorkType.html" title="enum in org.apache.openejb.core.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/transaction/TransactionPolicy.html" target="_top">Frames</a></li>
<li><a href="TransactionPolicy.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><a href="#nested.class.summary">Nested</a>&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">org.apache.openejb.core.transaction</div>
<h2 title="Interface TransactionPolicy" class="title">Interface TransactionPolicy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/openejb/core/transaction/BeanTransactionPolicy.html" title="interface in org.apache.openejb.core.transaction">BeanTransactionPolicy</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/openejb/core/transaction/JtaTransactionPolicy.html" title="class in org.apache.openejb.core.transaction">JtaTransactionPolicy</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxBeanManaged.html" title="class in org.apache.openejb.core.transaction">TxBeanManaged</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxMandatory.html" title="class in org.apache.openejb.core.transaction">TxMandatory</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxNever.html" title="class in org.apache.openejb.core.transaction">TxNever</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxNotSupported.html" title="class in org.apache.openejb.core.transaction">TxNotSupported</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxRequired.html" title="class in org.apache.openejb.core.transaction">TxRequired</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxRequiresNew.html" title="class in org.apache.openejb.core.transaction">TxRequiresNew</a>, <a href="../../../../../org/apache/openejb/core/transaction/TxSupports.html" title="class in org.apache.openejb.core.transaction">TxSupports</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TransactionPolicy</span></pre>
<div class="block">TransactionPolicy represents a JEE container managed or bean manage
transaction.
This class can be used to query the transaction status, set the transaction
rollback only flag, associate resources with the transaction and to register
a listener for transaction completion events.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy.TransactionSynchronization</a></span></code>
<div class="block">TransactionSynchronization receives notifications as the Transaction
completes.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#commit--">commit</a></span>()</code>
<div class="block">Commits or rolls back this TransactionPolicy.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#enlistResource-javax.transaction.xa.XAResource-">enlistResource</a></span>(javax.transaction.xa.XAResource&nbsp;xaResource)</code>
<div class="block">Enlists a XAResource in the actual active transaction.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getResource-java.lang.Object-">getResource</a></span>(java.lang.Object&nbsp;key)</code>
<div class="block">Gets a resource associated with the specified key.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#getTransactionType--">getTransactionType</a></span>()</code>
<div class="block">Gets the TransactionType for this policy.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isClientTransaction--">isClientTransaction</a></span>()</code>
<div class="block">Is this policy running in an inhreited transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isNewTransaction--">isNewTransaction</a></span>()</code>
<div class="block">Is this a new transaction and not an inhreited transaction or no transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isRollbackOnly--">isRollbackOnly</a></span>()</code>
<div class="block">If true, this TransactionPolicy will ultimately end with rollback.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#isTransactionActive--">isTransactionActive</a></span>()</code>
<div class="block">Is there a actual transaction active?</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#putResource-java.lang.Object-java.lang.Object-">putResource</a></span>(java.lang.Object&nbsp;key,
java.lang.Object&nbsp;value)</code>
<div class="block">Associates the specified resource with the specified key.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">registerSynchronization</a></span>(<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy.TransactionSynchronization</a>&nbsp;synchronization)</code>
<div class="block">Registers a listener for transaction synchronization events.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#removeResource-java.lang.Object-">removeResource</a></span>(java.lang.Object&nbsp;key)</code>
<div class="block">Removes and returns the resource associated with the specified key.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly--">setRollbackOnly</a></span>()</code>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.html#setRollbackOnly-java.lang.Throwable-">setRollbackOnly</a></span>(java.lang.Throwable&nbsp;reason)</code>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTransactionType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactionType</h4>
<pre><a href="../../../../../org/apache/openejb/core/transaction/TransactionType.html" title="enum in org.apache.openejb.core.transaction">TransactionType</a>&nbsp;getTransactionType()</pre>
<div class="block">Gets the TransactionType for this policy.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the TransactionType for this policy</dd>
</dl>
</li>
</ul>
<a name="isNewTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNewTransaction</h4>
<pre>boolean&nbsp;isNewTransaction()</pre>
<div class="block">Is this a new transaction and not an inhreited transaction or no transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction. If there is no active
transaction (e.g., TransactionType is NotSupported), this method will</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this not an inherited transaction</dd>
</dl>
</li>
</ul>
<a name="isClientTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClientTransaction</h4>
<pre>boolean&nbsp;isClientTransaction()</pre>
<div class="block">Is this policy running in an inhreited transaction? Some
TransactionTypes, such as Required or Supported, use the caller's
transaction instead of starting a new transaction. If there is no active
transaction (e.g., TransactionType is NotSupported), this method will
return false.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this is an inherited transaction</dd>
</dl>
</li>
</ul>
<a name="isTransactionActive--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTransactionActive</h4>
<pre>boolean&nbsp;isTransactionActive()</pre>
<div class="block">Is there a actual transaction active?</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if there is an actual transaction active</dd>
</dl>
</li>
</ul>
<a name="isRollbackOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRollbackOnly</h4>
<pre>boolean&nbsp;isRollbackOnly()</pre>
<div class="block">If true, this TransactionPolicy will ultimately end with rollback.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this TransactionPolicy will ultimately end with rollback</dd>
</dl>
</li>
</ul>
<a name="setRollbackOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRollbackOnly</h4>
<pre>void&nbsp;setRollbackOnly()</pre>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
</li>
</ul>
<a name="setRollbackOnly-java.lang.Throwable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRollbackOnly</h4>
<pre>void&nbsp;setRollbackOnly(java.lang.Throwable&nbsp;reason)</pre>
<div class="block">Sets this TransactionPolicy to rollback when completed</div>
</li>
</ul>
<a name="commit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>void&nbsp;commit()
throws <a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a>,
<a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<div class="block">Commits or rolls back this TransactionPolicy. If there the actual
transaction is completed or there is no actual transaction, the
registered TransactionSynchronization are called. Otherwise, the
registered TransactionSynchronization are called when the actual
transaction is completed.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/ApplicationException.html" title="class in org.apache.openejb">ApplicationException</a></code> - if recoverable exception is encountered</dd>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code> - if an unrecoverable exception is encountered</dd>
</dl>
</li>
</ul>
<a name="getResource-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResource</h4>
<pre>java.lang.Object&nbsp;getResource(java.lang.Object&nbsp;key)</pre>
<div class="block">Gets a resource associated with the specified key. If there is an actual
transaction active, the resource associated with the transaction is
returned; otherwise the resource is scoped to this TransactionPolicy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the resource key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resource or null if no resource was associated with the key</dd>
</dl>
</li>
</ul>
<a name="putResource-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putResource</h4>
<pre>void&nbsp;putResource(java.lang.Object&nbsp;key,
java.lang.Object&nbsp;value)</pre>
<div class="block">Associates the specified resource with the specified key. If there is an
actual transaction active, the resource associated with the transaction
is set; otherwise the resource is scoped to this TransactionPolicy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the resource key</dd>
<dd><code>value</code> - the resource</dd>
</dl>
</li>
</ul>
<a name="removeResource-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeResource</h4>
<pre>java.lang.Object&nbsp;removeResource(java.lang.Object&nbsp;key)</pre>
<div class="block">Removes and returns the resource associated with the specified key. If
there is an actual transaction active, the resource associated with the
transaction is returned; otherwise the resource is scoped to this
TransactionPolicy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the resource key</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the resource previously associated with the key</dd>
</dl>
</li>
</ul>
<a name="registerSynchronization-org.apache.openejb.core.transaction.TransactionPolicy.TransactionSynchronization-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerSynchronization</h4>
<pre>void&nbsp;registerSynchronization(<a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction">TransactionPolicy.TransactionSynchronization</a>&nbsp;synchronization)</pre>
<div class="block">Registers a listener for transaction synchronization events. If there is
an actual transaction active, the events are fired when the acutal
transaction is commited; otherwise the events are fired when this
TransactionPolicy completes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>synchronization</code> - the transaction synchronization listener</dd>
</dl>
</li>
</ul>
<a name="enlistResource-javax.transaction.xa.XAResource-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>enlistResource</h4>
<pre>void&nbsp;enlistResource(javax.transaction.xa.XAResource&nbsp;xaResource)
throws <a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></pre>
<div class="block">Enlists a XAResource in the actual active transaction. This only works
if the TransactionPolicy is associated with an actual transaction and the
TransactionPolicy supports XAResouce enlistment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>xaResource</code> - the XAResource to enlist</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/openejb/SystemException.html" title="class in org.apache.openejb">SystemException</a></code> - if the xaResource could not be enlisted in the
transaction</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="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/openejb/core/transaction/SimpleWorkManager.WorkType.html" title="enum in org.apache.openejb.core.transaction"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/openejb/core/transaction/TransactionPolicy.TransactionSynchronization.html" title="interface in org.apache.openejb.core.transaction"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/openejb/core/transaction/TransactionPolicy.html" target="_top">Frames</a></li>
<li><a href="TransactionPolicy.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><a href="#nested.class.summary">Nested</a>&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 ======= -->
</body>
</html>