You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gearpump.apache.org by ma...@apache.org on 2016/08/12 04:30:41 UTC

[47/51] [partial] incubator-gearpump-site git commit: fix GEARPUMP-187 update site to 0.8.1

http://git-wip-us.apache.org/repos/asf/incubator-gearpump-site/blob/19769c76/releases/0.8.1/api/java/constant-values.html
----------------------------------------------------------------------
diff --git a/releases/0.8.1/api/java/constant-values.html b/releases/0.8.1/api/java/constant-values.html
new file mode 100644
index 0000000..6a4509f
--- /dev/null
+++ b/releases/0.8.1/api/java/constant-values.html
@@ -0,0 +1,277 @@
+<!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_25) on Thu Aug 11 09:54:17 PDT 2016 -->
+<title>Constant Field Values</title>
+<meta name="date" content="2016-08-11">
+<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="Constant Field Values";
+        }
+    }
+    catch(err) {
+    }
+//-->
+</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>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
+<li><a href="constant-values.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>
+<a name="skip.navbar.top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
+<h2 title="Contents">Contents</h2>
+<ul>
+<li><a href="#org.apache">org.apache.*</a></li>
+</ul>
+</div>
+<div class="constantValuesContainer"><a name="org.apache">
+<!--   -->
+</a>
+<h2 title="org.apache">org.apache.*</h2>
+<ul class="blockList">
+<li class="blockList">
+<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
+<caption><span>org.apache.gearpump.streaming.kafka.util.<a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html" title="class in org.apache.gearpump.streaming.kafka.util">KafkaConfig</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th scope="col">Constant Field</th>
+<th class="colLast" scope="col">Value</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.BOOTSTRAP_SERVERS_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#BOOTSTRAP_SERVERS_CONFIG">BOOTSTRAP_SERVERS_CONFIG</a></code></td>
+<td class="colLast"><code>"bootstrap.servers"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.BOOTSTRAP_SERVERS_DOC">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#BOOTSTRAP_SERVERS_DOC">BOOTSTRAP_SERVERS_DOC</a></code></td>
+<td class="colLast"><code>"A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. The client will make use of all servers irrespective of which servers are specified here for bootstrapping&amp;mdash;this list only impacts the initial hosts used to discover the full set of servers. This list should be in the form &lt;code&gt;host1:port1,host2:port2,...&lt;/code&gt;. Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down)."</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.CHECKPOINT_STORE_NAME_PREFIX_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#CHECKPOINT_STORE_NAME_PREFIX_CONFIG">CHECKPOINT_STORE_NAME_PREFIX_CONFIG</a></code></td>
+<td class="colLast"><code>"checkpoint.store.name.prefix"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.CHECKPOINT_STORE_NAME_PREFIX_DOC">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#CHECKPOINT_STORE_NAME_PREFIX_DOC">CHECKPOINT_STORE_NAME_PREFIX_DOC</a></code></td>
+<td class="colLast"><code>"Name prefix for checkpoint store whose name will be of the form, namePrefix-sourceTopic-partitionId"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.CLIENT_ID_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#CLIENT_ID_CONFIG">CLIENT_ID_CONFIG</a></code></td>
+<td class="colLast"><code>"client.id"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.CLIENT_ID_DOC">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#CLIENT_ID_DOC">CLIENT_ID_DOC</a></code></td>
+<td class="colLast"><code>"An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging."</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.CONSUMER_START_OFFSET_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#CONSUMER_START_OFFSET_CONFIG">CONSUMER_START_OFFSET_CONFIG</a></code></td>
+<td class="colLast"><code>"consumer.start.offset"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.ENABLE_AUTO_COMMIT_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#ENABLE_AUTO_COMMIT_CONFIG">ENABLE_AUTO_COMMIT_CONFIG</a></code></td>
+<td class="colLast"><code>"auto.commit.enable"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.ENABLE_AUTO_COMMIT_DOC">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#ENABLE_AUTO_COMMIT_DOC">ENABLE_AUTO_COMMIT_DOC</a></code></td>
+<td class="colLast"><code>"If true the consumer\'s offset will be periodically committed in the background."</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.FETCH_SLEEP_MS_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#FETCH_SLEEP_MS_CONFIG">FETCH_SLEEP_MS_CONFIG</a></code></td>
+<td class="colLast"><code>"fetch.sleep.ms"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.FETCH_THRESHOLD_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#FETCH_THRESHOLD_CONFIG">FETCH_THRESHOLD_CONFIG</a></code></td>
+<td class="colLast"><code>"fetch.threshold"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.GROUP_ID_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#GROUP_ID_CONFIG">GROUP_ID_CONFIG</a></code></td>
+<td class="colLast"><code>"group.id"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.GROUP_ID_DOC">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#GROUP_ID_DOC">GROUP_ID_DOC</a></code></td>
+<td class="colLast"><code>"A string that uniquely identifies a set of consumers within the same consumer group"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.MESSAGE_DECODER_CLASS_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#MESSAGE_DECODER_CLASS_CONFIG">MESSAGE_DECODER_CLASS_CONFIG</a></code></td>
+<td class="colLast"><code>"message.decoder.class"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.PARTITION_GROUPER_CLASS_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#PARTITION_GROUPER_CLASS_CONFIG">PARTITION_GROUPER_CLASS_CONFIG</a></code></td>
+<td class="colLast"><code>"partition.grouper"</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.REPLICATION_FACTOR_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#REPLICATION_FACTOR_CONFIG">REPLICATION_FACTOR_CONFIG</a></code></td>
+<td class="colLast"><code>"replication.factor"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.REPLICATION_FACTOR_DOC">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#REPLICATION_FACTOR_DOC">REPLICATION_FACTOR_DOC</a></code></td>
+<td class="colLast"><code>"The replication factor for checkpoint store topic."</code></td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.TIMESTAMP_FILTER_CLASS_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#TIMESTAMP_FILTER_CLASS_CONFIG">TIMESTAMP_FILTER_CLASS_CONFIG</a></code></td>
+<td class="colLast"><code>"timestamp.filter.class"</code></td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a name="org.apache.gearpump.streaming.kafka.util.KafkaConfig.ZOOKEEPER_CONNECT_CONFIG">
+<!--   -->
+</a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
+<td><code><a href="org/apache/gearpump/streaming/kafka/util/KafkaConfig.html#ZOOKEEPER_CONNECT_CONFIG">ZOOKEEPER_CONNECT_CONFIG</a></code></td>
+<td class="colLast"><code>"zookeeper.connect"</code></td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</div>
+<!-- ======= 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>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
+<li><a href="constant-values.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>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-gearpump-site/blob/19769c76/releases/0.8.1/api/java/deprecated-list.html
----------------------------------------------------------------------
diff --git a/releases/0.8.1/api/java/deprecated-list.html b/releases/0.8.1/api/java/deprecated-list.html
new file mode 100644
index 0000000..589f188
--- /dev/null
+++ b/releases/0.8.1/api/java/deprecated-list.html
@@ -0,0 +1,122 @@
+<!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_25) on Thu Aug 11 09:54:18 PDT 2016 -->
+<title>Deprecated List</title>
+<meta name="date" content="2016-08-11">
+<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="Deprecated List";
+        }
+    }
+    catch(err) {
+    }
+//-->
+</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>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li class="navBarCell1Rev">Deprecated</li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
+<li><a href="deprecated-list.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>
+<a name="skip.navbar.top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Deprecated API" class="title">Deprecated API</h1>
+<h2 title="Contents">Contents</h2>
+</div>
+<!-- ======= 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>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li class="navBarCell1Rev">Deprecated</li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
+<li><a href="deprecated-list.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>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>

