com.atlassian.bitbucket.markup

Interface MarkupService

public interface MarkupService

Renders content to markup using a pipeline of handlers, such as updating mentions and linking to Jira issues.

Method Summary

Modifier and Type	Method and Description
String	render(String content, RenderContext renderContext) Renders a given string into HTML.
void	stream(Reader reader, Appendable writer, RenderContext renderContext) Streams a given string into HTML, appending the results to a given writer.

Method Detail

render

@Nonnull
String render(@Nonnull
                       String content,
                       @Nonnull
                       RenderContext renderContext)
                throws RenderException

Renders a given string into HTML.

Parameters:

content - that should be the standard markup type

renderContext - which contains data for rendering in this context

Returns:

an HTML string

Throws:

RenderException - when there an error rendering the markup

stream

void stream(@Nonnull
            Reader reader,
            @Nonnull
            Appendable writer,
            @Nonnull
            RenderContext renderContext)
     throws RenderException

Streams a given string into HTML, appending the results to a given writer.

Parameters:

reader - that should be the standard markup type

writer - for streaming the results

renderContext - which contains data for rendering in this context

Throws:

RenderException - when there an error streaming the markup