au.com.codeka.carrot

Class CarrotEngine

java.lang.Object

au.com.codeka.carrot.CarrotEngine

public class CarrotEngine
extends java.lang.Object

CarrotEngine is the root of the carrot system. You create an instance of this, make it global or static, load templates and process them from here.

Constructor Summary

Constructors

Constructor and Description
CarrotEngine(Configuration config) Constructs a new CarrotEngine with the given Configuration.
CarrotEngine(Configuration config, MapBindings.Builder globalBindingsBuilder) Constructs a new CarrotEngine with the given Configuration and initial set of global bindings.

Method Summary

Modifier and Type	Method and Description
Configuration	getConfig()
MapBindings	getGlobalBindings()
java.lang.String	process(java.lang.String templateFile, Bindings bindings) Process the template with the given filename, and returns the result as a string.
void	process(java.io.Writer writer, ResourceName resourceName, Scope scope) Process the template with the given filename, writing the results to the given Writer.
void	process(java.io.Writer writer, java.lang.String templateFile, Bindings bindings) Process the template with the given filename, writing the results to the given Writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CarrotEngine

public CarrotEngine(Configuration config)

Constructs a new CarrotEngine with the given Configuration.

The configuration is immutable, so you should create it with all of the settings you need first.

Parameters:

config - The Configuration to construct this engine with.

CarrotEngine

public CarrotEngine(Configuration config,
                    MapBindings.Builder globalBindingsBuilder)

Constructs a new CarrotEngine with the given Configuration and initial set of global bindings.

The configuration is immutable, so you should create it with all of the settings you need first.

Parameters:

config - The Configuration to construct this engine with.

globalBindingsBuilder - A MapBindings.Builder that you can pre-configure with some global objects that you want to access from every template rendered by this engine.

Method Detail

getConfig

public Configuration getConfig()

Returns:

The Configuration. The configuration is mutable, so you are able to modify settings on the value returned here and they will take effect on the current CarrotEngine.

getGlobalBindings

public MapBindings getGlobalBindings()

Returns:

A map of the global variables. These bindings will be accessible in all templates processed by this CarrotEngine.

process

public void process(java.io.Writer writer,
                    ResourceName resourceName,
                    Scope scope)
             throws CarrotException

Process the template with the given filename, writing the results to the given Writer.

Parameters:

writer - A Writer to write the results of processing the given template to.

resourceName - The ResourceName of the template file, which will be located by our configured ResourceLocator.

scope - The Scope we're rendering into.

Throws:

CarrotException - Thrown if any errors occur.

process

public void process(java.io.Writer writer,
                    java.lang.String templateFile,
                    @Nullable
                    Bindings bindings)
             throws CarrotException

Process the template with the given filename, writing the results to the given Writer.

Parameters:

writer - A Writer to write the results of processing the given template to.

templateFile - The name of the template file, which will be resolved by our configured ResourceLocator.

bindings - A mapping of string to variables that make up the bindings for this template.

Throws:

CarrotException - Thrown if any errors occur.

process

public java.lang.String process(java.lang.String templateFile,
                                @Nullable
                                Bindings bindings)
                         throws CarrotException

Process the template with the given filename, and returns the result as a string.

Parameters:

templateFile - The name of the template file, which will be resolved by our configured ResourceLocator.

bindings - A mapping of string to variables that make up the bindings for this template.

Returns:

The processed template, as a string.

Throws:

CarrotException - Thrown if any errors occur.