Package org.tealeaf.javamarkdown.types

Class Markup

java.lang.Object

org.tealeaf.javamarkdown.MarkdownElement

org.tealeaf.javamarkdown.types.InlineElement

org.tealeaf.javamarkdown.types.Markup

Direct Known Subclasses:

Bold, Code, Italic, Strikethrough

public class Markup
extends InlineElement

Represents markdown elements that indicates a simple markup syntax to the content text, such as **words** to indicate bold text.

Since:

0.0.1

Author:

Thomas Kwashnak

Field Summary

Fields

Modifier and Type	Field	Description
protected final Object	object	Object to insert into the markup
protected final String	syntax	The syntax used in the markup language

Constructor Summary

Constructors

Constructor	Description
Markup(Object object, String syntax)	Creates a new markup element with a content object and the wrapping syntax

Method Summary

Modifier and Type	Method	Description
String	asString()	Formats the element to a string

Methods inherited from class org.tealeaf.javamarkdown.types.InlineElement

checkType, requiresNewlineAfter, requiresNewlineBefore

Methods inherited from class org.tealeaf.javamarkdown.MarkdownElement

asString, toAppendable, toString, toWriter

Methods inherited from class java.lang.Object

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

Field Details

syntax

protected final String syntax

The syntax used in the markup language

object

protected final Object object

Object to insert into the markup

Constructor Details

Markup

public Markup(Object object,
 String syntax)

Creates a new markup element with a content object and the wrapping syntax

Parameters:

object - Content object to display

syntax - String syntax to put on either side of the content

Since:

0.0.1

Method Details

asString

public String asString()

Formats the element to a string

Specified by:

asString in class MarkdownElement

Returns:

String representation of the formatted item

Since:

0.0.9