OpenJDK 27 · jdk.javadoc.internal.doclets.toolkit.BaseConfiguration

Modifier and Type	Class and Description
private static class	BaseConfiguration.Splitter

Field Summary

Modifier and Type	Field and Description
public CommentUtils	cmtUtils
public DocletEnvironment	docEnv The doclet environment.
public DocFileFactory	docFileFactory
public final Doclet	doclet The doclet that created this configuration.
protected DocLint	doclint
public Extern	extern The tracker of external package links.
public final Group	group The package grouping instance.
private Set<ModuleElement>	includedModuleElements
private Set<PackageElement>	includedPackageElements
private Set<TypeElement>	includedTypeElements
private boolean	initialized
public final Locale	locale
public MetaKeywords	metakeywords The meta tag keywords instance.
public SortedMap<ModuleElement, Set<PackageElement>>	modulePackages A sorted map, giving the (specified\|included\|other) packages for each module.
public SortedSet<ModuleElement>	modules The list of known modules, that should be documented.
public OverviewElement	overviewElement
public SortedSet<PackageElement>	packages A sorted set of included packages.
public PropertyUtils	propertyUtils
public final Reporter	reporter
protected static final String	sharedResourceBundleName
pack-priv Map<CompilationUnitTree, Boolean>	shouldCheck
public boolean	showModules Generate modules documentation if more than one module is present.
public String	sourcepath Sourcepath from where to read the source files.
private Set<ModuleElement>	specifiedModuleElements
private Set<PackageElement>	specifiedPackageElements
private Set<TypeElement>	specifiedTypeElements
public TypeElementCatalog	typeElementCatalog The catalog of classes specified on the command-line
public Utils	utils An utility class for commonly used helpers
private VisibleMemberCache	visibleMemberCache
public WorkArounds	workArounds All the temporary accessors to javac internals.

Constructor Summary

