APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html.markup

public Class HtmlDocument

extends Object
Class Inheritance
Imports
java.io.IOException, .StringWriter, .Writer, jdk.javadoc.internal.doclets.toolkit.util.DocFile, .DocFileIOException, jdk.javadoc.internal.html.Content, .DocType, .HtmlTag
Class for generating an HTML document for javadoc output.

Field Summary

Modifier and TypeField and Description
private final Content
docContent

private final DocType
docType

Constructor Summary

AccessConstructor and Description
public
HtmlDocument(Content
the HTML element of the document
html)

Constructs an HTML document.

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
write(DocFile
the file
docFile)

Writes the content of this document to the specified file.

private void
write(Writer writer, String newline)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

docContentback to summary
private final Content docContent
docTypeback to summary
private final DocType docType

Constructor Detail

HtmlDocumentback to summary
public HtmlDocument(Content html)

Constructs an HTML document.

Parameters
html:Content

the HTML element of the document

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
writeback to summary
public void write(DocFile docFile) throws DocFileIOException

Writes the content of this document to the specified file. Newlines are written using the platform line separator.

Parameters
docFile:DocFile

the file

Exceptions
DocFileIOException:
if an IOException occurs while writing the file
writeback to summary
private void write(Writer writer, String newline) throws IOException