javaee-spec/javadocs/help-doc.html at master · javaee/javaee-spec

This repository was archived by the owner on Jan 30, 2019. It is now read-only.

History

231 lines (231 loc) · 8.96 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<head>

<title>API Help (Java(TM) EE 8 Specification APIs)</title>

</head>

<body>

try {

if (location.href.indexOf('is-external=true') == -1) {

parent.document.title="API Help (Java(TM) EE 8 Specification APIs)";

}

catch(err) {

}

//-->

</script>

<div>JavaScript is disabled on your browser.</div>

</noscript>

</a>

<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>

</a>

<li><a href="overview-summary.html">Overview</a></li>

<li>Package</li>

<li>Class</li>

<li><a href="deprecated-list.html">Deprecated</a></li>

<li><a href="index-all.html">Index</a></li>

</ul>

</div>

</ul>

<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>

<li><a href="help-doc.html" target="_top">No Frames</a></li>

</ul>

<li><a href="allclasses-noframe.html">All Classes</a></li>

</ul>

<div>

allClassesLink = document.getElementById("allclasses_navbar_top");

if(window==top) {

allClassesLink.style.display = "block";

}

else {

allClassesLink.style.display = "none";

}

//-->

</script>

</div>

</a></div>

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

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

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

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

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

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

<p>Each 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.</p>

</li>

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

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

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

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

</li>

<h2>Frames/No Frames</h2>

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

</li>

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

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

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

</a>

<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>

</a>

<li><a href="overview-summary.html">Overview</a></li>

<li>Package</li>

<li>Class</li>

<li><a href="deprecated-list.html">Deprecated</a></li>

<li><a href="index-all.html">Index</a></li>

</ul>

</div>

</ul>

<li><a href="index.html?help-doc.html" target="_top">Frames</a></li>

<li><a href="help-doc.html" target="_top">No Frames</a></li>

</ul>

<li><a href="allclasses-noframe.html">All Classes</a></li>

</ul>

<div>

allClassesLink = document.getElementById("allclasses_navbar_bottom");

if(window==top) {

allClassesLink.style.display = "block";

}

else {

allClassesLink.style.display = "none";

}

//-->

</script>

</div>

</a></div>

<p class="legalCopy"><small>Copyright © 1996-2017, <a href="http://www.oracle.com">Oracle</a> and/or its affiliates. All Rights Reserved. Use is subject to <a href="./doc-files/speclicense.html" target="_top">license terms</a>.</small></p>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

help-doc.html

Latest commit

History

help-doc.html

File metadata and controls