com.jdroid.github.service

Class MarkdownService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.MarkdownService

public class MarkdownService
extends GitHubService

Service to request Markdown text to be rendered as HTML

See Also:

GitHub Markdown API documentation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODE_GFM GitHub-flavored Markdown mode
static java.lang.String	MODE_MARKDOWN Default Markdown mode

Fields inherited from class com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
MarkdownService() Create Markdown service
MarkdownService(GitHubClient client) Create Markdown service for client

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHtml(java.lang.String text, java.lang.String mode) Get HTML for given Markdown text
java.lang.String	getRepositoryHtml(IRepositoryIdProvider repo, java.lang.String text) Get HTML for given Markdown text scoped to given repository context
java.io.InputStream	getRepositoryStream(IRepositoryIdProvider repo, java.lang.String text) Get stream of HTML for given Markdown text scoped to given repository context
java.io.InputStream	getStream(java.lang.String text, java.lang.String mode) Get stream of HTML for given Markdown text

Methods inherited from class com.jdroid.github.service.GitHubService

check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

Methods inherited from class java.lang.Object

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

Field Detail

MODE_GFM

public static final java.lang.String MODE_GFM

GitHub-flavored Markdown mode

See Also:

Constant Field Values

MODE_MARKDOWN

public static final java.lang.String MODE_MARKDOWN

Default Markdown mode

See Also:

Constant Field Values

Constructor Detail

MarkdownService

public MarkdownService()

Create Markdown service

MarkdownService

public MarkdownService(GitHubClient client)

Create Markdown service for client

Parameters:

client -

Method Detail

getRepositoryStream

public java.io.InputStream getRepositoryStream(IRepositoryIdProvider repo,
                                               java.lang.String text)
                                        throws java.io.IOException

Get stream of HTML for given Markdown text scoped to given repository context

Parameters:

repo -

text -

Returns:

stream of HTML

Throws:

java.io.IOException

getRepositoryHtml

public java.lang.String getRepositoryHtml(IRepositoryIdProvider repo,
                                          java.lang.String text)
                                   throws java.io.IOException

Get HTML for given Markdown text scoped to given repository context

Parameters:

repo -

text -

Returns:

HTML

Throws:

java.io.IOException

getStream

public java.io.InputStream getStream(java.lang.String text,
                                     java.lang.String mode)
                              throws java.io.IOException

Get stream of HTML for given Markdown text

Use getRepositoryStream(IRepositoryIdProvider, String) if you want the Markdown scoped to a specific repository.

Parameters:

text -

mode -

Returns:

stream of HTML

Throws:

java.io.IOException

getHtml

public java.lang.String getHtml(java.lang.String text,
                                java.lang.String mode)
                         throws java.io.IOException

Get HTML for given Markdown text

Use getRepositoryHtml(IRepositoryIdProvider, String) if you want the Markdown scoped to a specific repository.

Parameters:

text -

mode -

Returns:

HTML

Throws:

java.io.IOException