Package org.tealeaf.javamarkdown.elements

Class Header

java.lang.Object

org.tealeaf.javamarkdown.MarkdownElement

org.tealeaf.javamarkdown.types.Structure

org.tealeaf.javamarkdown.elements.Header

public class Header
extends Structure

Represents a header in a markdown document. This will render the content in a large font, depending on the header size

Since:

0.0.12

Author:

Thomas Kwashnak

Constructor Summary

Constructors

Constructor	Description
Header(int level, Object content)	Creates a new header of a specified level.
Header(Object content)	Creates a new level-1 header

Method Summary

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

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

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

Constructor Details

Header

public Header(Object content)

Creates a new level-1 header

Parameters:

content - Content to display in the header

Since:

0.0.12

Header

public Header(int level,
 Object content)

Creates a new header of a specified level.

Parameters:

level - The header level to display. Can only be a number between 1-6

content - The content to display in the header

Throws:

IllegalHeaderLevelException - if a level not within 1-6 is passed

Since:

0.0.12

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.12