net.steppschuh.markdowngenerator.rule

Class HorizontalRule

java.lang.Object

net.steppschuh.markdowngenerator.MarkdownElement

net.steppschuh.markdowngenerator.rule.HorizontalRule

All Implemented Interfaces:

MarkdownSerializable

public class HorizontalRule
extends MarkdownElement

Created by steppschuh on 16/12/2016.

Field Summary

Fields

Modifier and Type	Field and Description
static char	ASTERISK
static char	HYPHEN
static int	MINIMUM_LENGTH
static char	UNDERSCORE

Constructor Summary

Constructors

Constructor and Description
HorizontalRule()
HorizontalRule(int length)
HorizontalRule(int length, char character)

Method Summary

Modifier and Type	Method and Description
java.lang.String	serialize() Attempts to generate a String representing this markdown element.

Methods inherited from class net.steppschuh.markdowngenerator.MarkdownElement

getSerialized, getSerialized, invalidateSerialized, setSerialized, toMarkdownElement, toString

Methods inherited from class java.lang.Object

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

Field Detail

HYPHEN

public static final char HYPHEN

See Also:

Constant Field Values

ASTERISK

public static final char ASTERISK

See Also:

Constant Field Values

UNDERSCORE

public static final char UNDERSCORE

See Also:

Constant Field Values

MINIMUM_LENGTH

public static final int MINIMUM_LENGTH

See Also:

Constant Field Values

Constructor Detail

HorizontalRule

public HorizontalRule()

HorizontalRule

public HorizontalRule(int length)

HorizontalRule

public HorizontalRule(int length,
                      char character)

Method Detail

serialize

public java.lang.String serialize()
                           throws MarkdownSerializationException

Description copied from class: MarkdownElement

Attempts to generate a String representing this markdown element.

Specified by:

serialize in class MarkdownElement

Returns:

Markdown as String

Throws:

MarkdownSerializationException - If unable to generate a markdown String