In package com.eden.orchid.api.render

@ImplementedBy(
    value=RenderServiceImpl)
public interface interface RenderService extends OrchidService

since: v1.0.0 public abstract

Methods

String getKey() public
Method Annotations:
@Override

void includeDrafts() public since: v1.0.0

Whether to exclude drafts, which is the default behavior, or whether to include them.

InputStream getRenderedTemplate(OrchidPage page) public since: v1.0.0

Render the given page with the default template determined by the page, returning an InputStream representing the final contents. The layout chosen for the page is determined by {@link TemplateResolutionStrategy}.

Parameters:
void renderTemplate(OrchidPage page) public since: v1.0.0

Render the given page with the default template determined by the page, producing a side-effect as the intended final output. The layout chosen for the page is determined by {@link TemplateResolutionStrategy}.

Parameters:
InputStream getRenderedString(OrchidPage page, String extension, String templateString) public since: v1.0.0

Render the given page using a literal String as a template, returning an InputStream representing the final contents. More useful for testing, as templates should be preferred for the ability to be overridden.

Parameters:
  • OrchidPage page

    the page to render
  • String extension

    the extension that the content represents and should be compiled against
  • String templateString

    the template string
void renderString(OrchidPage page, String extension, String templateString) public since: v1.0.0

Render the given page using a literal String as a template, producing a side-effect as the intended final output. More useful for testing, as templates should be preferred for the ability to be overridden.

Parameters:
  • OrchidPage page

    the page to render
  • String extension

    the extension that the content represents and should be compiled against
  • String templateString

    the template string to render * @return if the page was not skipped, the result of {@link OrchidRenderer} indicating whether the page was successfully rendered, false otherwise
InputStream getRenderedRaw(OrchidPage page) public since: v1.0.0

Render the content of a page directly, without any template, returning an InputStream representing the final contents. The contents may still be preprocessed, and is useful for rendering text assets like CSS or JS.

Parameters:
void renderRaw(OrchidPage page) public since: v1.0.0

Render the content of a page directly, without any template, producing a side-effect as the intended final output. The contents may still be preprocessed, and is useful for rendering text assets like CSS or JS.

Parameters:
InputStream getRenderedBinary(OrchidPage page) public since: v1.0.0

Render the content of a page directly, as a binary stream, returning an InputStream representing the final contents. No further processing is performed on the file contents, so as to preserve the binary format.

Parameters:
void render(OrchidPage page, RenderService.RenderMode renderMode) public since: v1.0.0

Dynamically use a RenderMode enum to determine which rendering operation to perform.

Parameters:
InputStream getRendered(OrchidPage page, RenderService.RenderMode renderMode) public since: v1.0.0

Dynamically use a RenderMode enum to determine which rendering operation to perform.

Parameters:
void render(OrchidPage page, String renderMode) public since: v1.0.0

Dynamically convert a String to a RenderMode to determine which rendering operation to perform.

Parameters:
  • OrchidPage page

    the page to render
  • String renderMode

    the mode to render this page in
InputStream getRendered(OrchidPage page, String renderMode) public since: v1.0.0

Dynamically convert a String to a RenderMode to determine which rendering operation to perform.

Parameters:
  • OrchidPage page

    the page to render
  • String renderMode

    the mode to render this page in
void renderBinary(OrchidPage page) public since: v1.0.0

Render the content of a page directly, as a binary stream, producing a side-effect as the intended final output. No further processing is performed on the file contents, so as to preserve the binary format.

Parameters: