Modifier and Type	Class and Description
public static class	DocFilesHandler.DocFileWriter A writer to write out the processed form of an HTML file found in the `doc-files` subdirectory for a module or package.

Modifier and Type	Field and Description
private final HtmlConfiguration	configuration
private final Element	element
private final JavaFileManager.Location	location
private final HtmlOptions	options
private final DocPath	source
private final Utils	utils
private final WriterFactory	writerFactory

Access	Constructor and Description
public	DocFilesHandler(HtmlConfiguration the configuration of this doclet. configuration, Element the containing element of the doc-files. element) Constructor to construct the DocFilesHandler object.

Method Summary

Modifier and Type	Method and Description
private void	copyDirectory(DocFile srcdir, final DocPath dstDocPath, boolean first)
public void	copyDocFiles() Copy doc-files directory and its contents from the source elements directory to the generated documentation directory.
public List<DocPath>	getStylesheets()
private void	handleDocFile(DocFile srcFile, DocPath dstPath)
private boolean	isValidFilename(DocFile f)

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

configuration	back to summary
private final HtmlConfiguration configuration

element	back to summary
private final Element element

location	back to summary
private final JavaFileManager.Location location

options	back to summary
private final HtmlOptions options

source	back to summary
private final DocPath source

utils	back to summary
private final Utils utils

writerFactory	back to summary
private final WriterFactory writerFactory

Constructor Detail

DocFilesHandler back to summary

DocFilesHandler	back to summary
public DocFilesHandler(HtmlConfiguration configuration, Element element) Constructor to construct the DocFilesHandler object. Parameters configuration:HtmlConfiguration the configuration of this doclet. element:Element the containing element of the doc-files. See Also `WriterFactory#newDocFilesHandler(Element)`

public DocFilesHandler(HtmlConfiguration configuration, Element element)

Constructor to construct the DocFilesHandler object.

Parameters

configuration:HtmlConfiguration: the configuration of this doclet.
element:Element: the containing element of the doc-files.

Method Detail

copyDirectory	back to summary
private void copyDirectory(DocFile srcdir, final DocPath dstDocPath, boolean first) throws DocletException

copyDocFiles	back to summary
public void copyDocFiles() throws DocletException Copy doc-files directory and its contents from the source elements directory to the generated documentation directory. Exceptions DocletException: if there is a problem while copying the documentation files

copyDocFiles

back to summary

public void copyDocFiles() throws DocletException

Copy doc-files directory and its contents from the source elements directory to the generated documentation directory.

Exceptions

DocletException:: if there is a problem while copying the documentation files

getStylesheets	back to summary
public List<DocPath> getStylesheets() throws DocFileIOException

handleDocFile	back to summary
private void handleDocFile(DocFile srcFile, DocPath dstPath) throws DocletException

isValidFilename	back to summary
private boolean isValidFilename(DocFile f)

jdk.javadoc.internal.doclets.formats.html back to summary

public Class DocFilesHandler.DocFileWriter

Class Inheritance

extends HtmlDocletWriter

java.lang.Object
jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter
jdk.javadoc.internal.doclets.formats.html.DocFilesHandler.DocFileWriter

A writer to write out the processed form of an HTML file found in the doc-files subdirectory for a module or package.

Field Summary

Modifier and Type	Field and Description
private final DocFileElement	dfElement

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:: comparators configuration contents docPaths htmlIds indexAnchorTable links mainBodyScript messages options path pathToRoot resources tableOfContents utils winTitle

Constructor Summary

Access	Constructor and Description
public	DocFileWriter(HtmlConfiguration the configuration of this doclet configuration, DocPath the file to be generated path, DocFileElement the element representing the doc file dfElement) Constructor.

Method Summary

Modifier and Type	Method and Description
public void	buildPage() Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer.
protected TableOfContents	createTableOfContents() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.createTableOfContents. Creates table of contents for this writer.
private List<? extends DocTree>	getLocalHeaderTags(List<? extends DocTree> dtrees)
private String	getWindowTitle(HtmlDocletWriter docletWriter, DocFileElement element)
public boolean	isIndexable() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable. Returns true if the page written by this writer should be indexed, false otherwise.

