Modifier and Type	Class and Description
private static enum	RawHtml.State

Modifier and Type	Field and Description
protected final String	rawHtmlContent
pack-priv Pattern	tag

Access	Constructor and Description
private	RawHtml(CharSequence raw HTML text to be added rawHtml) Constructor to construct a RawHtml object.

Method Summary

Modifier and Type	Method and Description
public static RawHtml	Returns: the HTML cdata(String the body of the CDATA section body) Creates HTML for an HTML CDATA section.
protected static int	charCount(CharSequence htmlText)
public static RawHtml	Returns: the HTML comment(String the body of the comment body) Creates HTML for an HTML comment.
public static RawHtml	Returns: the HTML endElement(CharSequence the name of the element name) Creates HTML for the end of an element.
public boolean	isEmpty() Implements abstract jdk.javadoc.internal.html.Content.isEmpty. Returns true if the content is empty.
public boolean	isPhrasingContent() Overrides jdk.javadoc.internal.html.Content.isPhrasingContent. Returns true if the content is "phrasing content".
public static RawHtml	Returns: the HTML markdown(CharSequence the fragment markdownOutput) Creates HTML for a fragment of Markdown output.
public static RawHtml	Returns: the HTML of(CharSequence the string rawHtml) Creates HTML for an arbitrary string of HTML.
private static RawHtml	section(String prefix, String body, String suffix)
public static RawHtml	Returns: the HTML startElement(CharSequence the name of the element name, Content content containing any attributes attrs, boolean whether this is a self-closing element. selfClosing) Creates HTML for the start of an element.
public Content	stripTags() Overrides jdk.javadoc.internal.html.Content.stripTags. Returns the plain text of this content with HTML tags removed.
public String	toString() Overrides jdk.javadoc.internal.html.Content.toString. Returns a string representation of the content.
public boolean	write(Writer out, String newline, boolean atNewline) Implements abstract jdk.javadoc.internal.html.Content.write. Writes content to a writer, using a given newline sequence, which should be either `\n` or the platform line separator.

Inherited from jdk.javadoc.internal.html.Content:: add add addAll charCount isDiscardable

Field Detail

rawHtmlContent	back to summary
protected final String rawHtmlContent

tag	back to summary
pack-priv Pattern tag

Constructor Detail

RawHtml	back to summary
private RawHtml(CharSequence rawHtml) Constructor to construct a RawHtml object. Parameters rawHtml:CharSequence raw HTML text to be added

RawHtml

back to summary

private RawHtml(CharSequence rawHtml)

Constructor to construct a RawHtml object.

Parameters

rawHtml:CharSequence: raw HTML text to be added

Method Detail

cdata back to summary

cdata	back to summary
public static RawHtml cdata(String body) Creates HTML for an HTML CDATA section. The body will be enclosed in `<![CDATA]` and `]]>` if it does not already begin and end with those sequences. Parameters body:String the body of the CDATA section Returns:RawHtml the HTML

public static RawHtml cdata(String body)

Creates HTML for an HTML CDATA section. The body will be enclosed in <![CDATA] and ]]> if it does not already begin and end with those sequences.

Parameters

body:String: the body of the CDATA section

Returns:RawHtml

the HTML

charCount	back to summary
protected static int charCount(CharSequence htmlText)

comment back to summary

comment	back to summary
public static RawHtml comment(String body) Creates HTML for an HTML comment. The body will be enclosed in `<!--` and `-->` if it does not already begin and end with those sequences. Parameters body:String the body of the comment Returns:RawHtml the HTML

public static RawHtml comment(String body)

Creates HTML for an HTML comment. The body will be enclosed in  if it does not already begin and end with those sequences.

Parameters

body:String: the body of the comment

Returns:RawHtml

the HTML

endElement	back to summary
public static RawHtml endElement(CharSequence name) Creates HTML for the end of an element. Parameters name:CharSequence the name of the element Returns:RawHtml the HTML

endElement

back to summary

public static RawHtml endElement(CharSequence name)

Creates HTML for the end of an element.

Parameters

name:CharSequence: the name of the element

Returns:RawHtml

the HTML

isEmpty	back to summary
public boolean isEmpty() Implements abstract jdk.javadoc.internal.html.Content.isEmpty. Doc from jdk.javadoc.internal.html.Content.isEmpty. Returns true if the content is empty. Annotations @Override

isEmpty

back to summary

public boolean isEmpty()

Implements abstract jdk.javadoc.internal.html.Content.isEmpty.

Doc from jdk.javadoc.internal.html.Content.isEmpty.

Returns true if the content is empty.

Annotations

@Override

isPhrasingContent	back to summary
public boolean isPhrasingContent() Overrides jdk.javadoc.internal.html.Content.isPhrasingContent. Doc from jdk.javadoc.internal.html.Content.isPhrasingContent. Returns true if the content is "phrasing content". Phrasing content is content that may appear in a paragraph, such as text, or certain HTML elements. Annotations @Override

