org.milyn.templating

Class TemplatingConfiguration

java.lang.Object

org.milyn.templating.TemplatingConfiguration

public class TemplatingConfiguration
extends Object

Templating Configuration.

Allow programmatic configuration of a AbstractTemplateProcessor implementation.

Author:

tom.fennelly@jboss.com

Constructor Summary

Constructors

Constructor and Description
TemplatingConfiguration(String template) Public constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	applyBefore() Should the template be applied at the start of the fragment and before processing any of the fragment's child content.
protected String	getTemplate() Get the template.
protected Usage	getUsage() Get the templating Usage directive for the templating result.
TemplatingConfiguration	setApplyBefore(boolean applyBefore) Set whether or not the template should be applied at the start of the fragment and before processing any of the fragment's child content.
TemplatingConfiguration	setUsage(Usage usage) Set the templating Usage directive for the templating result.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplatingConfiguration

public TemplatingConfiguration(String template)

Public constructor.

Parameters:

template - The template. This can be a URI referencing the template resource, or can be an inlined template.

Method Detail

getTemplate

protected String getTemplate()

Get the template.

Returns:

The template. This can be a URI referencing the template resource, or can be an inlined template.

applyBefore

protected boolean applyBefore()

Should the template be applied at the start of the fragment and before processing any of the fragment's child content.

Returns:

True if the template is to be applied at the start of the fragment, otherwise false.

setApplyBefore

public TemplatingConfiguration setApplyBefore(boolean applyBefore)

Set whether or not the template should be applied at the start of the fragment and before processing any of the fragment's child content.

Parameters:

applyBefore - True if the template is to be applied at the start of the fragment, otherwise false.

Returns:

This instance.

getUsage

protected Usage getUsage()

Get the templating Usage directive for the templating result.

Returns:

The templating result usage.

setUsage

public TemplatingConfiguration setUsage(Usage usage)

Set the templating Usage directive for the templating result.

Parameters:

usage - The templating result usage.

Returns:

This instance.