Modifier and Type	Class and Description
protected abstract static class	BaseOptions.Hidden
public static enum	BaseOptions.ModularityMismatchPolicy An enum of policies for handling modularity mismatches in external documentation.
protected abstract static class	BaseOptions.Option
protected abstract static class	BaseOptions.XOption

Field Summary

Modifier and Type	Field and Description
private boolean	allowScriptInComments Argument for command-line option `--allow-script-in-comments`.
private final BaseConfiguration	config
private ZonedDateTime	date Argument for command-line option `--date`.
public static final int	DEFAULT_TAB_STOP_LENGTH The default amount of space between tab stops.
private String	destDirName Argument for command-line option `-d`.
private boolean	disableJavaFxStrictChecks Argument for command-line option `--disable-javafx-strict-checks`.
private String	docEncoding Argument for command-line option `-docencoding`.
private String	docFileDestDirName Argument for command-line option `???`
private boolean	dumpOnError Argument for hidden command-line option `--dump-on-error`.
private String	encoding Argument for command-line option `-encoding`.
private Set<String>	excludedDocFileDirs Argument for command-line option `-excludedocfilessubdir`.
private Set<String>	excludedQualifiers Argument for command-line option `-noqualifier`.
private List<Utils.Pair<String, String>>	groupPairs Arguments for command-line option `-group`
private boolean	javafx Argument for command-line option `--javafx` or `-javafx`.
private boolean	keywords Argument for command-line option `-keywords`.
private final List<String>	linkList Arguments for command-line option `-link`.
private BaseOptions.ModularityMismatchPolicy	linkModularityMismatch Argument for command-line option `--link-modularity-mismatch`.
private final List<Utils.Pair<String, String>>	linkOfflineList Arguments for command-line option `-linkoffline`.
private String	linkPlatformProperties Location of alternative platform link properties file.
private boolean	linkSource Argument for command-line option `-linksource`.
private boolean	noComment Argument for command-line option `-nocomment`.
private boolean	noDeprecated Argument for command-line option `-nodeprecated`.
private boolean	noFonts Argument for command-line option `--no-fonts`.
private boolean	noPlatformLinks Argument for command-line option `--no-platform-links`.
private boolean	noSince Argument for command-line option `-nosince`.
private boolean	noTimestamp Argument for command-line option `-notimestamp`.
private String	previewFeatureTag Argument for command-line option `--preview-feature-tag`.
private String	previewNoteTag Argument for command-line option `--preview-note-tag`.
private boolean	quiet Argument for command-line option `-quiet`.
private boolean	serialWarn Argument for command-line option `-serialwarn`.
private boolean	showAuthor Argument for command-line option `-author`.
private boolean	showVersion Argument for command-line option `-version`.
private List<String>	since Argument for command line option `--since`.
private String	sinceLabel Argument for command line option `--since-label`.
private int	sourceTabSize Argument for command-line option `-sourcetab`.
private URI	specBaseURI Argument for command-line option `--spec-base-url`.
private boolean	summarizeOverriddenMethods Value for command-line option `--override-methods summary` or `--override-methods detail`.

Constructor Summary

Access	Constructor and Description
protected	BaseOptions(BaseConfiguration config)

Method Summary

Modifier and Type	Method and Description
protected static String	Returns: String Properly constructed path string. addTrailingFileSep(String Path under consideration. path) Add a trailing file separator, if not found.
pack-priv boolean	allowScriptInComments() Argument for command-line option `--allow-script-in-comments`.
private boolean	checkOutputFileEncoding(String output file encoding. docencoding) Check the validity of the given Source or Output File encoding on this platform.
public ZonedDateTime	date() Argument for command-line option `--date`.
pack-priv String	destDirName() Argument for command-line option `-d`.
pack-priv boolean	disableJavaFxStrictChecks() Argument for command-line option `--disable-javafx-strict-checks`.
public String	docEncoding() Argument for command-line option `-docencoding`.
pack-priv String	docFileDestDirName() Argument for command-line option `???`
pack-priv boolean	dumpOnError() Argument for hidden command-line option `--dump-on-error`.
public String	encoding() Argument for command-line option `-encoding`.
pack-priv Set<String>	excludedDocFileDirs() Argument for command-line option `-excludedocfilessubdir`.
pack-priv Set<String>	excludedQualifiers() Argument for command-line option `-noqualifier`.
protected boolean	Returns: true if all the options are valid. generalValidOptions() This checks for the validity of the options used by the user.
public Set<? extends BaseOptions.Option>	getSupportedOptions()
pack-priv List<Utils.Pair<String, String>>	groupPairs() Arguments for command-line option `-group`
public boolean	javafx() Argument for command-line option `--javafx` or `-javafx`.
public boolean	keywords() Argument for command-line option `-keywords`.
pack-priv List<String>	linkList() Arguments for command-line option `-link`.
public BaseOptions.ModularityMismatchPolicy	linkModularityMismatch() Argument for command-line option `--link-modularity-mismatch`.
pack-priv List<Utils.Pair<String, String>>	linkOfflineList() Arguments for command-line option `-linkoffline`.
pack-priv String	linkPlatformProperties() Argument for command-line option `--link-platform-properties`.
public boolean	linkSource() Argument for command-line option `-linksource`.
public boolean	noComment() Argument for command-line option `-nocomment`.
public boolean	noDeprecated() Argument for command-line option `-nodeprecated`.
public boolean	noFonts() Argument for command-line option `--no-fonts`.
public boolean	noPlatformLinks() Argument for command-line option `--no-platform-links`.
public boolean	noSince() Argument for command-line option `-nosince`.
public boolean	noTimestamp() Argument for command-line option `-notimestamp`.
public String	previewFeatureTag() Argument for command-line option `--preview-feature-tag`.
public String	previewNoteTag() Argument for command-line option `--preview-note-tag`.
pack-priv boolean	quiet() Argument for command-line option `-quiet`.
public boolean	serialWarn() Argument for command-line option `-serialwarn`.
public void	setDocEncoding(String docEncoding)
public void	setJavaFX(boolean javafx)
public boolean	showAuthor() Argument for command-line option `-author`.
public boolean	showVersion() Argument for command-line option `-version`.
public List<String>	since() Arguments for command line option `--since`.
public String	sinceLabel() Arguments for command line option `--since-label`.
public int	sourceTabSize() Argument for command-line option `-sourcetab`.
public URI	specBaseURI() Argument for command-line option `--spec-base-url`.
public boolean	summarizeOverriddenMethods() Value for command-line option `--override-methods summary` or `--override-methods detail`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowScriptInComments	back to summary
private boolean allowScriptInComments Argument for command-line option `--allow-script-in-comments`. Allow JavaScript in doc comments.

config	back to summary
private final BaseConfiguration config

date	back to summary
private ZonedDateTime date Argument for command-line option `--date`. `null` if option not given.

DEFAULT_TAB_STOP_LENGTH	back to summary
public static final int DEFAULT_TAB_STOP_LENGTH The default amount of space between tab stops.

destDirName	back to summary
private String destDirName Argument for command-line option `-d`. Destination directory name, in which doclet will generate the entire documentation. Default is current directory.

disableJavaFxStrictChecks	back to summary
private boolean disableJavaFxStrictChecks Argument for command-line option `--disable-javafx-strict-checks`. Primarily used to disable strict checks in the regression tests allowing those tests to be executed successfully, for instance, with OpenJDK builds which may not contain FX libraries.

docEncoding	back to summary
private String docEncoding Argument for command-line option `-docencoding`. Encoding for this document. Default is default encoding for this platform.

docFileDestDirName	back to summary
private String docFileDestDirName Argument for command-line option `???`. Destination directory name, in which doclet will copy the doc-files to.

dumpOnError	back to summary
private boolean dumpOnError Argument for hidden command-line option `--dump-on-error`.

encoding	back to summary
private String encoding Argument for command-line option `-encoding`. Encoding for this document. Default is default encoding for this platform.

excludedDocFileDirs	back to summary
private Set<String> excludedDocFileDirs Argument for command-line option `-excludedocfilessubdir`. The set of doc-file subdirectories to exclude.

excludedQualifiers	back to summary
private Set<String> excludedQualifiers Argument for command-line option `-noqualifier`. The set of qualifiers to exclude.

groupPairs	back to summary
private List<Utils.Pair<String, String>> groupPairs Arguments for command-line option `-group`

javafx	back to summary
private boolean javafx Argument for command-line option `--javafx` or `-javafx`. Generate documentation for JavaFX getters and setters automatically by copying it from the appropriate property definition.

keywords	back to summary
private boolean keywords Argument for command-line option `-keywords`. True if user wants to add member names as meta keywords. Set to false because meta keywords are ignored in general by most Internet search engines.

