blob: d9c0cfe6670632222089b5803b2d16d997ed3669 [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:27 PDT 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SubjectRunnable (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="SubjectRunnable (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/SubjectRunnable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="class in org.apache.shiro.subject.support"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html" title="class in org.apache.shiro.subject.support"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/subject/support/SubjectRunnable.html" target="_top">Frames</a></li>
<li><a href="SubjectRunnable.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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.subject.support</div>
<h2 title="Class SubjectRunnable" class="title">Class SubjectRunnable</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.subject.support.SubjectRunnable</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/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectRunnable.html#line.57">SubjectRunnable</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/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></pre>
<div class="block">A <code>SubjectRunnable</code> ensures that a target/delegate <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> will execute such that any
call to <code>SecurityUtils.</code><a href="../../../../../org/apache/shiro/SecurityUtils.html#getSubject()"><code>getSubject()</code></a> during the
<code>Runnable</code>'s execution will return the associated <code>Subject</code> instance. The <code>SubjectRunnable</code>
instance can be run on any thread (the current thread or asynchronously on another thread) and the
<code>SecurityUtils.getSubject()</code> call will still work properly. This implementation also guarantees that Shiro's
thread state will be identical before and after execution to ensure threads remain clean in any thread-pooled
environment.
<p/>
When instances of this class <a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang"><code>run()</code></a>, the following occurs:
<ol>
<li>The Subject and any of its associated thread state is first bound to the thread that executes the
<code>Runnable</code>.</li>
<li>The delegate/target <code>Runnable</code> is <a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#doRun(java.lang.Runnable)"><code>run</code></a></li>
<li>Any previous thread state that might have existed before the <code>Subject</code> was bound is fully restored</li>
</ol>
<p/>
<h3>Usage</h3>
This is typically considered a support class and is not often directly referenced. Most people prefer to use
the <code>Subject.</code><a href="../../../../../org/apache/shiro/subject/Subject.html#execute(java.lang.Runnable)"><code>execute</code></a> or
<code>Subject.</code><a href="../../../../../org/apache/shiro/subject/Subject.html#associateWith(java.lang.Runnable)"><code>associateWith</code></a> methods, which transparently perform the
necessary association logic.
<p/>
An even more convenient alternative is to use a
<a href="../../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html" title="class in org.apache.shiro.concurrent"><code>SubjectAwareExecutor</code></a>, which transparently uses
instances of this class but does not require referencing Shiro's API at all.</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/subject/Subject.html#associateWith(java.lang.Runnable)"><code>Subject.associateWith(Runnable)</code></a>,
<a href="../../../../../org/apache/shiro/concurrent/SubjectAwareExecutor.html" title="class in org.apache.shiro.concurrent"><code>SubjectAwareExecutor</code></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>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#threadState">threadState</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#SubjectRunnable(org.apache.shiro.subject.Subject, java.lang.Runnable)">SubjectRunnable</a></strong>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject,
<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;delegate)</code>
<div class="block">Creates a new <code>SubjectRunnable</code> that, when executed, will execute the target <code>delegate</code>, but
guarantees that it will run associated with the specified <code>Subject</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#SubjectRunnable(org.apache.shiro.util.ThreadState, java.lang.Runnable)">SubjectRunnable</a></strong>(<a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a>&nbsp;threadState,
<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;delegate)</code>
<div class="block">Creates a new <code>SubjectRunnable</code> that, when executed, will perform thread state
<a href="../../../../../org/apache/shiro/util/ThreadState.html#bind()"><code>binding</code></a> and guaranteed <a href="../../../../../org/apache/shiro/util/ThreadState.html#restore()"><code>restoration</code></a> before and after the
<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>'s execution, respectively.</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="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 void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#doRun(java.lang.Runnable)">doRun</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;runnable)</code>
<div class="block">Simply calls the target <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>'s <a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang"><code>run()</code></a> method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#run()">run</a></strong>()</code>
<div class="block"><a href="../../../../../org/apache/shiro/util/ThreadState.html#bind()"><code>Bind</code></a>s the Subject thread state, executes the target <code>Runnable</code> and then guarantees
the previous thread state's <a href="../../../../../org/apache/shiro/util/ThreadState.html#restore()"><code>restoration</code></a>:</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="threadState">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>threadState</h4>
<pre>protected final&nbsp;<a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a> <a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectRunnable.html#line.59">threadState</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SubjectRunnable(org.apache.shiro.subject.Subject, java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SubjectRunnable</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectRunnable.html#line.69">SubjectRunnable</a>(<a href="../../../../../org/apache/shiro/subject/Subject.html" title="interface in org.apache.shiro.subject">Subject</a>&nbsp;subject,
<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;delegate)</pre>
<div class="block">Creates a new <code>SubjectRunnable</code> that, when executed, will execute the target <code>delegate</code>, but
guarantees that it will run associated with the specified <code>Subject</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>subject</code> - the Subject to associate with the delegate's execution.</dd><dd><code>delegate</code> - the runnable to run.</dd></dl>
</li>
</ul>
<a name="SubjectRunnable(org.apache.shiro.util.ThreadState, java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SubjectRunnable</h4>
<pre>protected&nbsp;<a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectRunnable.html#line.82">SubjectRunnable</a>(<a href="../../../../../org/apache/shiro/util/ThreadState.html" title="interface in org.apache.shiro.util">ThreadState</a>&nbsp;threadState,
<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;delegate)
throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre>
<div class="block">Creates a new <code>SubjectRunnable</code> that, when executed, will perform thread state
<a href="../../../../../org/apache/shiro/util/ThreadState.html#bind()"><code>binding</code></a> and guaranteed <a href="../../../../../org/apache/shiro/util/ThreadState.html#restore()"><code>restoration</code></a> before and after the
<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>'s execution, respectively.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>threadState</code> - the thread state to bind and unbind before and after the runnable's execution.</dd><dd><code>delegate</code> - the delegate <code>Runnable</code> to execute when this instance is <a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#run()"><code>run()</code></a>.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if either the <code>ThreadState</code> or <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> arguments are <code>null</code>.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="run()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>run</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectRunnable.html#line.105">run</a>()</pre>
<div class="block"><a href="../../../../../org/apache/shiro/util/ThreadState.html#bind()"><code>Bind</code></a>s the Subject thread state, executes the target <code>Runnable</code> and then guarantees
the previous thread state's <a href="../../../../../org/apache/shiro/util/ThreadState.html#restore()"><code>restoration</code></a>:
<pre>
try {
threadState.<a href="../../../../../org/apache/shiro/util/ThreadState.html#bind()"><code>bind()</code></a>;
<a href="../../../../../org/apache/shiro/subject/support/SubjectRunnable.html#doRun(java.lang.Runnable)"><code>doRun</code></a>(targetRunnable);
} finally {
threadState.<a href="../../../../../org/apache/shiro/util/ThreadState.html#restore()"><code>restore()</code></a>
}
</pre></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang">run</a></code>&nbsp;in interface&nbsp;<code><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></dd>
</dl>
</li>
</ul>
<a name="doRun(java.lang.Runnable)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>doRun</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/shiro/subject/support/SubjectRunnable.html#line.119">doRun</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;runnable)</pre>
<div class="block">Simply calls the target <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>'s <a href="http://java.sun.com/javase/6/docs/api/java/lang/Runnable.html?is-external=true#run()" title="class or interface in java.lang"><code>run()</code></a> method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>runnable</code> - the target runnable to run.</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/SubjectRunnable.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/shiro/subject/support/SubjectCallable.html" title="class in org.apache.shiro.subject.support"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/shiro/subject/support/SubjectThreadState.html" title="class in org.apache.shiro.subject.support"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/shiro/subject/support/SubjectRunnable.html" target="_top">Frames</a></li>
<li><a href="SubjectRunnable.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><a href="#field_summary">Field</a>&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><a href="#field_detail">Field</a>&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>