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

Access	Constructor and Description
public	Content()

Method Summary

Modifier and Type	Method and Description
public Content	Returns: this object add(Content content to be added content) Adds content to the existing content.
public Content	Returns: this object add(CharSequence the string content to be added stringContent) Adds a string content to the existing content.
public <T> Content	Returns: this object addAll(Collection<T> the items to be added items, Function<T, Content> the function to create content for each item mapper) Adds content to the existing content, generated from a collection of items This is an optional operation.
public int	Returns: the number of characters of plain text content in this object charCount() Returns the number of characters of plain text content in this object.
public boolean	Returns: true if this content can be discarded without affecting the output isDiscardable() Returns true if this content does not affect the output and can be discarded.
public abstract boolean	Returns: true if no content to be displayed else return false isEmpty() Returns true if the content is empty.
public boolean	Returns: true if the content is "phrasing content" isPhrasingContent() Returns true if the content is "phrasing content".
public Content	Returns: the plain text of this content with HTML tags removed stripTags() Returns the plain text of this content with HTML tags removed.
public String	Returns: string representation of the content toString() Overrides java.lang.Object.toString. Returns a string representation of the content.
public abstract boolean	Returns: whether the writer has just written a newline write(Writer the writer writer, String the newline sequence to use newline, boolean whether the writer has just written a newline atNewline) Writes content to a writer, using a given newline sequence, which should be either `\n` or the platform line separator.

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

Content	back to summary
public Content()

Method Detail

add	back to summary
public Content add(Content content) Adds content to the existing content. This is an optional operation. Implementation Specification This implementation throws UnsupportedOperationException. Parameters content:Content content to be added Returns:Content this object Exceptions UnsupportedOperationException: if this operation is not supported by a particular implementation IllegalArgumentException: if the content is not suitable to be added

add

back to summary

public Content add(Content content)

Adds content to the existing content. This is an optional operation.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters

content:Content: content to be added

Returns:Content

this object

Exceptions

UnsupportedOperationException:: if this operation is not supported by a particular implementation
IllegalArgumentException:: if the content is not suitable to be added

add	back to summary
public Content add(CharSequence stringContent) Adds a string content to the existing content. This is an optional operation. Implementation Specification This implementation throws UnsupportedOperationException. Parameters stringContent:CharSequence the string content to be added Returns:Content this object Exceptions UnsupportedOperationException: if this operation is not supported by a particular implementation IllegalArgumentException: if the content is not suitable to be added

add

back to summary

public Content add(CharSequence stringContent)

Adds a string content to the existing content. This is an optional operation.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters

stringContent:CharSequence: the string content to be added

Returns:Content

this object

Exceptions

UnsupportedOperationException:: if this operation is not supported by a particular implementation
IllegalArgumentException:: if the content is not suitable to be added

addAll back to summary

addAll	back to summary
public <T> Content addAll(Collection<T> items, Function<T, Content> mapper) Adds content to the existing content, generated from a collection of items This is an optional operation. Implementation Specification This implementation delegates to `add(Content)`. Parameters items:Collection<T> the items to be added mapper:Function<T, Content> the function to create content for each item Returns:Content this object Exceptions UnsupportedOperationException: if this operation is not supported by a particular implementation IllegalArgumentException: if the content is not suitable to be added

public <T> Content addAll(Collection<T> items, Function<T, Content> mapper)

Adds content to the existing content, generated from a collection of items This is an optional operation.

Implementation Specification

This implementation delegates to add(Content).

Parameters

items:Collection<T>: the items to be added
mapper:Function<T, Content>: the function to create content for each item

Returns:Content

this object

Exceptions

UnsupportedOperationException:: if this operation is not supported by a particular implementation
IllegalArgumentException:: if the content is not suitable to be added

charCount	back to summary
public int charCount() Returns the number of characters of plain text content in this object. Returns:int the number of characters of plain text content in this object

charCount

back to summary

public int charCount()

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

Returns:int: the number of characters of plain text content in this object

isDiscardable	back to summary
public boolean isDiscardable() Returns true if this content does not affect the output and can be discarded. The default implementation considers empty content as discardable. Returns:boolean true if this content can be discarded without affecting the output

isDiscardable

back to summary

public boolean isDiscardable()

Returns true if this content does not affect the output and can be discarded. The default implementation considers empty content as discardable.

Returns:boolean: true if this content can be discarded without affecting the output

isEmpty	back to summary
public abstract boolean isEmpty() Returns true if the content is empty. Returns:boolean true if no content to be displayed else return false

isEmpty

back to summary

public abstract boolean isEmpty()

Returns true if the content is empty.

Returns:boolean: true if no content to be displayed else return false

isPhrasingContent	back to summary
public boolean 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. Returns:boolean true if the content is "phrasing content" See Also Phrasing content

isPhrasingContent

back to summary

public boolean 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.

Returns:boolean: true if the content is "phrasing content"
See Also: Phrasing content

stripTags	back to summary
public Content stripTags() Returns the plain text of this content with HTML tags removed. Returns:Content the plain text of this content with HTML tags removed

stripTags

back to summary

public Content stripTags()

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

Returns:Content: the plain text of this content with HTML tags removed

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of the content. Newlines are represented by `\n`. Returns:String string representation of the content Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

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

Returns:String

string representation of the content

Annotations

@Override

write back to summary

write	back to summary
public abstract boolean write(Writer writer, String newline, boolean atNewline) throws IOException Writes content to a writer, using a given newline sequence, which should be either `\n` or the platform line separator. Parameters writer:Writer the writer newline:String the newline sequence to use atNewline:boolean whether the writer has just written a newline Returns:boolean whether the writer has just written a newline Exceptions IOException: if an error occurs while writing the output

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

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

Parameters

writer:Writer: the writer
newline:String: the newline sequence to use
atNewline:boolean: whether the writer has just written a newline

Returns:boolean

whether the writer has just written a newline

Exceptions

IOException:: if an error occurs while writing the output

public abstract Class Content

Constructor Summary

Method Summary

Constructor Detail

Method Detail