linkList	back to summary
private final List<String> linkList Arguments for command-line option `-link`.

linkModularityMismatch	back to summary
private BaseOptions.ModularityMismatchPolicy linkModularityMismatch Argument for command-line option `--link-modularity-mismatch`. Describes how to handle external documentation with non-matching modularity.

linkOfflineList	back to summary
private final List<Utils.Pair<String, String>> linkOfflineList Arguments for command-line option `-linkoffline`.

linkPlatformProperties	back to summary
private String linkPlatformProperties Location of alternative platform link properties file.

linkSource	back to summary
private boolean linkSource Argument for command-line option `-linksource`. True if we should generate browsable sources.

noComment	back to summary
private boolean noComment Argument for command-line option `-nocomment`. True if user wants to suppress descriptions and tags.

noDeprecated	back to summary
private boolean noDeprecated Argument for command-line option `-nodeprecated`. Don't generate deprecated API information at all, if -nodeprecated option is used. `nodeprecated` is set to true if -nodeprecated option is used. Default is generate deprecated API information.

noFonts	back to summary
private boolean noFonts Argument for command-line option `--no-fonts`. True if command-line option `--no-fonts` is used and font files should not be included in generated documentation. Default value is false.

noPlatformLinks	back to summary
private boolean noPlatformLinks Argument for command-line option `--no-platform-links`. True if command-line option "--no-platform-links" is used. Default value is false.

noSince	back to summary
private boolean noSince Argument for command-line option `-nosince`. True if command-line option "-nosince" is used. Default value is false.

noTimestamp	back to summary
private boolean noTimestamp Argument for command-line option `-notimestamp`. True if user wants to suppress time stamp in output. Default is false.

previewFeatureTag	back to summary
private String previewFeatureTag Argument for command-line option `--preview-feature-tag`. If set, the JavaDoc inline tag with the given name is used to add mark an API element as preview feature in non-JDK contexts.

previewNoteTag	back to summary
private String previewNoteTag Argument for command-line option `--preview-note-tag`. If set, the JavaDoc tag with the given name can be used to add preview-related notes to permanent APIs or override the default preview note for preview APIs.

quiet	back to summary
private boolean quiet Argument for command-line option `-quiet`. Suppress all messages

serialWarn	back to summary
private boolean serialWarn Argument for command-line option `-serialwarn`. This is true if option "-serialwarn" is used. Default value is false to suppress excessive warnings about serial tag.

showAuthor	back to summary
private boolean showAuthor Argument for command-line option `-author`. Generate author specific information for all the classes if @author tag is used in the doc comment and if -author option is used. `showauthor` is set to true if -author option is used. Default is don't show author information.

showVersion	back to summary
private boolean showVersion Argument for command-line option `-version`. Generate version specific information for the all the classes if @version tag is used in the doc comment and if -version option is used. `showVersion` is set to true if -version option is used. Default is don't show version information.

since	back to summary
private List<String> since Argument for command line option `--since`. Specifies a list of release names for which to document API changes.

sinceLabel	back to summary
private String sinceLabel Argument for command line option `--since-label`. Specifies custom text to use as heading of New API page.

sourceTabSize	back to summary
private int sourceTabSize Argument for command-line option `-sourcetab`. The specified amount of space between tab stops.

specBaseURI	back to summary
private URI specBaseURI Argument for command-line option `--spec-base-url`. The base URL for relative URLs in `@spec` tags.

summarizeOverriddenMethods	back to summary
private boolean summarizeOverriddenMethods Value for command-line option `--override-methods summary` or `--override-methods detail`. Specifies whether those methods that override a supertype's method with no changes to the API contract should be summarized in the footnote section.

Constructor Detail

BaseOptions	back to summary
protected BaseOptions(BaseConfiguration config)

Method Detail

addTrailingFileSep	back to summary
protected static String addTrailingFileSep(String path) Add a trailing file separator, if not found. Remove superfluous file separators if any. Preserve the front double file separator for UNC paths. Parameters path:String Path under consideration. Returns:String String Properly constructed path string.

addTrailingFileSep

back to summary

protected static String addTrailingFileSep(String path)

Add a trailing file separator, if not found. Remove superfluous file separators if any. Preserve the front double file separator for UNC paths.

Parameters

path:String: Path under consideration.

Returns:String

String Properly constructed path string.

allowScriptInComments	back to summary
pack-priv boolean allowScriptInComments() Argument for command-line option `--allow-script-in-comments`. Allow JavaScript in doc comments.