http://git-wip-us.apache.org/repos/asf/incubator-gearpump-site/blob/19769c76/releases/0.8.1/api/java/help-doc.html
----------------------------------------------------------------------
diff --git a/releases/0.8.1/api/java/help-doc.html b/releases/0.8.1/api/java/help-doc.html
new file mode 100644
index 0000000..07b4489
--- /dev/null
+++ b/releases/0.8.1/api/java/help-doc.html
@@ -0,0 +1,223 @@
+<!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_25) on Thu Aug 11 09:54:18 PDT 2016 -->
+<title>API Help</title>
+<meta name="date" content="2016-08-11">
+<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="API Help";
+        }
+    }
+    catch(err) {
+    }
+//-->
+</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>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li class="navBarCell1Rev">Help</li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>
+<li><a href="help-doc.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>
+<a name="skip.navbar.top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 class="title">How This API Document Is Organized</h1>
+<div class="subTitle">This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.</div>
+</div>
+<div class="contentContainer">
+<ul class="blockList">
+<li class="blockList">
+<h2>Overview</h2>
+<p>The <a href="overview-summary.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each.  This page can also contain an overall description of the set of packages.</p>
+</li>
+<li class="blockList">
+<h2>Package</h2>
+<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:</p>
+<ul>
+<li>Interfaces (italic)</li>
+<li>Classes</li>
+<li>Enums</li>
+<li>Exceptions</li>
+<li>Errors</li>
+<li>Annotation Types</li>
+</ul>
+</li>
+<li class="blockList">
+<h2>Class/Interface</h2>
+<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p>
+<ul>
+<li>Class inheritance diagram</li>
+<li>Direct Subclasses</li>
+<li>All Known Subinterfaces</li>
+<li>All Known Implementing Classes</li>
+<li>Class/interface declaration</li>
+<li>Class/interface description</li>
+</ul>
+<ul>
+<li>Nested Class Summary</li>
+<li>Field Summary</li>
+<li>Constructor Summary</li>
+<li>Method Summary</li>
+</ul>
+<ul>
+<li>Field Detail</li>
+<li>Constructor Detail</li>
+<li>Method Detail</li>
+</ul>
+<p>Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p>
+</li>
+<li class="blockList">
+<h2>Annotation Type</h2>
+<p>Each annotation type has its own separate page with the following sections:</p>
+<ul>
+<li>Annotation Type declaration</li>
+<li>Annotation Type description</li>
+<li>Required Element Summary</li>
+<li>Optional Element Summary</li>
+<li>Element Detail</li>
+</ul>
+</li>
+<li class="blockList">
+<h2>Enum</h2>
+<p>Each enum has its own separate page with the following sections:</p>
+<ul>
+<li>Enum declaration</li>
+<li>Enum description</li>
+<li>Enum Constant Summary</li>
+<li>Enum Constant Detail</li>
+</ul>
+</li>
+<li class="blockList">
+<h2>Tree (Class Hierarchy)</h2>
+<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.</p>
+<ul>
+<li>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.</li>
+<li>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</li>
+</ul>
+</li>
+<li class="blockList">
+<h2>Deprecated API</h2>
+<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p>
+</li>
+<li class="blockList">
+<h2>Index</h2>
+<p>The <a href="index-all.html">Index</a> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</p>
+</li>
+<li class="blockList">
+<h2>Prev/Next</h2>
+<p>These links take you to the next or previous class, interface, package, or related page.</p>
+</li>
+<li class="blockList">
+<h2>Frames/No Frames</h2>
+<p>These links show and hide the HTML frames.  All pages are available with or without frames.</p>
+</li>
+<li class="blockList">
+<h2>All Classes</h2>
+<p>The <a href="allclasses-noframe.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p>
+</li>
+<li class="blockList">
+<h2>Serialized Form</h2>
+<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p>
+</li>
+<li class="blockList">
+<h2>Constant Field Values</h2>
+<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
+</li>
+</ul>
+<span class="emphasizedPhrase">This help file applies to API documentation generated using the standard doclet.</span></div>
+<!-- ======= 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>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li class="navBarCell1Rev">Help</li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>
+<li><a href="help-doc.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>
+<a name="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>