blob: cbae7dfd8531c3cfddaed04be63f46934fe58936 [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 (1.8.0_101) on Thu Sep 01 13:59:14 BST 2016 -->
<title>MqttMessage</title>
<meta name="date" content="2016-09-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MqttMessage";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MqttMessage.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-files/index-1.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/eclipse/paho/client/mqttv3/MqttException.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttPersistable.html" title="interface in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/paho/client/mqttv3/MqttMessage.html" target="_top">Frames</a></li>
<li><a href="MqttMessage.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>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.eclipse.paho.client.mqttv3</div>
<h2 title="Class MqttMessage" class="title">Class MqttMessage</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.paho.client.mqttv3.MqttMessage</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/internal/wire/MqttReceivedMessage.html" title="class in org.eclipse.paho.client.mqttv3.internal.wire">MqttReceivedMessage</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">MqttMessage</span>
extends java.lang.Object</pre>
<div class="block">An MQTT message holds the application payload and options
specifying how the message is to be delivered
The message includes a "payload" (the body of the message)
represented as a byte[].</div>
</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#MqttMessage--">MqttMessage</a></span>()</code>
<div class="block">Constructs a message with an empty payload, and all other values
set to defaults.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#MqttMessage-byte:A-">MqttMessage</a></span>(byte[]&nbsp;payload)</code>
<div class="block">Constructs a message with the specified byte array as a payload,
and all other values set to defaults.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#clearPayload--">clearPayload</a></span>()</code>
<div class="block">Clears the payload, resetting it to be empty.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#getId--">getId</a></span>()</code>
<div class="block">Returns the MQTT id of the message.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#getPayload--">getPayload</a></span>()</code>
<div class="block">Returns the payload as a byte array.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#getQos--">getQos</a></span>()</code>
<div class="block">Returns the quality of service for this message.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#isDuplicate--">isDuplicate</a></span>()</code>
<div class="block">Returns whether or not this message might be a duplicate of one which has
already been received.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#isRetained--">isRetained</a></span>()</code>
<div class="block">Returns whether or not this message should be/was retained by the server.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#setId-int-">setId</a></span>(int&nbsp;messageId)</code>
<div class="block">This is only to be used internally to provide the MQTT id of a message
received from the server.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#setPayload-byte:A-">setPayload</a></span>(byte[]&nbsp;payload)</code>
<div class="block">Sets the payload of this message to be the specified byte array.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#setQos-int-">setQos</a></span>(int&nbsp;qos)</code>
<div class="block">Sets the quality of service for this message.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#setRetained-boolean-">setRetained</a></span>(boolean&nbsp;retained)</code>
<div class="block">Whether or not the publish message should be retained by the messaging engine.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#toString--">toString</a></span>()</code>
<div class="block">Returns a string representation of this message's payload.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#validateQos-int-">validateQos</a></span>(int&nbsp;qos)</code>
<div class="block">Utility method to validate the supplied QoS value.</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.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="MqttMessage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MqttMessage</h4>
<pre>public&nbsp;MqttMessage()</pre>
<div class="block">Constructs a message with an empty payload, and all other values
set to defaults.
The defaults are:
<ul>
<li>Message QoS set to 1</li>
<li>Message will not be "retained" by the server</li>
</ul></div>
</li>
</ul>
<a name="MqttMessage-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MqttMessage</h4>
<pre>public&nbsp;MqttMessage(byte[]&nbsp;payload)</pre>
<div class="block">Constructs a message with the specified byte array as a payload,
and all other values set to defaults.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="validateQos-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateQos</h4>
<pre>public static&nbsp;void&nbsp;validateQos(int&nbsp;qos)</pre>
<div class="block">Utility method to validate the supplied QoS value.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if value of QoS is not 0, 1 or 2.</dd>
</dl>
</li>
</ul>
<a name="getPayload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPayload</h4>
<pre>public&nbsp;byte[]&nbsp;getPayload()</pre>
<div class="block">Returns the payload as a byte array.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the payload as a byte array.</dd>
</dl>
</li>
</ul>
<a name="clearPayload--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearPayload</h4>
<pre>public&nbsp;void&nbsp;clearPayload()</pre>
<div class="block">Clears the payload, resetting it to be empty.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this message cannot be edited</dd>
</dl>
</li>
</ul>
<a name="setPayload-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPayload</h4>
<pre>public&nbsp;void&nbsp;setPayload(byte[]&nbsp;payload)</pre>
<div class="block">Sets the payload of this message to be the specified byte array.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>payload</code> - the payload for this message.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this message cannot be edited</dd>
<dd><code>java.lang.NullPointerException</code> - if no payload is provided</dd>
</dl>
</li>
</ul>
<a name="isRetained--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRetained</h4>
<pre>public&nbsp;boolean&nbsp;isRetained()</pre>
<div class="block">Returns whether or not this message should be/was retained by the server.
For messages received from the server, this method returns whether or not
the message was from a current publisher, or was "retained" by the server as
the last message published on the topic.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message should be, or was, retained by
the server.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#setRetained-boolean-"><code>setRetained(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setRetained-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRetained</h4>
<pre>public&nbsp;void&nbsp;setRetained(boolean&nbsp;retained)</pre>
<div class="block">Whether or not the publish message should be retained by the messaging engine.
Sending a message with retained set to <code>true</code> and with an empty
byte array as the payload e.g. <code>new byte[0]</code> will clear the
retained message from the server. The default value is <code>false</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>retained</code> - whether or not the messaging engine should retain the message.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this message cannot be edited</dd>
</dl>
</li>
</ul>
<a name="getQos--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQos</h4>
<pre>public&nbsp;int&nbsp;getQos()</pre>
<div class="block">Returns the quality of service for this message.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the quality of service to use, either 0, 1, or 2.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttMessage.html#setQos-int-"><code>setQos(int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setQos-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQos</h4>
<pre>public&nbsp;void&nbsp;setQos(int&nbsp;qos)</pre>
<div class="block">Sets the quality of service for this message.
<ul>
<li>Quality of Service 0 - indicates that a message should
be delivered at most once (zero or one times). The message will not be persisted to disk,
and will not be acknowledged across the network. This QoS is the fastest,
but should only be used for messages which are not valuable - note that
if the server cannot process the message (for example, there
is an authorization problem), then an
<a href="../../../../../org/eclipse/paho/client/mqttv3/MqttCallback.html#deliveryComplete-org.eclipse.paho.client.mqttv3.IMqttDeliveryToken-"><code>MqttCallback.deliveryComplete(IMqttDeliveryToken)</code></a>.
Also known as "fire and forget".</li>
<li>Quality of Service 1 - indicates that a message should
be delivered at least once (one or more times). The message can only be delivered safely if
it can be persisted, so the application must supply a means of
persistence using <code>MqttConnectOptions</code>.
If a persistence mechanism is not specified, the message will not be
delivered in the event of a client failure.
The message will be acknowledged across the network.
This is the default QoS.</li>
<li>Quality of Service 2 - indicates that a message should
be delivered once. The message will be persisted to disk, and will
be subject to a two-phase acknowledgement across the network.
The message can only be delivered safely if
it can be persisted, so the application must supply a means of
persistence using <code>MqttConnectOptions</code>.
If a persistence mechanism is not specified, the message will not be
delivered in the event of a client failure.</li>
If persistence is not configured, QoS 1 and 2 messages will still be delivered
in the event of a network or server problem as the client will hold state in memory.
If the MQTT client is shutdown or fails and persistence is not configured then
delivery of QoS 1 and 2 messages can not be maintained as client-side state will
be lost.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>qos</code> - the "quality of service" to use. Set to 0, 1, 2.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if value of QoS is not 0, 1 or 2.</dd>
<dd><code>java.lang.IllegalStateException</code> - if this message cannot be edited</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block">Returns a string representation of this message's payload.
Makes an attempt to return the payload as a string. As the
MQTT client has no control over the content of the payload
it may fail.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string representation of this message.</dd>
</dl>
</li>
</ul>
<a name="isDuplicate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDuplicate</h4>
<pre>public&nbsp;boolean&nbsp;isDuplicate()</pre>
<div class="block">Returns whether or not this message might be a duplicate of one which has
already been received. This will only be set on messages received from
the server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the message might be a duplicate.</dd>
</dl>
</li>
</ul>
<a name="setId-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setId</h4>
<pre>public&nbsp;void&nbsp;setId(int&nbsp;messageId)</pre>
<div class="block">This is only to be used internally to provide the MQTT id of a message
received from the server. Has no effect when publishing messages.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageId</code> - </dd>
</dl>
</li>
</ul>
<a name="getId--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;int&nbsp;getId()</pre>
<div class="block">Returns the MQTT id of the message. This is only applicable to messages
received from the server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MQTT id of the message</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MqttMessage.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-files/index-1.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/eclipse/paho/client/mqttv3/MqttException.html" title="class in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/paho/client/mqttv3/MqttPersistable.html" title="interface in org.eclipse.paho.client.mqttv3"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/paho/client/mqttv3/MqttMessage.html" target="_top">Frames</a></li>
<li><a href="MqttMessage.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>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 ======= -->
</body>
</html>