checkOutputFileEncoding	back to summary
private boolean checkOutputFileEncoding(String docencoding) Check the validity of the given Source or Output File encoding on this platform. Parameters docencoding:String output file encoding.

checkOutputFileEncoding

back to summary

private boolean checkOutputFileEncoding(String docencoding)

Check the validity of the given Source or Output File encoding on this platform.

Parameters

docencoding:String: output file encoding.

date	back to summary
public ZonedDateTime date() Argument for command-line option `--date`.

destDirName	back to summary
pack-priv String destDirName() Argument for command-line option `-d`. Destination directory name, in which doclet will generate the entire documentation. Default is current directory.

disableJavaFxStrictChecks	back to summary
pack-priv boolean disableJavaFxStrictChecks() Argument for command-line option `--disable-javafx-strict-checks`. Primarily used to disable strict checks in the regression tests allowing those tests to be executed successfully, for instance, with OpenJDK builds which may not contain FX libraries.

docEncoding	back to summary
public String docEncoding() Argument for command-line option `-docencoding`. Encoding for this document. Default is default encoding for this platform.

docFileDestDirName	back to summary
pack-priv String docFileDestDirName() Argument for command-line option `???`. Destination directory name, in which doclet will copy the doc-files to.

dumpOnError	back to summary
pack-priv boolean dumpOnError() Argument for hidden command-line option `--dump-on-error`.

encoding	back to summary
public String encoding() Argument for command-line option `-encoding`. Encoding for this document. Default is default encoding for this platform.

excludedDocFileDirs	back to summary
pack-priv Set<String> excludedDocFileDirs() Argument for command-line option `-excludedocfilessubdir`. The set of doc-file subdirectories to exclude.

excludedQualifiers	back to summary
pack-priv Set<String> excludedQualifiers() Argument for command-line option `-noqualifier`. The set of qualifiers to exclude.

generalValidOptions

back to summary

protected boolean generalValidOptions()

This checks for the validity of the options used by the user. As of this writing, this checks only docencoding.

Returns:boolean: true if all the options are valid.

getSupportedOptions	back to summary
public Set<? extends BaseOptions.Option> getSupportedOptions()

groupPairs	back to summary
pack-priv List<Utils.Pair<String, String>> groupPairs() Arguments for command-line option `-group`

javafx	back to summary
public boolean javafx() Argument for command-line option `--javafx` or `-javafx`. Generate documentation for JavaFX getters and setters automatically by copying it from the appropriate property definition.

keywords	back to summary
public boolean keywords() Argument for command-line option `-keywords`. True if user wants to add member names as meta keywords. Set to false because meta keywords are ignored in general by most Internet search engines.

linkList	back to summary
pack-priv List<String> linkList() Arguments for command-line option `-link`.

linkModularityMismatch	back to summary
public BaseOptions.ModularityMismatchPolicy linkModularityMismatch() Argument for command-line option `--link-modularity-mismatch`. Describes how to handle external documentation with non-matching modularity.

linkOfflineList	back to summary
pack-priv List<Utils.Pair<String, String>> linkOfflineList() Arguments for command-line option `-linkoffline`.

linkPlatformProperties	back to summary
pack-priv String linkPlatformProperties() Argument for command-line option `--link-platform-properties`.

linkSource	back to summary
public boolean linkSource() Argument for command-line option `-linksource`. True if we should generate browsable sources.

noComment	back to summary
public boolean noComment() Argument for command-line option `-nocomment`. True if user wants to suppress descriptions and tags.

noDeprecated	back to summary
public boolean noDeprecated() Argument for command-line option `-nodeprecated`. Don't generate deprecated API information at all if -nodeprecated option is used. `noDeprecated` is set to `true` if `-nodeprecated` option is used. Default is generate deprecated API information.

noFonts	back to summary
public boolean noFonts() Argument for command-line option `--no-fonts`. True if command-line option `--no-fonts"` is used. Default value is false.

noPlatformLinks	back to summary
public boolean noPlatformLinks() Argument for command-line option `--no-platform-links`. True if command-line option `--no-platform-links"` is used. Default value is false.

noSince	back to summary
public boolean noSince() Argument for command-line option `-nosince`. True if command-line option `-nosince"` is used. Default value is false.

noTimestamp	back to summary
public boolean noTimestamp() Argument for command-line option `-notimestamp`. True if user wants to suppress time stamp in output. Default is false.

previewFeatureTag	back to summary
public String previewFeatureTag() Argument for command-line option `--preview-feature-tag`. Name of inline tag for marking APIs as preview feature.

previewNoteTag	back to summary
public String previewNoteTag() Argument for command-line option `--preview-note-tag`. Name of inline tag for preview notes on permanent APIs.

quiet	back to summary
pack-priv boolean quiet() Argument for command-line option `-quiet`. Suppress all messages

serialWarn	back to summary
public boolean serialWarn() Argument for command-line option `-serialwarn`. This is true if option "-serialwarn" is used. Default value is false to suppress excessive warnings about serial tag.

setDocEncoding	back to summary
public void setDocEncoding(String docEncoding)

setJavaFX	back to summary
public void setJavaFX(boolean javafx)

showAuthor	back to summary
public boolean showAuthor() Argument for command-line option `-author`. Generate author specific information for all the classes if @author tag is used in the doc comment and if -author option is used. `showauthor` is set to true if -author option is used. Default is to not show author information.

showVersion	back to summary
public boolean showVersion() Argument for command-line option `-version`. Generate version specific information for the all the classes if @version tag is used in the doc comment and if -version option is used. `showVersion` is set to true if -version option is used. Default is don't show version information.

since	back to summary
public List<String> since() Arguments for command line option `--since`.

sinceLabel	back to summary
public String sinceLabel() Arguments for command line option `--since-label`.

sourceTabSize	back to summary
public int sourceTabSize() Argument for command-line option `-sourcetab`. The specified amount of space between tab stops.

specBaseURI	back to summary
public URI specBaseURI() Argument for command-line option `--spec-base-url`. The base URL for relative URLs in `@spec` tags.

summarizeOverriddenMethods	back to summary
public boolean summarizeOverriddenMethods() Value for command-line option `--override-methods summary` or `--override-methods detail`. Specifies whether those methods that override a supertype's method with no changes to the API contract should be summarized in the footnote section.

jdk.javadoc.internal.doclets.toolkit back to summary

protected abstract Class BaseOptions.Hidden

Class Inheritance

extends Option

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.BaseOptions.Option
jdk.javadoc.internal.doclets.toolkit.BaseOptions.Hidden

Constructor Summary

Access	Constructor and Description
public	Hidden(Resources resources, String name, int argCount)
public	Hidden(Resources resources, String name)

Method Summary

Modifier and Type	Method and Description
public Doclet.Option.Kind	getKind() Overrides jdk.javadoc.internal.doclets.toolkit.BaseOptions.Option.getKind. Implements jdk.javadoc.doclet.Doclet.Option.getKind. Returns the option kind.

Inherited from jdk.javadoc.internal.doclets.toolkit.BaseOptions.Option:: compareTo getArgumentCount getDescription getNames getParameters matches toString

Constructor Detail

Hidden	back to summary
public Hidden(Resources resources, String name, int argCount)

Hidden	back to summary
public Hidden(Resources resources, String name)

Method Detail

getKind

back to summary

public Doclet.Option.Kind getKind()

Overrides jdk.javadoc.internal.doclets.toolkit.BaseOptions.Option.getKind.

Implements jdk.javadoc.doclet.Doclet.Option.getKind.

Doc from jdk.javadoc.doclet.Doclet.Option.getKind.

Returns the option kind.

Annotations

@Override

jdk.javadoc.internal.doclets.toolkit back to summary

public final Enum BaseOptions.ModularityMismatchPolicy

Class Inheritance

extends Enum<BaseOptions.ModularityMismatchPolicy>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.doclets.toolkit.BaseOptions.ModularityMismatchPolicy

An enum of policies for handling modularity mismatches in external documentation.

Field Summary

Modifier and Type	Field and Description
public static final BaseOptions.ModularityMismatchPolicy	INFO
public static final BaseOptions.ModularityMismatchPolicy	WARN

Constructor Summary

Access	Constructor and Description
private	ModularityMismatchPolicy()

Method Summary

Modifier and Type	Method and Description
public static BaseOptions.ModularityMismatchPolicy	valueOf(String name)
public static BaseOptions.ModularityMismatchPolicy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

INFO	back to summary
public static final BaseOptions.ModularityMismatchPolicy INFO

WARN	back to summary
public static final BaseOptions.ModularityMismatchPolicy WARN

Constructor Detail

ModularityMismatchPolicy	back to summary
private ModularityMismatchPolicy()

Method Detail