isPhrasingContent

back to summary

public boolean isPhrasingContent()

Overrides jdk.javadoc.internal.html.Content.isPhrasingContent.

Doc from jdk.javadoc.internal.html.Content.isPhrasingContent.

Returns true if the content is "phrasing content". Phrasing content is content that may appear in a paragraph, such as text, or certain HTML elements.

Annotations

@Override

markdown	back to summary
public static RawHtml markdown(CharSequence markdownOutput) Creates HTML for a fragment of Markdown output. Parameters markdownOutput:CharSequence the fragment Returns:RawHtml the HTML

markdown

back to summary

public static RawHtml markdown(CharSequence markdownOutput)

Creates HTML for a fragment of Markdown output.

Parameters

markdownOutput:CharSequence: the fragment

Returns:RawHtml

the HTML

of back to summary

of	back to summary
public static RawHtml of(CharSequence rawHtml) Creates HTML for an arbitrary string of HTML. The string is accepted as-is and is not validated in any way. It should be syntactically well-formed and contain matching `<` and `>`, and matching quotes for attributes. Parameters rawHtml:CharSequence the string Returns:RawHtml the HTML

public static RawHtml of(CharSequence rawHtml)

Creates HTML for an arbitrary string of HTML. The string is accepted as-is and is not validated in any way. It should be syntactically well-formed and contain matching < and >, and matching quotes for attributes.

Parameters

rawHtml:CharSequence: the string

Returns:RawHtml

the HTML

section	back to summary
private static RawHtml section(String prefix, String body, String suffix)

startElement	back to summary
public static RawHtml startElement(CharSequence name, Content attrs, boolean selfClosing) Creates HTML for the start of an element. Parameters name:CharSequence the name of the element attrs:Content content containing any attributes selfClosing:boolean whether this is a self-closing element. Returns:RawHtml the HTML

startElement

back to summary

public static RawHtml startElement(CharSequence name, Content attrs, boolean selfClosing)

Creates HTML for the start of an element.

Parameters

name:CharSequence: the name of the element
attrs:Content: content containing any attributes
selfClosing:boolean: whether this is a self-closing element.

Returns:RawHtml

the HTML

stripTags	back to summary
public Content stripTags() Overrides jdk.javadoc.internal.html.Content.stripTags. Doc from jdk.javadoc.internal.html.Content.stripTags. Returns the plain text of this content with HTML tags removed. Annotations @Override

stripTags

back to summary

public Content stripTags()

Overrides jdk.javadoc.internal.html.Content.stripTags.

Doc from jdk.javadoc.internal.html.Content.stripTags.

Returns the plain text of this content with HTML tags removed.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides jdk.javadoc.internal.html.Content.toString. Doc from jdk.javadoc.internal.html.Content.toString. Returns a string representation of the content. Newlines are represented by `\n`. Annotations @Override

public String toString()

Overrides jdk.javadoc.internal.html.Content.toString.

Doc from jdk.javadoc.internal.html.Content.toString.

Returns a string representation of the content. Newlines are represented by \n.

Annotations

@Override

write back to summary

write	back to summary
public boolean write(Writer out, String newline, boolean atNewline) throws IOException Implements abstract jdk.javadoc.internal.html.Content.write. Doc from jdk.javadoc.internal.html.Content.write. Writes content to a writer, using a given newline sequence, which should be either `\n` or the platform line separator. Annotations @Override Exceptions IOException: if an error occurs while writing the output

public boolean write(Writer out, String newline, boolean atNewline) throws IOException

Implements abstract jdk.javadoc.internal.html.Content.write.

Doc from jdk.javadoc.internal.html.Content.write.

Writes content to a writer, using a given newline sequence, which should be either \n or the platform line separator.

Annotations

@Override

Exceptions

IOException:: if an error occurs while writing the output

jdk.javadoc.internal.html back to summary

private final Enum RawHtml.State

Class Inheritance

extends Enum<RawHtml.State>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.html.RawHtml.State

Field Summary

Modifier and Type	Field and Description
public static final RawHtml.State	ENTITY
public static final RawHtml.State	STRING
public static final RawHtml.State	TAG
public static final RawHtml.State	TEXT

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static RawHtml.State	valueOf(String name)
public static RawHtml.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ENTITY	back to summary
public static final RawHtml.State ENTITY

STRING	back to summary
public static final RawHtml.State STRING

TAG	back to summary
public static final RawHtml.State TAG

TEXT	back to summary
public static final RawHtml.State TEXT

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static RawHtml.State valueOf(String name)

values	back to summary
public static RawHtml.State[] values()

public Class RawHtml

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum RawHtml.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail