blob: fd5ec1bc3cbb1ead57562f17f8f7e2d39dd3a158 [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 (version 1.7.0_21) on Thu May 30 14:51:24 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SubjectAwareExecutor (Apache Shiro 1.2.1 API)</title>
<meta name="date" content="2013-05-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SubjectAwareExecutor (Apache Shiro 1.2.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/SubjectAwareExecutor.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>Prev Class</li>
<li><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutorService.html" title="class in org.apache.shiro.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/concurrent/SubjectAwareExecutor.html" target="_top">Frames</a></li>
<li><a href="SubjectAwareExecutor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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.shiro.concurrent</div>
<h2 title="Class SubjectAwareExecutor" class="title">Class SubjectAwareExecutor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://java.sun.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.shiro.concurrent.SubjectAwareExecutor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutorService.html" title="class in org.apache.shiro.concurrent">SubjectAwareExecutorService</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.56">SubjectAwareExecutor</a>
extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a></pre>
<div class="block"><code>Executor</code> implementation that will automatically first associate any argument
<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang"><code>Runnable</code></a> instances with the currently available <a href="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> and then
dispatch the Subject-enabled runnable to an underlying delegate <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent"><code>Executor</code></a>
instance.
<p/>
This is a simplification for applications that want to execute code as the currently
executing <code>Subject</code> on another thread, but don't want or need to call the
<a href="../../../../org/apache/shiro/subject/Subject.html#associateWith(java.lang.Runnable)"><code>Subject.associateWith(Runnable)</code></a> method and dispatch to a Thread manually. This
simplifies code and reduces Shiro dependencies across application source code.
<p/>
Consider this code that could be repeated in many places across an application:
<pre>
<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang"><code>Runnable</code></a> applicationWork = //instantiate or acquire Runnable from somewhere
<a href="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject"><code>Subject</code></a> subject = <a href="../../../../org/apache/shiro/SecurityUtils.html" title="class in org.apache.shiro"><code>SecurityUtils</code></a>.<a href="../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a>;
<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang"><code>Runnable</code></a> work = subject.<a href="../../../../org/apache/shiro/subject/Subject.html#associateWith(java.lang.Runnable)"><code>associateWith(applicationWork)</code></a>;
<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent"><code>anExecutor</code></a>.<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true#execute(java.lang.Runnable)" title="class or interface in java.util.concurrent"><code>execute(work)</code></a>;
</pre>
Instead, if the <code>Executor</code> instance used in application code is an instance of this class (which delegates
to the target Executor that you want), all places in code like the above reduce to this:
<pre>
<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang"><code>Runnable</code></a> applicationWork = //instantiate or acquire Runnable from somewhere
<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent"><code>anExecutor</code></a>.<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true#execute(java.lang.Runnable)" title="class or interface in java.util.concurrent"><code>execute(work)</code></a>;
</pre>
Notice there is no use of the Shiro API in the 2nd code block, encouraging the principle of loose coupling across
your codebase.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutorService.html" title="class in org.apache.shiro.concurrent"><code>SubjectAwareExecutorService</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="overviewSummary" 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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#SubjectAwareExecutor()">SubjectAwareExecutor</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#SubjectAwareExecutor(java.util.concurrent.Executor)">SubjectAwareExecutor</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;targetExecutor)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#associateWithSubject(java.lang.Runnable)">associateWithSubject</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;r)</code>
<div class="block">Utility method for subclasses to associate the argument <code>Runnable</code> with the currently executing subject
and then return the associated Runnable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#execute(java.lang.Runnable)">execute</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;command)</code>
<div class="block">Executes the specified runnable by first associating it with the currently executing <code>Subject</code> and then
dispatches the associated Runnable to the underlying target <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent"><code>Executor</code></a> instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#getSubject()">getSubject</a></strong>()</code>
<div class="block">Returns the currently Subject instance that should be associated with Runnable or Callable instances before
being dispatched to the target <code>Executor</code> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#getTargetExecutor()">getTargetExecutor</a></strong>()</code>
<div class="block">Returns the target Executor instance that will actually execute the subject-associated Runnable instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#setTargetExecutor(java.util.concurrent.Executor)">setTargetExecutor</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;targetExecutor)</code>
<div class="block">Sets target Executor instance that will actually execute the subject-associated Runnable instances.</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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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://java.sun.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="SubjectAwareExecutor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SubjectAwareExecutor</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.63">SubjectAwareExecutor</a>()</pre>
</li>
</ul>
<a name="SubjectAwareExecutor(java.util.concurrent.Executor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SubjectAwareExecutor</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.66">SubjectAwareExecutor</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;targetExecutor)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTargetExecutor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetExecutor</h4>
<pre>public&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.78">getTargetExecutor</a>()</pre>
<div class="block">Returns the target Executor instance that will actually execute the subject-associated Runnable instances.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>target Executor instance that will actually execute the subject-associated Runnable instances.</dd></dl>
</li>
</ul>
<a name="setTargetExecutor(java.util.concurrent.Executor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTargetExecutor</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.88">setTargetExecutor</a>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a>&nbsp;targetExecutor)</pre>
<div class="block">Sets target Executor instance that will actually execute the subject-associated Runnable instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>targetExecutor</code> - the target Executor instance that will actually execute the subject-associated Runnable
instances.</dd></dl>
</li>
</ul>
<a name="getSubject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubject</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.100">getSubject</a>()</pre>
<div class="block">Returns the currently Subject instance that should be associated with Runnable or Callable instances before
being dispatched to the target <code>Executor</code> instance. This implementation merely defaults to returning
<code>SecurityUtils</code>.<a href="../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the currently Subject instance that should be associated with Runnable or Callable instances before
being dispatched to the target <code>Executor</code> instance.</dd></dl>
</li>
</ul>
<a name="associateWithSubject(java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>associateWithSubject</h4>
<pre>protected&nbsp;<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;<a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.115">associateWithSubject</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;r)</pre>
<div class="block">Utility method for subclasses to associate the argument <code>Runnable</code> with the currently executing subject
and then return the associated Runnable. The default implementation merely defaults to
<pre>
Subject subject = <a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html#getSubject()"><code>getSubject()</code></a>;
return subject.<a href="../../../../org/apache/shiro/subject/Subject.html#associateWith(java.lang.Runnable)"><code>associateWith(r)</code></a>;
</pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>r</code> - the argument runnable to be associated with the current subject</dd>
<dt><span class="strong">Returns:</span></dt><dd>the associated runnable instance reflecting the current subject</dd></dl>
</li>
</ul>
<a name="execute(java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/shiro/concurrent/SubjectAwareExecutor.html#line.127">execute</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>&nbsp;command)</pre>
<div class="block">Executes the specified runnable by first associating it with the currently executing <code>Subject</code> and then
dispatches the associated Runnable to the underlying target <a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent"><code>Executor</code></a> instance.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true#execute(java.lang.Runnable)" title="class or interface in java.util.concurrent">execute</a></code>&nbsp;in interface&nbsp;<code><a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent">Executor</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>command</code> - the runnable to associate with the currently executing subject and then to execute via the target
<code>Executor</code> instance.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/SubjectAwareExecutor.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>Prev Class</li>
<li><a href="../../../../org/apache/shiro/concurrent/SubjectAwareExecutorService.html" title="class in org.apache.shiro.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/shiro/concurrent/SubjectAwareExecutor.html" target="_top">Frames</a></li>
<li><a href="SubjectAwareExecutor.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&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 &#169; 2004-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>