Package org.jdrupes.mdoclet.internal.doclets.toolkit

Klasse BaseConfiguration

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.BaseConfiguration

Bekannte direkte Unterklassen:

HtmlConfiguration

public abstract class BaseConfiguration
extends Object

Configure the output based on the options.

Doclets should subclass BaseConfiguration, to configure and add their own options. This class contains all user options which are supported by the standard doclet.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected BuilderFactory	builderFactory	The factory for builders.
CommentUtils	cmtUtils
DocletEnvironment	docEnv	The doclet environment.
DocFileFactory	docFileFactory
final Doclet	doclet	The doclet that created this configuration.
Extern	extern	The tracker of external package links.
final Group	group	The package grouping instance.
final Locale	locale
MetaKeywords	metakeywords	The meta tag keywords instance.
SortedMap<ModuleElement,Set<PackageElement>>	modulePackages	A sorted map, giving the (specified|included|other) packages for each module.
SortedSet<ModuleElement>	modules	The list of known modules, that should be documented.
OverviewElement	overviewElement
SortedSet<PackageElement>	packages	A sorted set of included packages.
PropertyUtils	propertyUtils
final Reporter	reporter
protected static final String	sharedResourceBundleName
boolean	showModules	Generate modules documentation if more than one module is present.
String	sourcepath	Sourcepath from where to read the source files.
TagletManager	tagletManager	The taglet manager.
TypeElementCatalog	typeElementCatalog	The catalog of classes specified on the command-line
Utils	utils	An utility class for commonly used helpers
WorkArounds	workArounds	All the temporary accessors to javac internals.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
BaseConfiguration(Doclet doclet, Locale locale, Reporter reporter)	Constructs the format-independent configuration needed by the doclet.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
abstract boolean	finishOptionSettings()	This method should be defined in all those doclets (configurations), which want to derive themselves from this BaseConfiguration.
protected boolean	finishOptionSettings0()
BuilderFactory	getBuilderFactory()	Return the builder factory for this doclet.
String	getClassName(TypeElement te)	Return the qualified name of the Element if its qualifier is not excluded.
abstract Runtime.Version	getDocletVersion()	Returns the version of the doclet.
abstract Resources	getDocResources()
abstract JavaFileManager	getFileManager()	Return the current file manager.
Set<ModuleElement>	getIncludedModuleElements()
Set<PackageElement>	getIncludedPackageElements()
Set<TypeElement>	getIncludedTypeElements()
abstract Locale	getLocale()	Return the Locale for this document.
abstract Messages	getMessages()
abstract BaseOptions	getOptions()
abstract JavaFileObject	getOverviewPath()	Return the path of the overview file and null if it does not exist.
Reporter	getReporter()
Set<ModuleElement>	getSpecifiedModuleElements()
Set<PackageElement>	getSpecifiedPackageElements()
Set<TypeElement>	getSpecifiedTypeElements()
VisibleMemberTable	getVisibleMemberTable(TypeElement te)
abstract WriterFactory	getWriterFactory()	Return the doclet specific instance of a writer factory.
protected void	initConfiguration(DocletEnvironment docEnv, Function<String,String> resourceKeyMapper)
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.
boolean	isAllowScriptInComments()	Returns whether or not to allow JavaScript in comments.
boolean	isDocLintReferenceGroupEnabled()
boolean	isDocLintSyntaxGroupEnabled()
boolean	isGeneratedDoc(TypeElement te)	Return true if the TypeElement element is getting documented, depending upon -nodeprecated option and the deprecation information.
boolean	isJavaFXMode()	Determines if JavaFX is available in the compilation environment.
void	runDocLint(TreePath path)
boolean	setOptions()	Set the command-line options supported by this configuration.
boolean	shouldExcludeDocFileDir(String docfilesubdir)	Return true if the given doc-file subdirectory should be excluded and false otherwise.
boolean	shouldExcludeQualifier(String qualifier)	Return true if the given qualifier should be excluded and false otherwise.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

doclet

public final Doclet doclet

The doclet that created this configuration.

builderFactory

protected BuilderFactory builderFactory

The factory for builders.

tagletManager

public TagletManager tagletManager

The taglet manager.

metakeywords

public MetaKeywords metakeywords

The meta tag keywords instance.

docEnv

public DocletEnvironment docEnv

The doclet environment.

utils

public Utils utils

An utility class for commonly used helpers

workArounds

public WorkArounds workArounds

All the temporary accessors to javac internals.

sourcepath

public String sourcepath

Sourcepath from where to read the source files.

Default is classpath.

showModules

public boolean showModules

Generate modules documentation if more than one module is present.

typeElementCatalog

public TypeElementCatalog typeElementCatalog

The catalog of classes specified on the command-line

group

public final Group group

The package grouping instance.

extern

public Extern extern

The tracker of external package links.

reporter

public final Reporter reporter

locale

public final Locale locale

cmtUtils

public CommentUtils cmtUtils

packages

public SortedSet<PackageElement> packages

A sorted set of included packages.

overviewElement

public OverviewElement overviewElement

docFileFactory

public DocFileFactory docFileFactory

modulePackages

public SortedMap<ModuleElement,Set<PackageElement>> modulePackages

A sorted map, giving the (specified|included|other) packages for each module.

modules

public SortedSet<ModuleElement> modules

The list of known modules, that should be documented.

sharedResourceBundleName

protected static final String sharedResourceBundleName

Siehe auch:

• Konstantenfeldwerte

propertyUtils

public PropertyUtils propertyUtils

Konstruktordetails

BaseConfiguration

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

Constructs the format-independent configuration needed by the doclet.

Parameter:

doclet - the doclet for this run of javadoc

locale - the locale for the generated documentation

reporter - the reporter to use for console messages

Methodendetails

getMessages

public abstract Messages getMessages()

getDocResources

public abstract Resources getDocResources()

getDocletVersion

public abstract Runtime.Version getDocletVersion()

Returns the version of the doclet.

Gibt zurück:

the version

finishOptionSettings

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.

Gibt zurück:

true if successful and false otherwise

getOptions

public abstract BaseOptions getOptions()

initConfiguration

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

getBuilderFactory

public BuilderFactory getBuilderFactory()

Return the builder factory for this doclet.

Gibt zurück:

the builder factory for this doclet.

getReporter

public Reporter getReporter()

getSpecifiedModuleElements

public Set<ModuleElement> getSpecifiedModuleElements()

getSpecifiedPackageElements

public Set<PackageElement> getSpecifiedPackageElements()

getSpecifiedTypeElements

public Set<TypeElement> getSpecifiedTypeElements()

getIncludedModuleElements

public Set<ModuleElement> getIncludedModuleElements()

getIncludedPackageElements

public Set<PackageElement> getIncludedPackageElements()

getIncludedTypeElements

public Set<TypeElement> getIncludedTypeElements()

finishOptionSettings0

protected boolean finishOptionSettings0()
                                 throws DocletException

Löst aus:

DocletException

setOptions

public boolean setOptions()
                   throws DocletException

Set the command-line options supported by this configuration.

Gibt zurück:

true if the options are set successfully

Löst aus:

DocletException - if there is a problem while setting the options

shouldExcludeDocFileDir

public boolean shouldExcludeDocFileDir(String docfilesubdir)

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

Parameter:

docfilesubdir - the doc-files subdirectory to check.

Gibt zurück:

true if the directory is excluded.

shouldExcludeQualifier

public boolean shouldExcludeQualifier(String qualifier)

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

Parameter:

qualifier - the qualifier to check.

Gibt zurück:

true if the qualifier should be excluded

getClassName

public String getClassName(TypeElement te)

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

Otherwise return the unqualified Element name.

Parameter:

te - the TypeElement to check.

Gibt zurück:

the class name

isGeneratedDoc

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.

Parameter:

te - the TypeElement for which the page generation is checked

Gibt zurück:

true if it is a generated doc.

getWriterFactory

public abstract WriterFactory getWriterFactory()

Return the doclet specific instance of a writer factory.

Gibt zurück:

the WriterFactory for the doclet.

getLocale

public abstract Locale getLocale()

Return the Locale for this document.

Gibt zurück:

the current locale

getOverviewPath

public abstract JavaFileObject getOverviewPath()

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

Gibt zurück:

the path of the overview file.

getFileManager

public abstract JavaFileManager getFileManager()

Return the current file manager.

Gibt zurück:

JavaFileManager

isAllowScriptInComments

public boolean isAllowScriptInComments()

Returns whether or not to allow JavaScript in comments.

Default is off; can be set true from a command-line option.

Gibt zurück:

the allowScriptInComments

getVisibleMemberTable

public VisibleMemberTable getVisibleMemberTable(TypeElement te)

isJavaFXMode

public boolean isJavaFXMode()

Determines if JavaFX is available in the compilation environment.

Gibt zurück:

true if JavaFX is available

runDocLint

public void runDocLint(TreePath path)

initDocLint

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

Parameter:

opts - options for DocLint, derived from the corresponding doclet command-line options

customTagNames - the names of custom tags, to be ignored by doclint

isDocLintReferenceGroupEnabled

public boolean isDocLintReferenceGroupEnabled()

isDocLintSyntaxGroupEnabled

public boolean isDocLintSyntaxGroupEnabled()