~ubuntu-branches/ubuntu/utopic/gridengine/utopic

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.</BLOCKQUOTE>

<H3>

Package</H3>

<P>

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>

<LI>Interfaces (italic)<LI>Classes<LI>Exceptions<LI>Errors</UL>

</BLOCKQUOTE>

<H3>

Class/Interface</H3>

<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:<UL>

<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description

<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

<H3>

105

Tree (Class Hierarchy)</H3>

106

107

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>

108

<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>

109

</BLOCKQUOTE>

110

<H3>

111

Deprecated API</H3>

112

113

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>

114

<H3>

115

Index</H3>

116

117

The <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>

118

<H3>

119

Prev/Next</H3>

120

These links take you to the next or previous class, interface, package, or related page.<H3>

121

Frames/No Frames</H3>

122

These links show and hide the HTML frames. All pages are available with or without frames.

123

<P>

124

<H3>

125

Serialized Form</H3>

126

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.

127

<P>

128

129

<EM>

130

This help file applies to API documentation generated using the standard doclet.</EM>

131

</FONT>

132

<BR>

133

<HR>

134

135

136

137

138

139

140

<TR>

141

142

143

144

145

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>

146

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT> </TD>

147

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>

148

149

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>

150

<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>

151

152

</TR>

153

</TABLE>

154

</TD>

155

156

</EM>

157

</TD>

158

</TR>

159

160

<TR>

161

162

163

 NEXT</FONT></TD>

164

165

<A HREF="index.html" target="_top"><B>FRAMES</B></A>  

166

 <A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A>  

167

168

<!--

169

if(window==top) {

170

document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');

171

}

172

//-->

173

</SCRIPT>

174

175

<A HREF="allclasses-noframe.html"><B>All Classes</B></A>

176

</NOSCRIPT>

177

178

</FONT></TD>

179

</TR>

180

</TABLE>

181

182

183

184

<HR>

185

186

</BODY>

187

</HTML>

Older »