net.steppschuh.markdowngenerator

Class MarkdownElement

java.lang.Object

net.steppschuh.markdowngenerator.MarkdownElement

All Implemented Interfaces:

MarkdownSerializable

Direct Known Subclasses:

HorizontalRule, Link, ProgressBar, Table, TableRow, Text, UnorderedList

public abstract class MarkdownElement
extends java.lang.Object
implements MarkdownSerializable

Base class that every markdown element extends.

Constructor Summary

Constructors

Constructor and Description
MarkdownElement()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSerialized() Calls serialize() or directly returns its last result from serialized.
java.lang.String	getSerialized(java.lang.String fallback) Returns the result of getSerialized() or the specified fallback if a MarkdownSerializationException occurred.
void	invalidateSerialized() Sets serialized to null.
abstract java.lang.String	serialize() Attempts to generate a String representing this markdown element.
void	setSerialized(java.lang.String serialized)
MarkdownElement	toMarkdownElement()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkdownElement

public MarkdownElement()

Method Detail

serialize

public abstract java.lang.String serialize()
                                    throws MarkdownSerializationException

Attempts to generate a String representing this markdown element.

Returns:

Markdown as String

Throws:

MarkdownSerializationException - If unable to generate a markdown String

getSerialized

public java.lang.String getSerialized(java.lang.String fallback)

Returns the result of getSerialized() or the specified fallback if a MarkdownSerializationException occurred.

Parameters:

fallback - String to return if serialization fails

Returns:

Markdown as String or specified fallback

getSerialized

public java.lang.String getSerialized()
                               throws MarkdownSerializationException

Calls serialize() or directly returns its last result from serialized.

Returns:

Markdown as String

Throws:

MarkdownSerializationException - If unable to generate a markdown String

setSerialized

public void setSerialized(java.lang.String serialized)

invalidateSerialized

public void invalidateSerialized()

Sets serialized to null. The next call to getSerialized() fill invoke a fresh serialization.

toMarkdownElement

public MarkdownElement toMarkdownElement()
                                  throws MarkdownSerializationException

Specified by:

toMarkdownElement in interface MarkdownSerializable

Throws:

MarkdownSerializationException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object