source: fedd/abac-src/rtml/doc/help-doc.html @ 8f32dc0

axis_examplecompt_changesinfo-opsversion-1.30version-2.00version-3.01version-3.02
Last change on this file since 8f32dc0 was 8780cbec, checked in by Jay Jacobs <Jay.Jacobs@…>, 15 years ago

ABAC sources from Cobham
  • Property mode set to 100644
File size: 8.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc on Wed Oct 02 14:28:00 PDT 2002 -->
6<TITLE>
7API Help ()
8</TITLE>
9<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
10</HEAD>
11<SCRIPT>
12function asd()
13{
14parent.document.title="API Help ()";
15}
16</SCRIPT>
17<BODY BGCOLOR="white" onload="asd();">
18
19<!-- ========== START OF NAVBAR ========== -->
20<A NAME="navbar_top"><!-- --></A>
21<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
22<TR>
23<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
24<A NAME="navbar_top_firstrow"><!-- --></A>
25<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
26  <TR ALIGN="center" VALIGN="top">
27  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
28  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
29  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
30  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
31  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
32  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
33  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
34  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
35  </TR>
36</TABLE>
37</TD>
38<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
39</EM>
40</TD>
41</TR>
42
43<TR>
44<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
45&nbsp;PREV&nbsp;
46&nbsp;NEXT</FONT></TD>
47<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
48  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
49&nbsp;<A HREF="help-doc.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
50&nbsp;
51<SCRIPT>
52  <!--
53  if(window==top) {
54    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
55  }
56  //-->
57</SCRIPT>
58<NOSCRIPT>
59<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
60</NOSCRIPT>
61</FONT></TD>
62</TR>
63</TABLE>
64<!-- =========== END OF NAVBAR =========== -->
65
66<HR>
67<CENTER>
68<H1>
69How This API Document Is Organized</H1>
70</CENTER>
71This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
72Overview</H3>
73<BLOCKQUOTE>
74
75<P>
76The <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.</BLOCKQUOTE>
77<H3>
78Package</H3>
79<BLOCKQUOTE>
80
81<P>
82Each 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>
83<LI>Interfaces (italic)<LI>Classes<LI>Exceptions<LI>Errors</UL>
84</BLOCKQUOTE>
85<H3>
86Class/Interface</H3>
87<BLOCKQUOTE>
88
89<P>
90Each 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>
91<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
92<P>
93<LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
94<P>
95<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
96Each 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>
97<H3>
98Use</H3>
99<BLOCKQUOTE>
100Each documented package, class and interface has its own Use page.  This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A.  You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</BLOCKQUOTE>
101<H3>
102Tree (Class Hierarchy)</H3>
103<BLOCKQUOTE>
104There 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>
105<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>
106</BLOCKQUOTE>
107<H3>
108Deprecated API</H3>
109<BLOCKQUOTE>
110The <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>
111<H3>
112Index</H3>
113<BLOCKQUOTE>
114The <A HREF="index-files/index-1.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
115<H3>
116Prev/Next</H3>
117These links take you to the next or previous class, interface, package, or related page.<H3>
118Frames/No Frames</H3>
119These links show and hide the HTML frames.  All pages are available with or without frames.
120<P>
121<H3>
122Serialized Form</H3>
123Each 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.
124<P>
125<FONT SIZE="-1">
126<EM>
127This help file applies to API documentation generated using the standard doclet.</EM>
128</FONT>
129<BR>
130<HR>
131
132<!-- ========== START OF NAVBAR ========== -->
133<A NAME="navbar_bottom"><!-- --></A>
134<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
135<TR>
136<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
137<A NAME="navbar_bottom_firstrow"><!-- --></A>
138<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
139  <TR ALIGN="center" VALIGN="top">
140  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
141  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
142  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
143  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
144  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
145  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
146  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
147  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
148  </TR>
149</TABLE>
150</TD>
151<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
152</EM>
153</TD>
154</TR>
155
156<TR>
157<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
158&nbsp;PREV&nbsp;
159&nbsp;NEXT</FONT></TD>
160<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
161  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
162&nbsp;<A HREF="help-doc.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
163&nbsp;
164<SCRIPT>
165  <!--
166  if(window==top) {
167    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
168  }
169  //-->
170</SCRIPT>
171<NOSCRIPT>
172<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
173</NOSCRIPT>
174</FONT></TD>
175</TR>
176</TABLE>
177<!-- =========== END OF NAVBAR =========== -->
178
179<HR>
180
181</BODY>
182</HTML>
Note: See TracBrowser for help on using the repository browser.