Google Git
Sign in
apache / axis-site / ba8ff4839a48cf69d0eeaa99c7510eeb785896c0 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / engine / Handler.html
blob: 6738ecf8fc3d862d9ea0821c43e16a396ca5ccce [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>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Handler (Apache Axis2)</title>
<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="Handler (Apache Axis2)";
}
//-->
</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/Handler.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/axis2/engine/DispatchPhase.html" title="class in org.apache.axis2.engine"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/engine/Handler.html" target="_top">Frames</a></li>
<li><a href="Handler.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><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.axis2.engine</div>
<h2 title="Interface Handler" class="title">Interface Handler</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/axis2/transport/http/HTTPTransportSender.html" title="interface in org.apache.axis2.transport.http">HTTPTransportSender</a>, <a href="../../../../org/apache/axis2/transport/TransportSender.html" title="interface in org.apache.axis2.transport">TransportSender</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/axis2/engine/AbstractDispatcher.html" title="class in org.apache.axis2.engine">AbstractDispatcher</a>, <a href="../../../../org/apache/axis2/handlers/AbstractHandler.html" title="class in org.apache.axis2.handlers">AbstractHandler</a>, <a href="../../../../org/apache/axis2/dispatchers/AbstractOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">AbstractOperationDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/AbstractServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">AbstractServiceDispatcher</a>, <a href="../../../../org/apache/axis2/handlers/AbstractTemplatedHandler.html" title="class in org.apache.axis2.handlers">AbstractTemplatedHandler</a>, <a href="../../../../org/apache/axis2/transport/base/AbstractTransportSender.html" title="class in org.apache.axis2.transport.base">AbstractTransportSender</a>, <a href="../../../../org/apache/axis2/dispatchers/ActionBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">ActionBasedOperationDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/AddressingBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">AddressingBasedDispatcher</a>, <a href="../../../../org/apache/axis2/handlers/addressing/AddressingInFaultHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingInFaultHandler</a>, <a href="../../../../org/apache/axis2/handlers/addressing/AddressingInHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingInHandler</a>, <a href="../../../../org/apache/axis2/handlers/addressing/AddressingOutHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingOutHandler</a>, <a href="../../../../org/apache/axis2/handlers/addressing/AddressingValidationHandler.html" title="class in org.apache.axis2.handlers.addressing">AddressingValidationHandler</a>, <a href="../../../../org/apache/axis2/transport/http/CommonsHTTPTransportSender.html" title="class in org.apache.axis2.transport.http">CommonsHTTPTransportSender</a>, <a href="../../../../org/apache/axis2/jaxws/client/dispatch/DispatchOperationHandler.html" title="class in org.apache.axis2.jaxws.client.dispatch">DispatchOperationHandler</a>, <a href="../../../../org/apache/axis2/engine/DispatchPhase.html" title="class in org.apache.axis2.engine">DispatchPhase</a>, <a href="../../../../org/apache/axis2/jaxws/dispatchers/GenericProviderDispatcher.html" title="class in org.apache.axis2.jaxws.dispatchers">GenericProviderDispatcher</a>, <a href="../../../../org/apache/axis2/transport/http/impl/httpclient3/HTTPClient3TransportSender.html" title="class in org.apache.axis2.transport.http.impl.httpclient3">HTTPClient3TransportSender</a>, <a href="../../../../org/apache/axis2/transport/http/impl/httpclient4/HTTPClient4TransportSender.html" title="class in org.apache.axis2.transport.http.impl.httpclient4">HTTPClient4TransportSender</a>, <a href="../../../../org/apache/axis2/dispatchers/HTTPLocationBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">HTTPLocationBasedDispatcher</a>, <a href="../../../../org/apache/axis2/transport/java/JavaTransportSender.html" title="class in org.apache.axis2.transport.java">JavaTransportSender</a>, <a href="../../../../org/apache/axis2/transport/jms/JMSSender.html" title="class in org.apache.axis2.transport.jms">JMSSender</a>, <a href="../../../../org/apache/axis2/json/gson/JSONMessageHandler.html" title="class in org.apache.axis2.json.gson">JSONMessageHandler</a>, <a href="../../../../org/apache/axis2/transport/local/LocalResponder.html" title="class in org.apache.axis2.transport.local">LocalResponder</a>, <a href="../../../../org/apache/axis2/transport/local/LocalTransportSender.html" title="class in org.apache.axis2.transport.local">LocalTransportSender</a>, <a href="../../../../org/apache/axis2/transport/mail/MailTransportSender.html" title="class in org.apache.axis2.transport.mail">MailTransportSender</a>, <a href="../../../../org/apache/axis2/mtompolicy/MTOMInHandler.html" title="class in org.apache.axis2.mtompolicy">MTOMInHandler</a>, <a href="../../../../org/apache/axis2/mtompolicy/MTOMOutHandler.html" title="class in org.apache.axis2.mtompolicy">MTOMOutHandler</a>, <a href="../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandChecker.html" title="class in org.apache.axis2.jaxws.dispatchers">MustUnderstandChecker</a>, <a href="../../../../org/apache/axis2/jaxws/dispatchers/MustUnderstandValidationDispatcher.html" title="class in org.apache.axis2.jaxws.dispatchers">MustUnderstandValidationDispatcher</a>, <a href="../../../../org/apache/axis2/engine/Phase.html" title="class in org.apache.axis2.engine">Phase</a>, <a href="../../../../org/apache/axis2/dispatchers/RelatesToBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">RelatesToBasedOperationDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/RelatesToBasedServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">RelatesToBasedServiceDispatcher</a>, <a href="../../../../org/apache/axis2/clustering/RequestBlockingHandler.html" title="class in org.apache.axis2.clustering">RequestBlockingHandler</a>, <a href="../../../../org/apache/axis2/dispatchers/RequestURIBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIBasedDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/RequestURIBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIBasedOperationDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/RequestURIBasedServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIBasedServiceDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/RequestURIOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">RequestURIOperationDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/SOAPActionBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPActionBasedDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/SOAPMessageBodyBasedDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPMessageBodyBasedDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/SOAPMessageBodyBasedOperationDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPMessageBodyBasedOperationDispatcher</a>, <a href="../../../../org/apache/axis2/dispatchers/SOAPMessageBodyBasedServiceDispatcher.html" title="class in org.apache.axis2.dispatchers">SOAPMessageBodyBasedServiceDispatcher</a>, <a href="../../../../org/apache/axis2/handlers/soapmonitor/SOAPMonitorHandler.html" title="class in org.apache.axis2.handlers.soapmonitor">SOAPMonitorHandler</a>, <a href="../../../../org/apache/axis2/transport/tcp/TCPTransportSender.html" title="class in org.apache.axis2.transport.tcp">TCPTransportSender</a>, <a href="../../../../org/apache/axis2/transport/udp/UDPSender.html" title="class in org.apache.axis2.transport.udp">UDPSender</a>, <a href="../../../../org/apache/axis2/saaj/util/UnderstandAllHeadersHandler.html" title="class in org.apache.axis2.saaj.util">UnderstandAllHeadersHandler</a>, <a href="../../../../org/apache/axis2/transport/xmpp/XMPPSender.html" title="class in org.apache.axis2.transport.xmpp">XMPPSender</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Handler</span></pre>
<div class="block">A Handler represents a piece of message processing functionality in Axis2.
Handlers are combined into chains and phases in order to provide customizable functionality
such as security, reliability, etc. Handlers must be multi-thread safe and should keep all
their state in Context objects (see the org.apache.axis2.context package).</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="overviewSummary" 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 class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></strong></code>
<div class="block">This type encapsulates an enumeration of possible message processing
instruction values that may be returned by a handler/phase within the
runtime.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Handler.html#flowComplete(org.apache.axis2.context.MessageContext)">flowComplete</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">This method will be called on each registered handler that had its
invoke(...) method called during the processing of the message, once
the message processing has completed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Handler.html#getHandlerDesc()">getHandlerDesc</a></strong>()</code>
<div class="block">Gets the HandlerDescription of a handler.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Handler.html#getName()">getName</a></strong>()</code>
<div class="block">Return the name of this Handler</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Handler.html#getParameter(java.lang.String)">getParameter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Get a Parameter from this Handler</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Handler.html#init(org.apache.axis2.description.HandlerDescription)">init</a></strong>(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)</code>
<div class="block">Initialize a Handler.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/engine/Handler.html#invoke(org.apache.axis2.context.MessageContext)">invoke</a></strong>(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</code>
<div class="block">This method will be called on each registered handler when a message
needs to be processed.</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="init(org.apache.axis2.description.HandlerDescription)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void&nbsp;init(<a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;handlerDesc)</pre>
<div class="block">Initialize a Handler.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handlerDesc</code> - the HandlerDescription for this Handler</dd></dl>
</li>
</ul>
<a name="invoke(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invoke</h4>
<pre><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine">Handler.InvocationResponse</a>&nbsp;invoke(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)
throws <a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></pre>
<div class="block">This method will be called on each registered handler when a message
needs to be processed. If the message processing is paused by the
handler, then this method will be called again for the handler that
paused the processing once it is resumed.
<p/>
This method may be called concurrently from multiple threads.
<p/>
Handlers that want to determine the type of message that is to be
processed (e.g. response vs request, inbound vs. outbound, etc.) can
retrieve that information from the MessageContext via
MessageContext.getFLOW() and
MessageContext.getAxisOperation().getMessageExchangePattern() APIs.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the <code>MessageContext</code> to process with this
<code>Handler</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>An InvocationResponse that indicates what
the next step in the message processing should be.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/axis2/AxisFault.html" title="class in org.apache.axis2">AxisFault</a></code> - if the handler encounters an error</dd></dl>
</li>
</ul>
<a name="flowComplete(org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flowComplete</h4>
<pre>void&nbsp;flowComplete(<a href="../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgContext)</pre>
<div class="block">This method will be called on each registered handler that had its
invoke(...) method called during the processing of the message, once
the message processing has completed. During execution of the
flowComplete's, handlers are invoked in the opposite order that they
were invoked originally. Note that implementations SHOULD check
msgContext.getFailureReason() to see if this is an error or a normal
completion.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>msgContext</code> - the <code>MessageContext</code> to process with this
<code>Handler</code>.</dd></dl>
</li>
</ul>
<a name="getHandlerDesc()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandlerDesc</h4>
<pre><a href="../../../../org/apache/axis2/description/HandlerDescription.html" title="class in org.apache.axis2.description">HandlerDescription</a>&nbsp;getHandlerDesc()</pre>
<div class="block">Gets the HandlerDescription of a handler.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns HandlerDescription.</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Return the name of this Handler</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the handler's name as a String</dd></dl>
</li>
</ul>
<a name="getParameter(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getParameter</h4>
<pre><a href="../../../../org/apache/axis2/description/Parameter.html" title="class in org.apache.axis2.description">Parameter</a>&nbsp;getParameter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Get a Parameter from this Handler</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the desired value</dd>
<dt><span class="strong">Returns:</span></dt><dd>the Parameter, or null.</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/Handler.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/axis2/engine/DispatchPhase.html" title="class in org.apache.axis2.engine"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/axis2/engine/Handler.InvocationResponse.html" title="class in org.apache.axis2.engine"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/engine/Handler.html" target="_top">Frames</a></li>
<li><a href="Handler.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><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 ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>