valueOf	back to summary
public static BaseOptions.ModularityMismatchPolicy valueOf(String name)

values	back to summary
public static BaseOptions.ModularityMismatchPolicy[] values()

jdk.javadoc.internal.doclets.toolkit back to summary

protected abstract Class BaseOptions.Option

Class Inheritance

extends Object
implements Option, Comparable<BaseOptions.Option>

java.lang.Object
jdk.javadoc.internal.doclets.toolkit.BaseOptions.Option

All Implemented Interfaces

java.lang.Comparable, jdk.javadoc.doclet.Doclet.Option

Known Direct Subclasses

jdk.javadoc.internal.doclets.toolkit.BaseOptions.XOption, jdk.javadoc.internal.doclets.toolkit.BaseOptions.Hidden

Field Summary

Modifier and Type	Field and Description
private final int	argCount
private final String	description
private final String[]	names
private final String	parameters

Constructor Summary

Access	Constructor and Description
protected	Option(Resources resources, String name, int argCount)
protected	Option(Resources resources, String keyBase, String name, int argCount)
protected	Option(Resources resources, String name)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(BaseOptions.Option that) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public int	getArgumentCount() Implements jdk.javadoc.doclet.Doclet.Option.getArgumentCount. Returns the number of arguments, this option will consume.
public String	getDescription() Implements jdk.javadoc.doclet.Doclet.Option.getDescription. Returns the description of the option.
public Doclet.Option.Kind	getKind() Implements jdk.javadoc.doclet.Doclet.Option.getKind. Returns the option kind.
public List<String>	getNames() Implements jdk.javadoc.doclet.Doclet.Option.getNames. Returns the list of names that may be used to identify the option.
private String	getOptionsMessage(Resources resources, String key)
public String	getParameters() Implements jdk.javadoc.doclet.Doclet.Option.getParameters. Returns the parameters of the option.
public boolean	matches(String option)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

argCount	back to summary
private final int argCount

description	back to summary
private final String description

names	back to summary
private final String[] names

parameters	back to summary
private final String parameters

Constructor Detail

Option	back to summary
protected Option(Resources resources, String name, int argCount)

Option	back to summary
protected Option(Resources resources, String keyBase, String name, int argCount)

Option	back to summary
protected Option(Resources resources, String name)

Method Detail

compareTo back to summary

public int compareTo(BaseOptions.Option that)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

getArgumentCount

back to summary

public int getArgumentCount()

Implements jdk.javadoc.doclet.Doclet.Option.getArgumentCount.

Doc from jdk.javadoc.doclet.Doclet.Option.getArgumentCount.

Returns the number of arguments, this option will consume.

Annotations

@Override

getDescription

back to summary

public String getDescription()

Implements jdk.javadoc.doclet.Doclet.Option.getDescription.

Doc from jdk.javadoc.doclet.Doclet.Option.getDescription.

Returns the description of the option. For instance, the option "group", would return the synopsis of the option such as, "groups the documents".

Annotations

@Override

getKind

back to summary

public Doclet.Option.Kind getKind()

Implements jdk.javadoc.doclet.Doclet.Option.getKind.

Doc from jdk.javadoc.doclet.Doclet.Option.getKind.

Returns the option kind.

Annotations

@Override

getNames back to summary

public List<String> getNames()

Implements jdk.javadoc.doclet.Doclet.Option.getNames.

Doc from jdk.javadoc.doclet.Doclet.Option.getNames.

Returns the list of names that may be used to identify the option. For instance, the list could be ["-classpath", "--class-path"] for the option "-classpath", with an alias "--class-path".

Annotations

@Override

getOptionsMessage	back to summary
private String getOptionsMessage(Resources resources, String key)

getParameters

back to summary

public String getParameters()

Implements jdk.javadoc.doclet.Doclet.Option.getParameters.

Doc from jdk.javadoc.doclet.Doclet.Option.getParameters.

Returns the parameters of the option. For instance "name <p1>:<p2>.."

Annotations

@Override

matches	back to summary
public boolean matches(String option)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public abstract Class BaseOptions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected abstract Class BaseOptions.Hidden

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum BaseOptions.ModularityMismatchPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected abstract Class BaseOptions.Option

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected abstract Class BaseOptions.XOption

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Access	Constructor and Description
public	XOption(Resources resources, String prefix, String name, int argCount)
public	XOption(Resources resources, String name, int argCount)
public	XOption(Resources resources, String name)