it.tidalwave.role
Interface StringRenderable

All Known Subinterfaces:

HtmlRenderable, PlainTextRenderable

public interface StringRenderable

The role of an object that can be rendered into a String as HTML markup.

Version:

$Id$

Author:

Fabrizio Giudici

Field Summary

static java.lang.Class<StringRenderable>

StringRenderable

Method Summary

java.lang.String	render(java.lang.Object... args) Renders the attached object into a String.
void	renderTo(java.io.PrintWriter printWriter, java.lang.Object... args) Renders the attached object printing to a PrintWriter.
void	renderTo(java.lang.StringBuilder stringBuilder, java.lang.Object... args) Renders the attached object appending to a StringBuilder.

Field Detail

StringRenderable

static final java.lang.Class<StringRenderable> StringRenderable

Method Detail

render

@Nonnull
java.lang.String render(@Nonnull
                                java.lang.Object... args)

Renders the attached object into a String. The method accepts optional parameters that can be used to control the format of the rendering; they are usually specific of the object attached to this role.

Parameters:

args - optional rendering parameters

Returns:

the string

renderTo

void renderTo(@Nonnull
              java.lang.StringBuilder stringBuilder,
              @Nonnull
              java.lang.Object... args)

Renders the attached object appending to a StringBuilder. The method accepts optional parameters that can be used to control the format of the rendering; they are usually specific of the object attached to this role.

Parameters:

args - optional rendering parameters

renderTo

void renderTo(@Nonnull
              java.io.PrintWriter printWriter,
              @Nonnull
              java.lang.Object... args)

Renders the attached object printing to a PrintWriter. The method accepts optional parameters that can be used to control the format of the rendering; they are usually specific of the object attached to this role.

Parameters:

args - optional rendering parameters