doc/jcc/documentation/javadoc/help-doc.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.6.0_26) on Mon Sep 19 20:31:31 PDT 2011 -->
   6 <TITLE>
   7 API Help
   8 </TITLE>
   9
  10 <META NAME="date" CONTENT="2011-09-19">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     if (location.href.indexOf('is-external=true') == -1) {
  18         parent.document.title="API Help";
  19     }
  20 }
  21 </SCRIPT>
  22 <NOSCRIPT>
  23 </NOSCRIPT>
  24
  25 </HEAD>
  26
  27 <BODY BGCOLOR="white" onload="windowTitle();">
  28 <HR>
  29
  30
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <A NAME="navbar_top"><!-- --></A>
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  35 <TR>
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  37 <A NAME="navbar_top_firstrow"><!-- --></A>
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  39   <TR ALIGN="center" VALIGN="top">
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="org/apache/jcc/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="org/apache/jcc/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  45   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
  46   </TR>
  47 </TABLE>
  48 </TD>
  49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  50 </EM>
  51 </TD>
  52 </TR>
  53
  54 <TR>
  55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  56 &nbsp;PREV&nbsp;
  57 &nbsp;NEXT</FONT></TD>
  58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59   <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  60 &nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  61 &nbsp;<SCRIPT type="text/javascript">
  62   <!--
  63   if(window==top) {
  64     document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
  65   }
  66   //-->
  67 </SCRIPT>
  68 <NOSCRIPT>
  69   <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
  70 </NOSCRIPT>
  71
  72
  73 </FONT></TD>
  74 </TR>
  75 </TABLE>
  76 <A NAME="skip-navbar_top"></A>
  77 <!-- ========= END OF TOP NAVBAR ========= -->
  78
  79 <HR>
  80 <CENTER>
  81 <H1>
  82 How This API Document Is Organized</H1>
  83 </CENTER>
  84 This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
  85 Package</H3>
  86 <BLOCKQUOTE>
  87
  88 <P>
  89 Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:<UL>
  90 <LI>Interfaces (italic)<LI>Classes<LI>Enums<LI>Exceptions<LI>Errors<LI>Annotation Types</UL>
  91 </BLOCKQUOTE>
  92 <H3>
  93 Class/Interface</H3>
  94 <BLOCKQUOTE>
  95
  96 <P>
  97 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:<UL>
  98 <LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
  99 <P>
 100 <LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
 101 <P>
 102 <LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
 103 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.</BLOCKQUOTE>
 104 </BLOCKQUOTE>
 105 <H3>
 106 Annotation Type</H3>
 107 <BLOCKQUOTE>
 108
 109 <P>
 110 Each annotation type has its own separate page with the following sections:<UL>
 111 <LI>Annotation Type declaration<LI>Annotation Type description<LI>Required Element Summary<LI>Optional Element Summary<LI>Element Detail</UL>
 112 </BLOCKQUOTE>
 113 </BLOCKQUOTE>
 114 <H3>
 115 Enum</H3>
 116 <BLOCKQUOTE>
 117
 118 <P>
 119 Each enum has its own separate page with the following sections:<UL>
 120 <LI>Enum declaration<LI>Enum description<LI>Enum Constant Summary<LI>Enum Constant Detail</UL>
 121 </BLOCKQUOTE>
 122 <H3>
 123 Tree (Class Hierarchy)</H3>
 124 <BLOCKQUOTE>
 125 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>.<UL>
 126 <LI>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.<LI>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</UL>
 127 </BLOCKQUOTE>
 128 <H3>
 129 Deprecated API</H3>
 130 <BLOCKQUOTE>
 131 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.</BLOCKQUOTE>
 132 <H3>
 133 Index</H3>
 134 <BLOCKQUOTE>
 135 The <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
 136 <H3>
 137 Prev/Next</H3>
 138 These links take you to the next or previous class, interface, package, or related page.<H3>
 139 Frames/No Frames</H3>
 140 These links show and hide the HTML frames.  All pages are available with or without frames.
 141 <P>
 142 <H3>
 143 Serialized Form</H3>
 144 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.
 145 <P>
 146 <H3>
 147 Constant Field Values</H3>
 148 The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.
 149 <P>
 150 <FONT SIZE="-1">
 151 <EM>
 152 This help file applies to API documentation generated using the standard doclet.</EM>
 153 </FONT>
 154 <BR>
 155 <HR>
 156
 157
 158 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 159 <A NAME="navbar_bottom"><!-- --></A>
 160 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 161 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 162 <TR>
 163 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 164 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 165 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 166   <TR ALIGN="center" VALIGN="top">
 167   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="org/apache/jcc/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 168   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
 169   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="org/apache/jcc/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 170   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 171   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 172   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
 173   </TR>
 174 </TABLE>
 175 </TD>
 176 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 177 </EM>
 178 </TD>
 179 </TR>
 180
 181 <TR>
 182 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 183 &nbsp;PREV&nbsp;
 184 &nbsp;NEXT</FONT></TD>
 185 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 186   <A HREF="index.html?help-doc.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 187 &nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 188 &nbsp;<SCRIPT type="text/javascript">
 189   <!--
 190   if(window==top) {
 191     document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
 192   }
 193   //-->
 194 </SCRIPT>
 195 <NOSCRIPT>
 196   <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
 197 </NOSCRIPT>
 198
 199
 200 </FONT></TD>
 201 </TR>
 202 </TABLE>
 203 <A NAME="skip-navbar_bottom"></A>
 204 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 205
 206 <HR>
 207
 208 </BODY>
 209 </HTML>