sirius.web.templates

Interface ContentHandler

All Superinterfaces:

sirius.kernel.di.std.Priorized

All Known Implementing Classes:

JavaScriptBasedContentHandler, JavaScriptContentHandler, JsXMLContentHandler, TagliatelleContentHandler, TagliatellePDFContentHandler

public interface ContentHandler
extends sirius.kernel.di.std.Priorized

Used to effectively generate the output as described by a given Generator.

Handlers can be registered in the component model an will be called one after another until one feels responsible to generate the effective output. The order of the handlers is defined by their Priorized.getPriority() (sorted ascending).

Each handler should check if either the handler type matches its own, or if the defined template has an appropriate file extension.

See Also:

Generator.getHandlerType(), Generator.isTemplateFileExtension(String)

Field Summary

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
boolean	generate(Generator generator, OutputStream out) Generates the appropriate output if the settings of the generator match.

Methods inherited from interface sirius.kernel.di.std.Priorized

getPriority

Method Detail

generate

boolean generate(Generator generator,
                 OutputStream out)
          throws Exception

Generates the appropriate output if the settings of the generator match.

Parameters:

generator - the generate settings given by the caller

out - the output stream used to write the generated content to

Returns:

true if output was generated, false if the settings didn't match

Throws:

Exception - if an error occurs while generating content