OpenJDK 27 · jdk.javadoc.internal.doclets.formats.html.WriterFactory

Modifier and Type	Field and Description
private final HtmlConfiguration	configuration

Access	Constructor and Description
public	WriterFactory(HtmlConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
public HtmlDocletWriter	Returns: a new writer for the list of "all classes" newAllClassesIndexWriter() Returns a new writer for the list of "all classes".
public HtmlDocletWriter	Returns: a new writer for the list of "all packages" newAllPackagesIndexWriter() Returns a new writer for the list of "all packages".
public HtmlDocletWriter	Returns: a new writer for the "class use" page for a class or other type element newClassUseWriter(TypeElement typeElement, ClassUseMapper mapper) Returns a new writer for the "class use" page for a class or other type element.
public HtmlDocletWriter	Returns: a new writer for the page for a class or other type element newClassWriter(TypeElement typeElement, ClassTree classTree) Returns a new writer for the page for a class or other type element.
public HtmlDocletWriter	Returns: a new writer for the "constants summary" page newConstantsSummaryWriter() Returns a new writer for the "constants summary" page.
public HtmlDocletWriter	Returns: a new writer for the page giving the API that has been deprecated in recent releases newDeprecatedListWriter() Returns a new writer for the page giving the API that has been deprecated in recent releases.
public DocFilesHandler	Returns: a new `DocFilesHandler` newDocFilesHandler(Element element) Returns a new `DocFilesHandler`.
public HtmlDocletWriter	Returns: a new writer for a "doc-file" page newDocFileWriter(DocPath path, DocFileElement dfElement) Returns a new writer for a "doc-file" page.
public HtmlDocletWriter	Returns: a new writer for the page listing external specifications referenced in the API newExternalSpecsWriter() Returns a new writer for the page listing external specifications referenced in the API.
public HtmlDocletWriter	Returns: a new writer for the "help" page newHelpWriter() Returns a new writer for the "help" page.
public HtmlDocletWriter	Returns: a new writer for an "index" page newIndexWriter(DocPath path, List<Character> allFirstCharacters, List<Character> displayFirstCharacters) Returns a new writer for an "index" page.
public AbstractMemberWriter	Returns: the writer newMemberWriter(ClassWriter the writer for the enclosing class classWriter, VisibleMemberTable.Kind the kind kind) Returns a new member writer for the members of a given class and given kind.
public HtmlDocletWriter	Returns: a new writer for the "module index" page newModuleIndexWriter() Returns a new writer for the "module index" page.
public HtmlDocletWriter	Returns: a new writer for the page for a module newModuleWriter(ModuleElement mdle) Returns a new writer for the page for a module.
public HtmlDocletWriter	Returns: a new writer for the list of new API in recent releases newNewAPIListWriter() Returns a new writer for the list of new API in recent releases.
public HtmlDocletWriter	Returns: a new writer for the "package index" page newPackageIndexWriter() Returns a new writer for the "package index" page.
public HtmlDocletWriter	Returns: a new writer for the "package use" page for a package newPackageUseWriter(PackageElement packageElement, ClassUseMapper mapper) Returns a new writer for the "package use" page for a package.
public HtmlDocletWriter	Returns: a new writer for the page for a package newPackageWriter(PackageElement packageElement) Returns a new writer for the page for a package.
public HtmlDocletWriter	Returns: a new writer for the list of preview API in this release newPreviewListWriter() Returns a new writer for the list of preview API in this release.
public HtmlDocletWriter	Returns: a new writer for the list of restricted methods in this release newRestrictedListWriter() Returns a new writer for the list of restricted methods in this release.
public HtmlDocletWriter	Returns: a new writer for the page listing search tags defined in the API newSearchTagsWriter() Returns a new writer for the page listing search tags defined in the API.
public HtmlDocletWriter	Returns: a new writer for the "search" page newSearchWriter() Returns a new writer for the "search" page.
public HtmlDocletWriter	Returns: a new writer for the page giving the serialized forms of classes and other type elements newSerializedFormWriter() Returns a new writer for the page giving the serialized forms of classes and other type elements.
public HtmlDocletWriter	Returns: a new writer for the page listing system properties referenced in the API newSystemPropertiesWriter() Returns a new writer for the page listing system properties referenced in the API.
public HtmlDocletWriter	Returns: a new writer for the page showing the hierarchy of classes and their superclasses newTreeWriter(ClassTree classTree) Returns a new writer for the page showing the hierarchy of classes and their superclasses.

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

configuration	back to summary
private final HtmlConfiguration configuration

WriterFactory	back to summary
public WriterFactory(HtmlConfiguration configuration)

Method Detail

newAllClassesIndexWriter	back to summary
public HtmlDocletWriter newAllClassesIndexWriter() Returns a new writer for the list of "all classes". Returns:HtmlDocletWriter a new writer for the list of "all classes"

newAllClassesIndexWriter

back to summary

public HtmlDocletWriter newAllClassesIndexWriter()

Returns a new writer for the list of "all classes".

Returns:HtmlDocletWriter: a new writer for the list of "all classes"

newAllPackagesIndexWriter	back to summary
public HtmlDocletWriter newAllPackagesIndexWriter() Returns a new writer for the list of "all packages". Returns:HtmlDocletWriter a new writer for the list of "all packages"

newAllPackagesIndexWriter

back to summary

public HtmlDocletWriter newAllPackagesIndexWriter()

Returns a new writer for the list of "all packages".

Returns:HtmlDocletWriter: a new writer for the list of "all packages"

newClassUseWriter	back to summary
public HtmlDocletWriter newClassUseWriter(TypeElement typeElement, ClassUseMapper mapper) Returns a new writer for the "class use" page for a class or other type element. Returns:HtmlDocletWriter a new writer for the "class use" page for a class or other type element

newClassUseWriter

back to summary

public HtmlDocletWriter newClassUseWriter(TypeElement typeElement, ClassUseMapper mapper)

Returns a new writer for the "class use" page for a class or other type element.

Returns:HtmlDocletWriter: a new writer for the "class use" page for a class or other type element

newClassWriter	back to summary
public HtmlDocletWriter newClassWriter(TypeElement typeElement, ClassTree classTree) Returns a new writer for the page for a class or other type element. Returns:HtmlDocletWriter a new writer for the page for a class or other type element

newClassWriter

back to summary

public HtmlDocletWriter newClassWriter(TypeElement typeElement, ClassTree classTree)

Returns a new writer for the page for a class or other type element.

Returns:HtmlDocletWriter: a new writer for the page for a class or other type element

newConstantsSummaryWriter	back to summary
public HtmlDocletWriter newConstantsSummaryWriter() Returns a new writer for the "constants summary" page. Returns:HtmlDocletWriter a new writer for the "constants summary" page

newConstantsSummaryWriter

back to summary

public HtmlDocletWriter newConstantsSummaryWriter()

Returns a new writer for the "constants summary" page.

Returns:HtmlDocletWriter: a new writer for the "constants summary" page

newDeprecatedListWriter	back to summary
public HtmlDocletWriter newDeprecatedListWriter() Returns a new writer for the page giving the API that has been deprecated in recent releases. Returns:HtmlDocletWriter a new writer for the page giving the API that has been deprecated in recent releases

newDeprecatedListWriter

back to summary

public HtmlDocletWriter newDeprecatedListWriter()

Returns a new writer for the page giving the API that has been deprecated in recent releases.

Returns:HtmlDocletWriter: a new writer for the page giving the API that has been deprecated in recent releases

newDocFilesHandler back to summary

newDocFilesHandler	back to summary
public DocFilesHandler newDocFilesHandler(Element element) Returns a new `DocFilesHandler`. Returns:DocFilesHandler a new `DocFilesHandler`

public DocFilesHandler newDocFilesHandler(Element element)

Returns a new DocFilesHandler.

Returns:DocFilesHandler: a new DocFilesHandler

newDocFileWriter	back to summary
public HtmlDocletWriter newDocFileWriter(DocPath path, DocFileElement dfElement) Returns a new writer for a "doc-file" page. Returns:HtmlDocletWriter a new writer for a "doc-file" page

newDocFileWriter

back to summary

public HtmlDocletWriter newDocFileWriter(DocPath path, DocFileElement dfElement)

Returns a new writer for a "doc-file" page.

Returns:HtmlDocletWriter: a new writer for a "doc-file" page

newExternalSpecsWriter	back to summary
public HtmlDocletWriter newExternalSpecsWriter() Returns a new writer for the page listing external specifications referenced in the API. Returns:HtmlDocletWriter a new writer for the page listing external specifications referenced in the API

newExternalSpecsWriter

back to summary

public HtmlDocletWriter newExternalSpecsWriter()

Returns a new writer for the page listing external specifications referenced in the API.

Returns:HtmlDocletWriter: a new writer for the page listing external specifications referenced in the API

newHelpWriter	back to summary
public HtmlDocletWriter newHelpWriter() Returns a new writer for the "help" page. Returns:HtmlDocletWriter a new writer for the "help" page

newHelpWriter

back to summary

public HtmlDocletWriter newHelpWriter()

Returns a new writer for the "help" page.

Returns:HtmlDocletWriter: a new writer for the "help" page

newIndexWriter	back to summary
public HtmlDocletWriter newIndexWriter(DocPath path, List<Character> allFirstCharacters, List<Character> displayFirstCharacters) Returns a new writer for an "index" page. Returns:HtmlDocletWriter a new writer for an "index" page

newIndexWriter

back to summary

public HtmlDocletWriter newIndexWriter(DocPath path, List<Character> allFirstCharacters, List<Character> displayFirstCharacters)

Returns a new writer for an "index" page.

Returns:HtmlDocletWriter: a new writer for an "index" page

newMemberWriter	back to summary
public AbstractMemberWriter newMemberWriter(ClassWriter classWriter, VisibleMemberTable.Kind kind) Returns a new member writer for the members of a given class and given kind. Parameters classWriter:ClassWriter the writer for the enclosing class kind:VisibleMemberTable.Kind the kind Returns:AbstractMemberWriter the writer

newMemberWriter

back to summary

public AbstractMemberWriter newMemberWriter(ClassWriter classWriter, VisibleMemberTable.Kind kind)

Returns a new member writer for the members of a given class and given kind.

Parameters

classWriter:ClassWriter: the writer for the enclosing class
kind:VisibleMemberTable.Kind: the kind

Returns:AbstractMemberWriter

the writer

newModuleIndexWriter	back to summary
public HtmlDocletWriter newModuleIndexWriter() Returns a new writer for the "module index" page. Returns:HtmlDocletWriter a new writer for the "module index" page

newModuleIndexWriter

back to summary

public HtmlDocletWriter newModuleIndexWriter()

Returns a new writer for the "module index" page.

Returns:HtmlDocletWriter: a new writer for the "module index" page

newModuleWriter	back to summary
public HtmlDocletWriter newModuleWriter(ModuleElement mdle) Returns a new writer for the page for a module. Returns:HtmlDocletWriter a new writer for the page for a module

newModuleWriter

back to summary

public HtmlDocletWriter newModuleWriter(ModuleElement mdle)

Returns a new writer for the page for a module.

Returns:HtmlDocletWriter: a new writer for the page for a module

newNewAPIListWriter	back to summary
public HtmlDocletWriter newNewAPIListWriter() Returns a new writer for the list of new API in recent releases. Returns:HtmlDocletWriter a new writer for the list of new API in recent releases

newNewAPIListWriter

back to summary

public HtmlDocletWriter newNewAPIListWriter()

Returns a new writer for the list of new API in recent releases.

Returns:HtmlDocletWriter: a new writer for the list of new API in recent releases

newPackageIndexWriter	back to summary
public HtmlDocletWriter newPackageIndexWriter() Returns a new writer for the "package index" page. Returns:HtmlDocletWriter a new writer for the "package index" page

newPackageIndexWriter

back to summary

public HtmlDocletWriter newPackageIndexWriter()

Returns a new writer for the "package index" page.

Returns:HtmlDocletWriter: a new writer for the "package index" page

newPackageUseWriter	back to summary
public HtmlDocletWriter newPackageUseWriter(PackageElement packageElement, ClassUseMapper mapper) Returns a new writer for the "package use" page for a package. Returns:HtmlDocletWriter a new writer for the "package use" page for a package

newPackageUseWriter

back to summary

public HtmlDocletWriter newPackageUseWriter(PackageElement packageElement, ClassUseMapper mapper)

Returns a new writer for the "package use" page for a package.

Returns:HtmlDocletWriter: a new writer for the "package use" page for a package

newPackageWriter	back to summary
public HtmlDocletWriter newPackageWriter(PackageElement packageElement) Returns a new writer for the page for a package. Returns:HtmlDocletWriter a new writer for the page for a package

newPackageWriter

back to summary

public HtmlDocletWriter newPackageWriter(PackageElement packageElement)

Returns a new writer for the page for a package.

Returns:HtmlDocletWriter: a new writer for the page for a package

newPreviewListWriter	back to summary
public HtmlDocletWriter newPreviewListWriter() Returns a new writer for the list of preview API in this release. Returns:HtmlDocletWriter a new writer for the list of preview API in this release

newPreviewListWriter

back to summary

public HtmlDocletWriter newPreviewListWriter()

Returns a new writer for the list of preview API in this release.

Returns:HtmlDocletWriter: a new writer for the list of preview API in this release

newRestrictedListWriter	back to summary
public HtmlDocletWriter newRestrictedListWriter() Returns a new writer for the list of restricted methods in this release. Returns:HtmlDocletWriter a new writer for the list of restricted methods in this release

newRestrictedListWriter

back to summary

public HtmlDocletWriter newRestrictedListWriter()

Returns a new writer for the list of restricted methods in this release.

Returns:HtmlDocletWriter: a new writer for the list of restricted methods in this release

newSearchTagsWriter	back to summary
public HtmlDocletWriter newSearchTagsWriter() Returns a new writer for the page listing search tags defined in the API. Returns:HtmlDocletWriter a new writer for the page listing search tags defined in the API

newSearchTagsWriter

back to summary

public HtmlDocletWriter newSearchTagsWriter()

Returns a new writer for the page listing search tags defined in the API.

Returns:HtmlDocletWriter: a new writer for the page listing search tags defined in the API

newSearchWriter	back to summary
public HtmlDocletWriter newSearchWriter() Returns a new writer for the "search" page. Returns:HtmlDocletWriter a new writer for the "search" page

newSearchWriter

back to summary

public HtmlDocletWriter newSearchWriter()

Returns a new writer for the "search" page.

Returns:HtmlDocletWriter: a new writer for the "search" page

newSerializedFormWriter	back to summary
public HtmlDocletWriter newSerializedFormWriter() Returns a new writer for the page giving the serialized forms of classes and other type elements. Returns:HtmlDocletWriter a new writer for the page giving the serialized forms of classes and other type elements

newSerializedFormWriter

back to summary

public HtmlDocletWriter newSerializedFormWriter()

Returns a new writer for the page giving the serialized forms of classes and other type elements.

Returns:HtmlDocletWriter: a new writer for the page giving the serialized forms of classes and other type elements

newSystemPropertiesWriter	back to summary
public HtmlDocletWriter newSystemPropertiesWriter() Returns a new writer for the page listing system properties referenced in the API. Returns:HtmlDocletWriter a new writer for the page listing system properties referenced in the API

newSystemPropertiesWriter

back to summary

public HtmlDocletWriter newSystemPropertiesWriter()

Returns a new writer for the page listing system properties referenced in the API.

Returns:HtmlDocletWriter: a new writer for the page listing system properties referenced in the API

newTreeWriter	back to summary
public HtmlDocletWriter newTreeWriter(ClassTree classTree) Returns a new writer for the page showing the hierarchy of classes and their superclasses. Returns:HtmlDocletWriter a new writer for the page showing the hierarchy of classes and their superclasses

newTreeWriter

back to summary

public HtmlDocletWriter newTreeWriter(ClassTree classTree)

Returns a new writer for the page showing the hierarchy of classes and their superclasses.

Returns:HtmlDocletWriter: a new writer for the page showing the hierarchy of classes and their superclasses

public Class WriterFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail