it.tidalwave.role

Interface StringRenderable

All Known Subinterfaces:

HtmlRenderable, PlainTextRenderable

All Known Implementing Classes:

StringRenderableSupport

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

Fields

Modifier and Type	Field and Description
static Class<StringRenderable>	StringRenderable

Method Summary

Methods

Modifier and Type	Method and Description
String	render(Object... args) Renders the attached object into a String.
void	renderTo(PrintWriter printWriter, Object... args) Renders the attached object printing to a PrintWriter.
void	renderTo(StringBuilder stringBuilder, Object... args) Renders the attached object appending to a StringBuilder.

Field Detail

StringRenderable

static final Class<StringRenderable> StringRenderable

Method Detail

render

@Nonnull
String render(@Nonnull
                    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
            StringBuilder stringBuilder,
            @Nonnull
            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:

stringBuilder - the StringBuilder to append to

args - optional rendering parameters

renderTo

void renderTo(@Nonnull
            PrintWriter printWriter,
            @Nonnull
            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:

printWriter - the PrintWriter to print to

args - optional rendering parameters