OpenJDK 27 · jdk.javadoc.internal.html.Text · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final Text	EMPTY
public static final String	NL The newline character, to be used when creating `Content` nodes.
private final String	string

Access	Constructor and Description
private	Text(CharSequence content for the object content) Constructs an immutable text object.

Method Summary

Modifier and Type	Method and Description
public int	charCount() Overrides jdk.javadoc.internal.html.Content.charCount. Returns the number of characters of plain text content in this object.
pack-priv static int	charCount(CharSequence cs)
pack-priv static boolean	Returns: `true` if there are no `\r` characters, and `false` otherwise checkNewlines(CharSequence the characters to be checked cs) Check for the absence of `\r` characters.
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 CharSequence	Returns: the string with newlines in the form `\n` normalizeNewlines(CharSequence the string text) Returns a given string with all newlines in the form `\n`.
public static Text	Returns: the object of(CharSequence the text content content) Creates a new object containing immutable text.
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 isDiscardable stripTags

EMPTY	back to summary
public static final Text EMPTY

NL	back to summary
public static final String NL The newline character, to be used when creating `Content` nodes.

string	back to summary
private final String string

Text	back to summary
private Text(CharSequence content) Constructs an immutable text object. Parameters content:CharSequence content for the object

Method Detail

charCount	back to summary
public int charCount() Overrides jdk.javadoc.internal.html.Content.charCount. Doc from jdk.javadoc.internal.html.Content.charCount. Returns the number of characters of plain text content in this object. Annotations @Override

charCount

back to summary

public int charCount()

Overrides jdk.javadoc.internal.html.Content.charCount.

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

Returns the number of characters of plain text content in this object.

Annotations

@Override

charCount	back to summary
pack-priv static int charCount(CharSequence cs)

checkNewlines back to summary

checkNewlines	back to summary
pack-priv static boolean checkNewlines(CharSequence cs) Check for the absence of `\r` characters. Parameters cs:CharSequence the characters to be checked Returns:boolean `true` if there are no `\r` characters, and `false` otherwise

pack-priv static boolean checkNewlines(CharSequence cs)

Check for the absence of \r characters.

Parameters

cs:CharSequence: the characters to be checked

Returns:boolean

true if there are no \r characters, and false otherwise

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

normalizeNewlines back to summary

normalizeNewlines	back to summary
public static CharSequence normalizeNewlines(CharSequence text) Returns a given string with all newlines in the form `\n`. The sequences of interest are `\n`, `\r\n`, and `\r`. `\n` is already in the right form, so can be ignored, leaving code to handle `\r\n`, and `\r`. Parameters text:CharSequence the string Returns:CharSequence the string with newlines in the form `\n`

public static CharSequence normalizeNewlines(CharSequence text)

Returns a given string with all newlines in the form \n. The sequences of interest are \n, \r\n, and \r. \n is already in the right form, so can be ignored, leaving code to handle \r\n, and \r.

Parameters

text:CharSequence: the string

Returns:CharSequence

the string with newlines in the form \n

of	back to summary
public static Text of(CharSequence content) Creates a new object containing immutable text. Parameters content:CharSequence the text content Returns:Text the object

back to summary

public static Text of(CharSequence content)

Creates a new object containing immutable text.

Parameters

content:CharSequence: the text content

Returns:Text

the object

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

public Class Text

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail