Package org.apache.juneau.html

Class HtmlClassMeta

java.lang.Object

org.apache.juneau.ExtendedMeta

org.apache.juneau.ExtendedClassMeta

org.apache.juneau.html.HtmlClassMeta

public class HtmlClassMeta
extends ExtendedClassMeta

Metadata on classes specific to the HTML serializers and parsers pulled from the @Html annotation on the class.

See Also:

• HTML Basics

Constructor Summary

Constructors

Constructor	Description
HtmlClassMeta(ClassMeta<?> cm, HtmlMetaProvider mp)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected HtmlFormat	getFormat()	Returns the @Html(format) annotation defined on the class.
HtmlRender<?>	getRender()	Returns the @Html(render) annotation defined on the class.
protected boolean	isHtml()	Returns true if getFormat() returns HtmlFormat.HTML.
protected boolean	isHtmlCdc()	Returns true if getFormat() returns HtmlFormat.HTML_CDC.
protected boolean	isHtmlSdc()	Returns true if getFormat() returns HtmlFormat.HTML_SDC.
boolean	isNoTableHeaders()	Returns the @Html(noTableHeaders) annotation defined on the class.
protected boolean	isNoTables()	Returns the @Html(noTables) annotation defined on the class.
protected boolean	isPlainText()	Returns true if getFormat() returns HtmlFormat.PLAIN_TEXT.
protected boolean	isXml()	Returns true if getFormat() returns HtmlFormat.XML.

Methods inherited from class org.apache.juneau.ExtendedClassMeta

getClassMeta, getInnerClass

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HtmlClassMeta

public HtmlClassMeta(ClassMeta<?> cm,
 HtmlMetaProvider mp)

Constructor.

Parameters:

cm - The class that this annotation is defined on.

mp - HTML metadata provider (for finding information about other artifacts).

Method Details

getFormat

protected HtmlFormat getFormat()

Returns the @Html(format) annotation defined on the class.

Returns:

The value of the annotation.

isXml

protected boolean isXml()

Returns true if getFormat() returns HtmlFormat.XML.

Returns:

true if getFormat() returns HtmlFormat.XML.

isPlainText

protected boolean isPlainText()

Returns true if getFormat() returns HtmlFormat.PLAIN_TEXT.

Returns:

true if getFormat() returns HtmlFormat.PLAIN_TEXT.

isHtml

protected boolean isHtml()

Returns true if getFormat() returns HtmlFormat.HTML.

Returns:

true if getFormat() returns HtmlFormat.HTML.

isHtmlCdc

protected boolean isHtmlCdc()

Returns true if getFormat() returns HtmlFormat.HTML_CDC.

Returns:

true if getFormat() returns HtmlFormat.HTML_CDC.

isHtmlSdc

protected boolean isHtmlSdc()

Returns true if getFormat() returns HtmlFormat.HTML_SDC.

Returns:

true if getFormat() returns HtmlFormat.HTML_SDC.

isNoTables

protected boolean isNoTables()

Returns the @Html(noTables) annotation defined on the class.

Returns:

The value of the annotation.

isNoTableHeaders

public boolean isNoTableHeaders()

Returns the @Html(noTableHeaders) annotation defined on the class.

Returns:

The value of the annotation.

getRender

public HtmlRender<?> getRender()

Returns the @Html(render) annotation defined on the class.

Returns:

The value of the annotation.