Inherited from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter:: addInlineComment addInlineComment addInlineDeprecatedComment addPreQualifiedClassLink addPreQualifiedClassLink addPreQualifiedStrongClassLink addPreviewComment addPreviewInfo addPreviewSummary addRestrictedInfo addRestrictedSummary addSrcLink addSummaryComment addSummaryComment addSummaryDeprecatedComment addTagsInfo commentTagsToContent commentTagsToContent commentTagsToContent getAnnotationInfo getAnnotationInfo getAnnotations getBlockTagOutput getBlockTagOutput getBody getBodyStyle getCrossClassLink getCrossModuleLink getCrossPackageLink getCurrentTypeElement getDeprecatedPhrase getDescription getDocLink getDocLink getDocLink getDocLink getDocLink getEnclosingPackageName getFileTitle getFooter getGenerator getHeader getHeader getLink getLocalizedPackageName getLocalStylesheets getModuleLink getModuleLink getNavBar getNavLinkToOverviewTree getPackageLabel getPackageLink getPackageLink getPackageTableHeader getPreQualifiedClassLink getQualifiedClassLink getTagletWriterInstance getTagletWriterInstance getTypeParameterLinks getWindowTitle hasSerializationOverviewTags ignoreNonInlineTag invalidTagOutput pathString pathString printHtmlDocument printHtmlDocument printHtmlDocument replaceDocRootDir resolveExternalSpecURI writeGenerating

Field Detail

dfElement	back to summary
private final DocFileElement dfElement

Constructor Detail

DocFileWriter	back to summary
public DocFileWriter(HtmlConfiguration configuration, DocPath path, DocFileElement dfElement) Constructor. Parameters configuration:HtmlConfiguration the configuration of this doclet path:DocPath the file to be generated dfElement:DocFileElement the element representing the doc file

DocFileWriter

back to summary

public DocFileWriter(HtmlConfiguration configuration, DocPath path, DocFileElement dfElement)

Constructor.

Parameters

configuration:HtmlConfiguration: the configuration of this doclet
path:DocPath: the file to be generated
dfElement:DocFileElement: the element representing the doc file

Method Detail

buildPage	back to summary
public void buildPage() throws DocFileIOException Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage. The top-level method to generate and write the page represented by this writer. Annotations @Override

buildPage

back to summary

public void buildPage() throws DocFileIOException

Implements abstract jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.buildPage.

The top-level method to generate and write the page represented by this writer.

Annotations

@Override

createTableOfContents back to summary

createTableOfContents	back to summary
protected TableOfContents createTableOfContents() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.createTableOfContents. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.createTableOfContents. Creates table of contents for this writer. Can be overridden to return `null` in subclasses that don't require a table of contents. Annotations @Override

protected TableOfContents createTableOfContents()

Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.createTableOfContents.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.createTableOfContents.

Creates table of contents for this writer. Can be overridden to return null in subclasses that don't require a table of contents.

Annotations

@Override

getLocalHeaderTags	back to summary
private List<? extends DocTree> getLocalHeaderTags(List<? extends DocTree> dtrees)

getWindowTitle	back to summary
private String getWindowTitle(HtmlDocletWriter docletWriter, DocFileElement element)

isIndexable	back to summary
public boolean isIndexable() Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable. Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable. Returns true if the page written by this writer should be indexed, false otherwise. Some pages merely aggregate filtered information available on other pages and, thus, have no indexing value. In fact, if indexed, they would clutter the index and mislead the reader. Annotations @Override

isIndexable

back to summary

public boolean isIndexable()

Overrides jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable.

Doc from jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter.isIndexable.

Returns true if the page written by this writer should be indexed, false otherwise. Some pages merely aggregate filtered information available on other pages and, thus, have no indexing value. In fact, if indexed, they would clutter the index and mislead the reader.

Annotations

@Override

public Class DocFilesHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DocFilesHandler.DocFileWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail