Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse HtmlConfiguration

java.lang.Object

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

org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlConfiguration

public class HtmlConfiguration
extends BaseConfiguration

Configure the output based on the command-line options.

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.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	HtmlConfiguration.ConditionalPage	Kinds of conditional pages.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
final Set<HtmlConfiguration.ConditionalPage>	conditionalPages	A set of values indicating which conditional pages should be generated.
Contents	contents
TypeElement	currentTypeElement	The TypeElement for the class file getting generated.
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.
DocPaths	docPaths
final Resources	docResources
static final String	HTML_DEFAULT_CHARSET	Default charset for HTML.
HtmlIds	htmlIds
Map<Element,List<DocPath>>	localStylesheetMap
protected HtmlIndexBuilder	mainIndex	The collections of items for the main index.
protected final Messages	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.
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.
DocPath	topFile	First file to appear in the right-hand frame in the generated documentation.

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.BaseConfiguration

builderFactory, cmtUtils, docEnv, docFileFactory, doclet, extern, group, locale, metakeywords, modulePackages, modules, overviewElement, packages, propertyUtils, reporter, sharedResourceBundleName, showModules, sourcepath, tagletManager, typeElementCatalog, utils, workArounds

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
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.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected boolean	checkForDeprecation()
boolean	finishOptionSettings()	This method should be defined in all those doclets (configurations), which want to derive themselves from this BaseConfiguration.
protected boolean	finishOptionSettings0()
List<DocPath>	getAdditionalScripts()
List<DocPath>	getAdditionalStylesheets()
ZonedDateTime	getBuildDate()	Gibt the date to be recorded in generated files zurück.
Contents	getContents()	Returns a utility object providing commonly used fragments of content.
Runtime.Version	getDocletVersion()	Returns the version of the doclet.
Resources	getDocResources()
JavaFileManager	getFileManager()	Return the current file manager.
Locale	getLocale()	Return the Locale for this document.
DocPath	getMainStylesheet()
Messages	getMessages()
HtmlOptions	getOptions()
JavaFileObject	getOverviewPath()	Return the path of the overview file or null if it does not exist.
protected TypeElement	getValidClass(List<TypeElement> classes)
WriterFactory	getWriterFactory()	Return the doclet specific instance of a writer factory.
protected void	initConfiguration(DocletEnvironment docEnv, Function<String,String> resourceKeyMapper)
protected void	setCreateOverview()	Generate “overview.html” page if option “-overview” is used or number of packages is more than one.
protected void	setTopFile()	Decide the page which will appear first in the right-hand frame.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.BaseConfiguration

getBuilderFactory, getClassName, getIncludedModuleElements, getIncludedPackageElements, getIncludedTypeElements, getReporter, getSpecifiedModuleElements, getSpecifiedPackageElements, getSpecifiedTypeElements, getVisibleMemberTable, initDocLint, isAllowScriptInComments, isDocLintReferenceGroupEnabled, isDocLintSyntaxGroupEnabled, isGeneratedDoc, isJavaFXMode, runDocLint, setOptions, shouldExcludeDocFileDir, shouldExcludeQualifier

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

HTML_DEFAULT_CHARSET

public static final String HTML_DEFAULT_CHARSET

Default charset for HTML.

Siehe auch:

• Konstantenfeldwerte

docResources

public final Resources docResources

topFile

public DocPath topFile

First file to appear in the right-hand frame in the generated documentation.

currentTypeElement

public TypeElement currentTypeElement

The TypeElement for the class file getting generated.

mainIndex

protected HtmlIndexBuilder mainIndex

The collections of items for the main index.

This field is only initialized if options.createIndex() is true. This index is populated somewhat lazily:

1. items found in doc comments are found while generating declaration pages
2. items for elements are added in bulk before generating the index files
3. additional items are added as needed

deprecatedAPIListBuilder

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 no deprecated items are to be included in the documentation, or if the page is not wanted, or if there are no deprecated elements being documented.

previewAPIListBuilder

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.

newAPIPageBuilder

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 –since option is used with release names matching @since tags in the documented code.

contents

public Contents contents

messages

protected final Messages messages

docPaths

public DocPaths docPaths

htmlIds

public HtmlIds htmlIds

localStylesheetMap

public Map<Element,List<DocPath>> localStylesheetMap

conditionalPages

public final Set<HtmlConfiguration.ConditionalPage> conditionalPages

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.

Konstruktordetails

HtmlConfiguration

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.

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

initConfiguration

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

Setzt außer Kraft:

initConfiguration in Klasse BaseConfiguration

getDocletVersion

public Runtime.Version getDocletVersion()

Beschreibung aus Klasse kopiert: BaseConfiguration

Returns the version of the doclet.

Angegeben von:

getDocletVersion in Klasse BaseConfiguration

Gibt zurück:

the version

getDocResources

public Resources getDocResources()

Angegeben von:

getDocResources in Klasse BaseConfiguration

getContents

public Contents getContents()

Returns a utility object providing commonly used fragments of content.

Gibt zurück:

a utility object providing commonly used fragments of content

getMessages

public Messages getMessages()

Angegeben von:

getMessages in Klasse BaseConfiguration

getOptions

public HtmlOptions getOptions()

Angegeben von:

getOptions in Klasse BaseConfiguration

finishOptionSettings

public boolean finishOptionSettings()

Beschreibung aus Klasse kopiert: BaseConfiguration

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.

Angegeben von:

finishOptionSettings in Klasse BaseConfiguration

Gibt zurück:

true if successful and false otherwise

getBuildDate

public ZonedDateTime getBuildDate()

Gibt the date to be recorded in generated files zurück.

Gibt zurück:

the date to be recorded in generated files

setTopFile

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.

getValidClass

protected TypeElement getValidClass(List<TypeElement> classes)

checkForDeprecation

protected boolean checkForDeprecation()

setCreateOverview

protected void setCreateOverview()

Generate “overview.html” page if option “-overview” is used or number of packages is more than one.

Sets HtmlOptions.createOverview field to true.

getWriterFactory

public WriterFactory getWriterFactory()

Beschreibung aus Klasse kopiert: BaseConfiguration

Return the doclet specific instance of a writer factory.

Angegeben von:

getWriterFactory in Klasse BaseConfiguration

Gibt zurück:

the WriterFactory for the doclet.

getLocale

public Locale getLocale()

Beschreibung aus Klasse kopiert: BaseConfiguration

Return the Locale for this document.

Angegeben von:

getLocale in Klasse BaseConfiguration

Gibt zurück:

the current locale

getOverviewPath

public JavaFileObject getOverviewPath()

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

Angegeben von:

getOverviewPath in Klasse BaseConfiguration

Gibt zurück:

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

getMainStylesheet

public DocPath getMainStylesheet()

getAdditionalStylesheets

public List<DocPath> getAdditionalStylesheets()

getAdditionalScripts

public List<DocPath> getAdditionalScripts()

getFileManager

public JavaFileManager getFileManager()

Beschreibung aus Klasse kopiert: BaseConfiguration

Return the current file manager.

Angegeben von:

getFileManager in Klasse BaseConfiguration

Gibt zurück:

JavaFileManager

finishOptionSettings0

protected boolean finishOptionSettings0()
                                 throws DocletException

Setzt außer Kraft:

finishOptionSettings0 in Klasse BaseConfiguration

Löst aus:

DocletException