com.jcabi.github.mock

Class MkMarkdown

java.lang.Object

com.jcabi.github.mock.MkMarkdown

All Implemented Interfaces:

Markdown

@Immutable
@Loggable(value=1)
public final class MkMarkdown
extends Object
implements Markdown

Mock markdown API.

Since:

0.10

Version:

$Id$

Author:

Andrej Istomin (andrej.istomin.ikeen@gmail.com)

Constructor Summary

Constructors

Constructor and Description
MkMarkdown(Github github) Creates new instance.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

MkMarkdown

public MkMarkdown(Github github)

Creates new instance.

Parameters:

github - Owner github

Method Detail

github

@NotNull(message="Github can\'t be NULL")
public Github github()

Description copied from interface: Markdown

Get its owner.

Specified by:

github in interface Markdown

Returns:

Github

render

@NotNull(message="Rendered string can\'t be NULL")
public String render(@NotNull(message="JSON can\'t be NULL")
                           javax.json.JsonObject json)

Description copied from interface: Markdown

Render.

Specified by:

render in interface Markdown

Parameters:

json - JSON parameters

Returns:

HTML

raw

@NotNull(message="Rendered string can\'t be NULL")
public String raw(@NotNull(message="Markdown can\'t be NULL")
                        String text)

Description copied from interface: Markdown

Raw rendering.

Specified by:

raw in interface Markdown

Parameters:

text - Text in Markdown format

Returns:

HTML