Also determine the length of the command-line option. For example, for a option "-header" there will be a string argument associated, then the the length of option "-header" is two. But for option "-nohelp" no argument is needed so it's length is 1.
Also do the error checking on the options used. For example it is illegal to use "-helpfile" option when already "-nohelp" option is used.
| Modifier and Type | Class and Description |
|---|---|
| public static enum | HtmlConfiguration.
Kinds of conditional pages. |
| public static record | HtmlConfiguration.
Record for JavaScript file and module flag. |
| Modifier and Type | Field and Description |
|---|---|
| private List | additionalScripts
List of additional JavaScript files |
| private ZonedDateTime | buildDate
The build date, to be recorded in generated files. |
| public final Set | conditionalPages
A set of values indicating which conditional pages should be generated. |
| private final Set | containingPackagesSeen
The set of packages for which we have copied the doc files. |
| public Contents | |
| protected DeprecatedAPIListBuilder | deprecatedAPIListBuilder
The collection of deprecated items, if any, to be displayed on the deprecated-list page, or null if the page should not be generated. |
| private final Runtime. | |
| public DocPaths | |
| public final Resources | |
| public static final String | HTML_DEFAULT_CHARSET
Default charset for HTML. |
| public HtmlIds | |
| public HtmlIndexBuilder | indexBuilder
The collections of items for the main index. |
| public Map | |
| public final Messages | |
| protected NewAPIBuilder | newAPIPageBuilder
The collection of new API items, if any, to be displayed on the new-list page, or null if the page should not be generated. |
| private final HtmlOptions | |
| protected PreviewAPIListBuilder | previewAPIListBuilder
The collection of preview items, if any, to be displayed on the preview-list page, or null if the page should not be generated. |
| protected RestrictedAPIListBuilder | restrictedAPIListBuilder
The collection of restricted methods, if any, to be displayed on the restricted-list page, or null if the page should not be generated. |
| public TagletManager | tagletManager
The taglet manager. |
| public DocPath | topFile
First file to appear in the right-hand frame in the generated documentation. |
| Access | Constructor and Description |
|---|---|
| public | HtmlConfiguration(Doclet
the doclet for this run of javadoc doclet, Locale the locale for the generated documentation locale, Reporter the reporter to use for console messages reporter)Constructs the full configuration needed by the doclet, including the format-specific part, defined in this class, and the format-independent part, defined in the supertype. |
| Modifier and Type | Method and Description |
|---|---|
| private HtmlConfiguration. | |
| public boolean | finishOptionSettings()
Implements abstract jdk. This method should be defined in all those doclets (configurations), which want to derive themselves from this BaseConfiguration. |
| protected boolean | |
| public List | |
| public List | |
| public ZonedDateTime | Returns: the date to be recorded in generated filesReturns the date to be recorded in generated files. |
| public Set | Returns: the packages for which we have copied the doc filesReturns the packages for which we have copied the doc files. |
| public Contents | Returns: a utility object providing commonly used fragments of contentReturns a utility object providing commonly used fragments of content. |
| public Runtime. | getDocletVersion()
Implements abstract jdk. Returns the version of the |
| public Resources | getDocResources()
Implements abstract jdk.
|
| public JavaFileManager | getFileManager()
Implements abstract jdk. Return the current file manager. |
| public Locale | getLocale()
Implements abstract jdk. Return the Locale for this document. |
| public DocPath | |
| public Messages | getMessages()
Implements abstract jdk.
|
| public HtmlOptions | |
| public JavaFileObject | Returns: the path of the overview file or null if it does not exist.Implements abstract jdk. Return the path of the overview file or null if it does not exist. |
| protected TypeElement | |
| public WriterFactory | |
| protected void | initConfiguration(DocletEnvironment docEnv, Function<String, String> resourceKeyMapper)
Overrides jdk.
|
| private void | initTagletManager(Set<List<String>>
the set two-dimensional arrays of strings. These arrays contain
either -tag or -taglet arguments. customTagStrs)Initialize the taglet manager. |
| protected void | setCreateOverview()
Generate "overview.html" page if option "-overview" is used or number of packages is more than one. |
| protected void | |
| private List |
| additionalScripts | back to summary |
|---|---|
| private List<HtmlConfiguration. List of additional JavaScript files | |
| buildDate | back to summary |
|---|---|
| private ZonedDateTime buildDate The build date, to be recorded in generated files. | |
| conditionalPages | back to summary |
|---|---|
| public final Set<HtmlConfiguration. A set of values indicating which conditional pages should be generated. The set is computed lazily, although values must (obviously) be set before they are required, such as when deciding whether to generate links to these files in the navigation bar, on each page, the help file, and so on. The value for any page may depend on both command-line options to enable or disable a page, and on content being found for the page, such as deprecated items to appear in the summary page of deprecated items. | |
| containingPackagesSeen | back to summary |
|---|---|
| private final Set<PackageElement> containingPackagesSeen The set of packages for which we have copied the doc files. | |
| contents | back to summary |
|---|---|
| public Contents contents | |
| deprecatedAPIListBuilder | back to summary |
|---|---|
| protected DeprecatedAPIListBuilder deprecatedAPIListBuilder The collection of deprecated items, if any, to be displayed on the deprecated-list page,
or null if the page should not be generated.
The page will not be generated if | |
| docletVersion | back to summary |
|---|---|
| private final Runtime. | |
| docPaths | back to summary |
|---|---|
| public DocPaths docPaths | |
| docResources | back to summary |
|---|---|
| public final Resources docResources | |
| HTML_DEFAULT_CHARSET | back to summary |
|---|---|
| public static final String HTML_DEFAULT_CHARSET Default charset for HTML. | |
| htmlIds | back to summary |
|---|---|
| public HtmlIds htmlIds | |
| indexBuilder | back to summary |
|---|---|
| public HtmlIndexBuilder indexBuilder The collections of items for the main index.
This field is only initialized if | |
| localStylesheetMap | back to summary |
|---|---|
| public Map<Element, List<DocPath>> localStylesheetMap | |
| messages | back to summary |
|---|---|
| public final Messages messages | |
| newAPIPageBuilder | back to summary |
|---|---|
| protected NewAPIBuilder newAPIPageBuilder The collection of new API items, if any, to be displayed on the new-list page,
or null if the page should not be generated.
The page is only generated if the | |
| options | back to summary |
|---|---|
| private final HtmlOptions options | |
| previewAPIListBuilder | back to summary |
|---|---|
| protected PreviewAPIListBuilder previewAPIListBuilder The collection of preview items, if any, to be displayed on the preview-list page, or null if the page should not be generated. The page will not be generated if there are no preview elements being documented. | |
| restrictedAPIListBuilder | back to summary |
|---|---|
| protected RestrictedAPIListBuilder restrictedAPIListBuilder The collection of restricted methods, if any, to be displayed on the restricted-list page, or null if the page should not be generated. The page will not be generated if there are no restricted methods to be documented. | |
| tagletManager | back to summary |
|---|---|
| public TagletManager tagletManager The taglet manager. | |
| topFile | back to summary |
|---|---|
| public DocPath topFile First file to appear in the right-hand frame in the generated documentation. | |
| HtmlConfiguration | back to summary |
|---|---|
| public HtmlConfiguration(Doclet doclet, Locale locale, Reporter reporter) Constructs the full configuration needed by the doclet, including the format-specific part, defined in this class, and the format-independent part, defined in the supertype. API Note The | |
| detectJSModule | back to summary |
|---|---|
| private HtmlConfiguration. | |
| finishOptionSettings | back to summary |
|---|---|
| public boolean finishOptionSettings() Implements abstract jdk. Doc from jdk. This method should be defined in all those doclets (configurations), which want to derive themselves from this BaseConfiguration. This method can be used to finish up the options setup.
| |
| finishOptionSettings0 | back to summary |
|---|---|
| protected boolean finishOptionSettings0() throws DocletException Overrides jdk.
| |
| getAdditionalScripts | back to summary |
|---|---|
| public List | |
| getAdditionalStylesheets | back to summary |
|---|---|
| public List | |
| getBuildDate | back to summary |
|---|---|
| public ZonedDateTime getBuildDate() Returns the date to be recorded in generated files.
| |
| getContainingPackagesSeen | back to summary |
|---|---|
| public Set Returns the packages for which we have copied the doc files.
| |
| getContents | back to summary |
|---|---|
| public Contents getContents() Returns a utility object providing commonly used fragments of content.
| |
| getDocletVersion | back to summary |
|---|---|
| public Runtime. Implements abstract jdk. Doc from jdk. Returns the version of the
| |
| getDocResources | back to summary |
|---|---|
| public Resources getDocResources() Implements abstract jdk.
| |
| getFileManager | back to summary |
|---|---|
| public JavaFileManager getFileManager() Implements abstract jdk. Doc from jdk. Return the current file manager.
| |
| getLocale | back to summary |
|---|---|
| public Locale getLocale() Implements abstract jdk. Doc from jdk. Return the Locale for this document.
| |
| getMainStylesheet | back to summary |
|---|---|
| public DocPath getMainStylesheet() | |
| getMessages | back to summary |
|---|---|
| public Messages getMessages() Implements abstract jdk.
| |
| getOptions | back to summary |
|---|---|
| public HtmlOptions getOptions() Implements abstract jdk.
| |
| getOverviewPath | back to summary |
|---|---|
| public JavaFileObject getOverviewPath() Implements abstract jdk. Return the path of the overview file or null if it does not exist.
| |
| getValidClass | back to summary |
|---|---|
| protected TypeElement getValidClass(List<TypeElement> classes) | |
| getWriterFactory | back to summary |
|---|---|
| public WriterFactory getWriterFactory() | |
| initConfiguration | back to summary |
|---|---|
| protected void initConfiguration(DocletEnvironment docEnv, Function<String, String> resourceKeyMapper) Overrides jdk.
| |
| initTagletManager | back to summary |
|---|---|
| private void initTagletManager(Set<List<String>> customTagStrs) Initialize the taglet manager. The strings to initialize the simple custom tags should be in the following format: "[tag name]:[location str]:[heading]". | |
| setCreateOverview | back to summary |
|---|---|
| protected void setCreateOverview() Generate "overview.html" page if option "-overview" is used or number of
packages is more than one. Sets | |
| setTopFile | back to summary |
|---|---|
| protected void setTopFile() Decide the page which will appear first in the right-hand frame. It will be "overview-summary.html" if "-overview" option is used or no "-overview" but the number of packages is more than one. It will be "package-summary.html" of the respective package if there is only one package to document. It will be a class page(first in the sorted order), if only classes are provided on the command line. | |
| tokenize | back to summary |
|---|---|
| private List Given a string, return an array of tokens, separated by ':'. The separator character can be escaped with the '\' character. The '\' character may also be escaped with the '\' character. | |
| Modifier and Type | Field and Description |
|---|---|
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. | |
| public static final HtmlConfiguration. |
| Access | Constructor and Description |
|---|---|
| private |
| Modifier and Type | Method and Description |
|---|---|
| public static HtmlConfiguration. | |
| public static HtmlConfiguration. |
| CONSTANT_VALUES | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| DEPRECATED | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| EXTERNAL_SPECS | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| NEW | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| PREVIEW | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| RESTRICTED | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| SEARCH_TAGS | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| SERIALIZED_FORM | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| SYSTEM_PROPERTIES | back to summary |
|---|---|
| public static final HtmlConfiguration. | |
| ConditionalPage | back to summary |
|---|---|
| private ConditionalPage() | |
| valueOf | back to summary |
|---|---|
| public static HtmlConfiguration. | |
| values | back to summary |
|---|---|
| public static HtmlConfiguration. | |
| Modifier and Type | Field and Description |
|---|---|
| private final boolean | isModule
Record Component accessed by isModule(). module flag |
| private final DocPath |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public final boolean | equals(Object o)
Implements abstract java. Indicates whether some other object is "equal to" this one. |
| public final int | |
| public boolean | |
| public DocPath | |
| public final String | toString()
Implements abstract java. Returns a string representation of the record. |
| isModule | back to summary |
|---|---|
| private final boolean isModule Record Component accessed by isModule(). module flag | |
| path | back to summary |
|---|---|
| private final DocPath path Record Component accessed by path(). file path | |
| JavaScriptFile | back to summary |
|---|---|
| public JavaScriptFile(DocPath path, boolean isModule) | |
| equals | back to summary |
|---|---|
| public final boolean equals(Object o) Implements abstract java. Doc from java. Indicates whether some other object is "equal to" this one. In addition
to the general contract of
R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
| |
| hashCode | back to summary |
|---|---|
| public final int hashCode() Implements abstract java. Doc from java. Returns a hash code value for the record.
Obeys the general contract of | |
| isModule | back to summary |
|---|---|
| public boolean isModule() Record Component getter of isModule.
| |
| path | back to summary |
|---|---|
| public DocPath path() Record Component getter of path.
| |
| toString | back to summary |
|---|---|
| public final String toString() Implements abstract java. Doc from java. Returns a string representation of the record.
In accordance with the general contract of In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves. | |