com.jcabi.github

Interface Markdown

All Known Implementing Classes:

MkMarkdown

@Immutable
public interface Markdown

Markdown API.

Since:

0.6

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Markdown API

Method Summary

Methods

Modifier and Type	Method and Description
Github	github() Get its owner.
String	raw(String text) Raw rendering.
String	render(javax.json.JsonObject json) Render.

Method Detail

github

@NotNull(message="github is never NULL")
Github github()

Get its owner.

Returns:

Github

render

@NotNull(message="HTML object is never NULL")
String render(@NotNull(message="JSON can\'t be NULL")
                           javax.json.JsonObject json)
              throws IOException

Render.

Parameters:

json - JSON parameters

Returns:

HTML

Throws:

IOException - If it fails due to I/O problem

raw

@NotNull(message="HTML of issues is never NULL")
String raw(@NotNull(message="Markdown can\'t be NULL")
                        String text)
           throws IOException

Raw rendering.

Parameters:

text - Text in Markdown format

Returns:

HTML

Throws:

IOException - If it fails due to I/O problem