Access	Constructor and Description
public	BaseConfiguration(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 format-independent configuration needed by the doclet.

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: true if successful and false otherwise finishOptionSettings() This method should be defined in all those doclets (configurations), which want to derive themselves from this BaseConfiguration.
protected boolean	finishOptionSettings0()
public String	Returns: the class name getClassName(TypeElement the TypeElement to check. te) Return the qualified name of the Element if its qualifier is not excluded.
public abstract Runtime.Version	Returns: the version getDocletVersion() Returns the version of the `doclet`.
public abstract Resources	getDocResources()
public abstract JavaFileManager	Returns: JavaFileManager getFileManager() Return the current file manager.
public Set<ModuleElement>	getIncludedModuleElements()
public Set<PackageElement>	getIncludedPackageElements()
public Set<TypeElement>	getIncludedTypeElements()
public abstract Locale	Returns: the current locale getLocale() Return the Locale for this document.
public abstract Messages	getMessages()
public abstract BaseOptions	getOptions()
public abstract JavaFileObject	Returns: the path of the overview file. getOverviewPath() Return the path of the overview file and null if it does not exist.
public Reporter	getReporter()
public Set<ModuleElement>	getSpecifiedModuleElements()
public Set<PackageElement>	getSpecifiedPackageElements()
public Set<TypeElement>	getSpecifiedTypeElements()
public VisibleMemberTable	getVisibleMemberTable(TypeElement te)
protected void	initConfiguration(DocletEnvironment docEnv, Function<String, String> resourceKeyMapper)
private void	initDestDirectory()
public void	initDocLint(List<String> options for DocLint, derived from the corresponding doclet command-line options opts, Set<String> the names of custom tags, to be ignored by doclint customTagNames) Initializes DocLint, if appropriate, depending on options derived from the doclet command-line options, and the set of custom tags that should be ignored by DocLint.
private void	initModules()
private void	initPackages()
public boolean	Returns: the allowScriptInComments isAllowScriptInComments() Returns whether or not to allow JavaScript in comments.
private boolean	isDocLintGroupEnabled(Messages.Group group)
public boolean	isDocLintReferenceGroupEnabled()
public boolean	isDocLintSyntaxGroupEnabled()
public boolean	Returns: true if it is a generated doc. isGeneratedDoc(TypeElement the TypeElement for which the page generation is checked te) Return true if the TypeElement element is getting documented, depending upon -nodeprecated option and the deprecation information.
public boolean	Returns: true if JavaFX is available isJavaFXMode() Determines if JavaFX is available in the compilation environment.
public void	runDocLint(TreePath path)
public boolean	Returns: true if the options are set successfully setOptions() Set the command-line options supported by this configuration.
public boolean	Returns: true if the directory is excluded. shouldExcludeDocFileDir(String the doc-files subdirectory to check. docfilesubdir) Return true if the given doc-file subdirectory should be excluded and false otherwise.
public boolean	Returns: true if the qualifier should be excluded shouldExcludeQualifier(String the qualifier to check. qualifier) Return true if the given qualifier should be excluded and false otherwise.

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

Field Detail

cmtUtils	back to summary
public CommentUtils cmtUtils

docEnv	back to summary
public DocletEnvironment docEnv The doclet environment.

docFileFactory	back to summary
public DocFileFactory docFileFactory

doclet	back to summary
public final Doclet doclet The doclet that created this configuration.

doclint	back to summary
protected DocLint doclint

extern	back to summary
public Extern extern The tracker of external package links.

group	back to summary
public final Group group The package grouping instance.

includedModuleElements	back to summary
private Set<ModuleElement> includedModuleElements

includedPackageElements	back to summary
private Set<PackageElement> includedPackageElements

includedTypeElements	back to summary
private Set<TypeElement> includedTypeElements

initialized	back to summary
private boolean initialized

locale	back to summary
public final Locale locale

metakeywords	back to summary
public MetaKeywords metakeywords The meta tag keywords instance.

modulePackages	back to summary
public SortedMap<ModuleElement, Set<PackageElement>> modulePackages A sorted map, giving the (specified\|included\|other) packages for each module.

modules	back to summary
public SortedSet<ModuleElement> modules The list of known modules, that should be documented.

overviewElement	back to summary
public OverviewElement overviewElement

packages	back to summary
public SortedSet<PackageElement> packages A sorted set of included packages.

propertyUtils	back to summary
public PropertyUtils propertyUtils

reporter	back to summary
public final Reporter reporter

sharedResourceBundleName	back to summary
protected static final String sharedResourceBundleName

shouldCheck	back to summary
pack-priv Map<CompilationUnitTree, Boolean> shouldCheck

showModules	back to summary
public boolean showModules Generate modules documentation if more than one module is present.

sourcepath	back to summary
public String sourcepath Sourcepath from where to read the source files. Default is classpath.

specifiedModuleElements	back to summary
private Set<ModuleElement> specifiedModuleElements

specifiedPackageElements	back to summary
private Set<PackageElement> specifiedPackageElements

specifiedTypeElements	back to summary
private Set<TypeElement> specifiedTypeElements

typeElementCatalog	back to summary
public TypeElementCatalog typeElementCatalog The catalog of classes specified on the command-line

utils	back to summary
public Utils utils An utility class for commonly used helpers

visibleMemberCache	back to summary
private VisibleMemberCache visibleMemberCache

workArounds	back to summary
public WorkArounds workArounds All the temporary accessors to javac internals.

Constructor Detail

BaseConfiguration back to summary

BaseConfiguration	back to summary
public BaseConfiguration(Doclet doclet, Locale locale, Reporter reporter) Constructs the format-independent configuration needed by the doclet. API Note The `doclet` parameter is used when `initializing tags`. Some doclets (such as the `StandardDoclet`), may delegate to another (such as the `HtmlDoclet`). In such cases, the primary doclet (i.e `StandardDoclet`) should be provided here, and not any internal class like `HtmlDoclet`. Parameters doclet:Doclet the doclet for this run of javadoc locale:Locale the locale for the generated documentation reporter:Reporter the reporter to use for console messages

public BaseConfiguration(Doclet doclet, Locale locale, Reporter reporter)

Constructs the format-independent configuration needed by the doclet.

API Note

The doclet parameter is used when initializing tags. Some doclets (such as the StandardDoclet), may delegate to another (such as the HtmlDoclet). In such cases, the primary doclet (i.e StandardDoclet) should be provided here, and not any internal class like HtmlDoclet.

Parameters

doclet:Doclet: the doclet for this run of javadoc
locale:Locale: the locale for the generated documentation
reporter:Reporter: the reporter to use for console messages

Method Detail

finishOptionSettings	back to summary
public abstract boolean finishOptionSettings() 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. Returns:boolean true if successful and false otherwise

finishOptionSettings

back to summary

public abstract boolean finishOptionSettings()

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.

Returns:boolean: true if successful and false otherwise

finishOptionSettings0	back to summary
protected boolean finishOptionSettings0() throws DocletException

getClassName	back to summary
public String getClassName(TypeElement te) Return the qualified name of the Element if its qualifier is not excluded. Otherwise return the unqualified Element name. Parameters te:TypeElement the TypeElement to check. Returns:String the class name

getClassName

back to summary

public String getClassName(TypeElement te)

Return the qualified name of the Element if its qualifier is not excluded. Otherwise return the unqualified Element name.

Parameters

te:TypeElement: the TypeElement to check.

Returns:String

the class name

getDocletVersion back to summary

getDocletVersion	back to summary
public abstract Runtime.Version getDocletVersion() Returns the version of the `doclet`. Returns:Runtime.Version the version

public abstract Runtime.Version getDocletVersion()

Returns the version of the doclet.

Returns:Runtime.Version: the version

getDocResources	back to summary
public abstract Resources getDocResources()

getFileManager	back to summary
public abstract JavaFileManager getFileManager() Return the current file manager. Returns:JavaFileManager JavaFileManager

getFileManager

back to summary

public abstract JavaFileManager getFileManager()

Return the current file manager.

Returns:JavaFileManager: JavaFileManager

getIncludedModuleElements	back to summary
public Set<ModuleElement> getIncludedModuleElements()

getIncludedPackageElements	back to summary
public Set<PackageElement> getIncludedPackageElements()

getIncludedTypeElements	back to summary
public Set<TypeElement> getIncludedTypeElements()

getLocale	back to summary
public abstract Locale getLocale() Return the Locale for this document. Returns:Locale the current locale

getLocale

back to summary

public abstract Locale getLocale()

Return the Locale for this document.

Returns:Locale: the current locale

getMessages	back to summary
public abstract Messages getMessages()

getOptions	back to summary
public abstract BaseOptions getOptions()

getOverviewPath	back to summary
public abstract JavaFileObject getOverviewPath() Return the path of the overview file and null if it does not exist. Returns:JavaFileObject the path of the overview file.

getOverviewPath

back to summary

public abstract JavaFileObject getOverviewPath()

Return the path of the overview file and null if it does not exist.

Returns:JavaFileObject: the path of the overview file.

getReporter	back to summary
public Reporter getReporter()

getSpecifiedModuleElements	back to summary
public Set<ModuleElement> getSpecifiedModuleElements()

getSpecifiedPackageElements	back to summary
public Set<PackageElement> getSpecifiedPackageElements()

getSpecifiedTypeElements	back to summary
public Set<TypeElement> getSpecifiedTypeElements()

getVisibleMemberTable	back to summary
public VisibleMemberTable getVisibleMemberTable(TypeElement te)

initConfiguration	back to summary
protected void initConfiguration(DocletEnvironment docEnv, Function<String, String> resourceKeyMapper)

initDestDirectory	back to summary
private void initDestDirectory() throws DocletException

initDocLint back to summary

public void initDocLint(List<String> opts, Set<String> customTagNames)

Initializes DocLint, if appropriate, depending on options derived from the doclet command-line options, and the set of custom tags that should be ignored by DocLint. DocLint is not enabled if the option -Xmsgs:none is given, and it is not followed by any options to enable any groups. Note that arguments for -Xmsgs: can be given individually in separate -Xmsgs: options, or in a comma-separated list for a single option. For example, the following are equivalent:

-Xmsgs:all -Xmsgs:-html
-Xmsgs:all,-html

Parameters

opts:List<String>: options for DocLint, derived from the corresponding doclet command-line options
customTagNames:Set<String>: the names of custom tags, to be ignored by doclint

initModules	back to summary
private void initModules()

initPackages	back to summary
private void initPackages()

isAllowScriptInComments

back to summary

public boolean isAllowScriptInComments()

Returns whether or not to allow JavaScript in comments. Default is off; can be set true from a command-line option.

Returns:boolean: the allowScriptInComments

isDocLintGroupEnabled	back to summary
private boolean isDocLintGroupEnabled(Messages.Group group)

isDocLintReferenceGroupEnabled	back to summary
public boolean isDocLintReferenceGroupEnabled()

isDocLintSyntaxGroupEnabled	back to summary
public boolean isDocLintSyntaxGroupEnabled()

isGeneratedDoc

back to summary

public boolean isGeneratedDoc(TypeElement te)

Return true if the TypeElement element is getting documented, depending upon -nodeprecated option and the deprecation information. Return true if -nodeprecated is not used. Return false if -nodeprecated is used and if either TypeElement element is deprecated or the containing package is deprecated.

Parameters

te:TypeElement: the TypeElement for which the page generation is checked

Returns:boolean

true if it is a generated doc.

isJavaFXMode

back to summary

public boolean isJavaFXMode()

Determines if JavaFX is available in the compilation environment.

Returns:boolean: true if JavaFX is available

runDocLint	back to summary
public void runDocLint(TreePath path)

setOptions

back to summary

public boolean setOptions() throws DocletException

Set the command-line options supported by this configuration.

Returns:boolean

true if the options are set successfully

Exceptions

DocletException:: if there is a problem while setting the options

shouldExcludeDocFileDir

back to summary

public boolean shouldExcludeDocFileDir(String docfilesubdir)

Return true if the given doc-file subdirectory should be excluded and false otherwise.

Parameters

docfilesubdir:String: the doc-files subdirectory to check.

Returns:boolean

true if the directory is excluded.

shouldExcludeQualifier

back to summary

public boolean shouldExcludeQualifier(String qualifier)

Return true if the given qualifier should be excluded and false otherwise.

Parameters

qualifier:String: the qualifier to check.

Returns:boolean

true if the qualifier should be excluded

Modifier and Type	Field and Description
pack-priv final Set<ModuleElement>	mset
pack-priv final Set<PackageElement>	pset
pack-priv final Set<TypeElement>	tset

public abstract Class BaseConfiguration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BaseConfiguration.Splitter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail