Package org.apache.juneau.marshall.markdown

Class MarkdownBeanPropertyMeta

java.lang.Object

org.apache.juneau.marshall.ExtendedMeta

org.apache.juneau.marshall.ExtendedBeanPropertyMeta

org.apache.juneau.marshall.markdown.MarkdownBeanPropertyMeta

public class MarkdownBeanPropertyMeta
extends ExtendedBeanPropertyMeta

Metadata on bean properties specific to the Markdown serializers and parsers pulled from the @Markdown annotation on the bean property.

Field Summary

Fields

Modifier and Type	Field	Description
static final MarkdownBeanPropertyMeta	DEFAULT	Default instance.

Constructor Summary

Constructors

Constructor	Description
MarkdownBeanPropertyMeta(BeanPropertyMeta bpm, MarkdownMetaProvider mp)	Constructor.

Method Summary

Modifier and Type	Method	Description
MarkdownFormat	getFormat()	Returns the rendering format for this property.
String	getHeading()	Returns the custom heading text for document-mode rendering.
String	getLink()	Returns the link template for rendering this property as a Markdown link.
boolean	isCode()	Returns whether the value should be rendered as inline code.
boolean	isNoHeaders()	Returns whether table header rows should be suppressed.
boolean	isNoTables()	Returns whether tables should be suppressed for this property's collection value.

Methods inherited from class org.apache.juneau.marshall.ExtendedBeanPropertyMeta

getBeanPropertyMeta

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final MarkdownBeanPropertyMeta DEFAULT

Default instance.

Constructor Details

MarkdownBeanPropertyMeta

public MarkdownBeanPropertyMeta(BeanPropertyMeta bpm,
 MarkdownMetaProvider mp)

Constructor.

Parameters:

bpm - The metadata of the bean property of this additional metadata.

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

Method Details

getFormat

public MarkdownFormat getFormat()

Returns the rendering format for this property.

Returns:

The format.

getHeading

public String getHeading()

Returns the custom heading text for document-mode rendering.

Returns:

The heading, or empty string if not specified.

isNoTables

public boolean isNoTables()

Returns whether tables should be suppressed for this property's collection value.

Returns:

Whether no-tables is set.

isNoHeaders

public boolean isNoHeaders()

Returns whether table header rows should be suppressed.

Returns:

Whether no-headers is set.

isCode

public boolean isCode()

Returns whether the value should be rendered as inline code.

Returns:

Whether code rendering is enabled.

getLink

public String getLink()

Returns the link template for rendering this property as a Markdown link.

Returns:

The link template, or empty string if not specified.