blob: 6f970dee52630097298d462a5a5d6e6a93e1bb08 [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_80) on Thu Aug 04 13:19:27 BST 2016 -->
<title>ProcessorContext (kafka 0.10.0.1 API)</title>
<meta name="date" content="2016-08-04">
<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="ProcessorContext (kafka 0.10.0.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="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/kafka/streams/processor/Processor.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/kafka/streams/processor/ProcessorSupplier.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/ProcessorContext.html" target="_top">Frames</a></li>
<li><a href="ProcessorContext.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>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.kafka.streams.processor</div>
<h2 title="Interface ProcessorContext" class="title">Interface ProcessorContext</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceStability.Unstable
public interface <span class="strong">ProcessorContext</span></pre>
<div class="block">Processor context interface.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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><a href="http://docs.oracle.com/javase/7/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/kafka/streams/processor/ProcessorContext.html#applicationId()">applicationId</a></strong>()</code>
<div class="block">Returns the application id</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#commit()">commit</a></strong>()</code>
<div class="block">Requests a commit</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;K,V&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#forward(K,%20V)">forward</a></strong>(K&nbsp;key,
V&nbsp;value)</code>
<div class="block">Forwards a key/value pair to the downstream processors</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&lt;K,V&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#forward(K,%20V,%20int)">forward</a></strong>(K&nbsp;key,
V&nbsp;value,
int&nbsp;childIndex)</code>
<div class="block">Forwards a key/value pair to one of the downstream processors designated by childIndex</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&lt;K,V&gt;&nbsp;void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#forward(K,%20V,%20java.lang.String)">forward</a></strong>(K&nbsp;key,
V&nbsp;value,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;childName)</code>
<div class="block">Forwards a key/value pair to one of the downstream processors designated by the downstream processor name</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#getStateStore(java.lang.String)">getStateStore</a></strong>(<a href="http://docs.oracle.com/javase/7/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 the state store given the store name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a>&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#keySerde()">keySerde</a></strong>()</code>
<div class="block">Returns the default key serde</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/StreamsMetrics.html" title="interface in org.apache.kafka.streams">StreamsMetrics</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#metrics()">metrics</a></strong>()</code>
<div class="block">Returns Metrics instance</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#offset()">offset</a></strong>()</code>
<div class="block">Returns the offset of the current input record; could be -1 if it is not
available (for example, if this method is invoked from the punctuate call)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#partition()">partition</a></strong>()</code>
<div class="block">Returns the partition id of the current input record; could be -1 if it is not
available (for example, if this method is invoked from the punctuate call)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#register(org.apache.kafka.streams.processor.StateStore,%20boolean,%20org.apache.kafka.streams.processor.StateRestoreCallback)">register</a></strong>(<a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>&nbsp;store,
boolean&nbsp;loggingEnabled,
<a href="../../../../../org/apache/kafka/streams/processor/StateRestoreCallback.html" title="interface in org.apache.kafka.streams.processor">StateRestoreCallback</a>&nbsp;stateRestoreCallback)</code>
<div class="block">Registers and possibly restores the specified storage engine.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#schedule(long)">schedule</a></strong>(long&nbsp;interval)</code>
<div class="block">Schedules a periodic operation for processors.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#stateDir()">stateDir</a></strong>()</code>
<div class="block">Returns the state directory for the partition.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#taskId()">taskId</a></strong>()</code>
<div class="block">Returns the task id</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#timestamp()">timestamp</a></strong>()</code>
<div class="block">Returns the current timestamp.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/kafka/streams/processor/ProcessorContext.html#topic()">topic</a></strong>()</code>
<div class="block">Returns the topic name of the current input record; could be null if it is not
available (for example, if this method is invoked from the punctuate call)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a>&lt;?&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/processor/ProcessorContext.html#valueSerde()">valueSerde</a></strong>()</code>
<div class="block">Returns the default value serde</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="applicationId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applicationId</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;applicationId()</pre>
<div class="block">Returns the application id</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the application id</dd></dl>
</li>
</ul>
<a name="taskId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>taskId</h4>
<pre><a href="../../../../../org/apache/kafka/streams/processor/TaskId.html" title="class in org.apache.kafka.streams.processor">TaskId</a>&nbsp;taskId()</pre>
<div class="block">Returns the task id</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the task id</dd></dl>
</li>
</ul>
<a name="keySerde()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keySerde</h4>
<pre><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a>&lt;?&gt;&nbsp;keySerde()</pre>
<div class="block">Returns the default key serde</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the key serializer</dd></dl>
</li>
</ul>
<a name="valueSerde()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueSerde</h4>
<pre><a href="../../../../../org/apache/kafka/common/serialization/Serde.html" title="interface in org.apache.kafka.common.serialization">Serde</a>&lt;?&gt;&nbsp;valueSerde()</pre>
<div class="block">Returns the default value serde</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the value serializer</dd></dl>
</li>
</ul>
<a name="stateDir()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stateDir</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;stateDir()</pre>
<div class="block">Returns the state directory for the partition.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the state directory</dd></dl>
</li>
</ul>
<a name="metrics()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>metrics</h4>
<pre><a href="../../../../../org/apache/kafka/streams/StreamsMetrics.html" title="interface in org.apache.kafka.streams">StreamsMetrics</a>&nbsp;metrics()</pre>
<div class="block">Returns Metrics instance</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>StreamsMetrics</dd></dl>
</li>
</ul>
<a name="register(org.apache.kafka.streams.processor.StateStore, boolean, org.apache.kafka.streams.processor.StateRestoreCallback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre>void&nbsp;register(<a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>&nbsp;store,
boolean&nbsp;loggingEnabled,
<a href="../../../../../org/apache/kafka/streams/processor/StateRestoreCallback.html" title="interface in org.apache.kafka.streams.processor">StateRestoreCallback</a>&nbsp;stateRestoreCallback)</pre>
<div class="block">Registers and possibly restores the specified storage engine.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>store</code> - the storage engine</dd></dl>
</li>
</ul>
<a name="getStateStore(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStateStore</h4>
<pre><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>&nbsp;getStateStore(<a href="http://docs.oracle.com/javase/7/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 the state store given the store name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The store name</dd>
<dt><span class="strong">Returns:</span></dt><dd>The state store instance</dd></dl>
</li>
</ul>
<a name="schedule(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>schedule</h4>
<pre>void&nbsp;schedule(long&nbsp;interval)</pre>
<div class="block">Schedules a periodic operation for processors. A processor may call this method during
<a href="../../../../../org/apache/kafka/streams/processor/Processor.html#init(org.apache.kafka.streams.processor.ProcessorContext)"><code>initialization</code></a> to
schedule a periodic call called a punctuation to <a href="../../../../../org/apache/kafka/streams/processor/Processor.html#punctuate(long)"><code>Processor.punctuate(long)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - the time interval between punctuations</dd></dl>
</li>
</ul>
<a name="forward(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a name="forward(K, V)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forward</h4>
<pre>&lt;K,V&gt;&nbsp;void&nbsp;forward(K&nbsp;key,
V&nbsp;value)</pre>
<div class="block">Forwards a key/value pair to the downstream processors</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key</dd><dd><code>value</code> - value</dd></dl>
</li>
</ul>
<a name="forward(java.lang.Object,java.lang.Object,int)">
<!-- -->
</a><a name="forward(K, V, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forward</h4>
<pre>&lt;K,V&gt;&nbsp;void&nbsp;forward(K&nbsp;key,
V&nbsp;value,
int&nbsp;childIndex)</pre>
<div class="block">Forwards a key/value pair to one of the downstream processors designated by childIndex</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key</dd><dd><code>value</code> - value</dd><dd><code>childIndex</code> - index in list of children of this node</dd></dl>
</li>
</ul>
<a name="forward(java.lang.Object,java.lang.Object,java.lang.String)">
<!-- -->
</a><a name="forward(K, V, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forward</h4>
<pre>&lt;K,V&gt;&nbsp;void&nbsp;forward(K&nbsp;key,
V&nbsp;value,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;childName)</pre>
<div class="block">Forwards a key/value pair to one of the downstream processors designated by the downstream processor name</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - key</dd><dd><code>value</code> - value</dd><dd><code>childName</code> - name of downstream processor</dd></dl>
</li>
</ul>
<a name="commit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commit</h4>
<pre>void&nbsp;commit()</pre>
<div class="block">Requests a commit</div>
</li>
</ul>
<a name="topic()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>topic</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;topic()</pre>
<div class="block">Returns the topic name of the current input record; could be null if it is not
available (for example, if this method is invoked from the punctuate call)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the topic name</dd></dl>
</li>
</ul>
<a name="partition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partition</h4>
<pre>int&nbsp;partition()</pre>
<div class="block">Returns the partition id of the current input record; could be -1 if it is not
available (for example, if this method is invoked from the punctuate call)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the partition id</dd></dl>
</li>
</ul>
<a name="offset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>offset</h4>
<pre>long&nbsp;offset()</pre>
<div class="block">Returns the offset of the current input record; could be -1 if it is not
available (for example, if this method is invoked from the punctuate call)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the offset</dd></dl>
</li>
</ul>
<a name="timestamp()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>timestamp</h4>
<pre>long&nbsp;timestamp()</pre>
<div class="block">Returns the current timestamp.
If it is triggered while processing a record streamed from the source processor, timestamp is defined as the timestamp of the current input record; the timestamp is extracted from
<a href="../../../../../org/apache/kafka/clients/consumer/ConsumerRecord.html" title="class in org.apache.kafka.clients.consumer"><code>ConsumerRecord</code></a> by <a href="../../../../../org/apache/kafka/streams/processor/TimestampExtractor.html" title="interface in org.apache.kafka.streams.processor"><code>TimestampExtractor</code></a>.
If it is triggered while processing a record generated not from the source processor (for example,
if this method is invoked from the punctuate call), timestamp is defined as the current
task's stream time, which is defined as the smallest among all its input stream partition timestamps.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the timestamp</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="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/kafka/streams/processor/Processor.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/kafka/streams/processor/ProcessorSupplier.html" title="interface in org.apache.kafka.streams.processor"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/kafka/streams/processor/ProcessorContext.html" target="_top">Frames</a></li>
<li><a href="ProcessorContext.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>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>