net.shibboleth.utilities.java.support.velocity

Class VelocityEngine

java.lang.Object

net.shibboleth.utilities.java.support.velocity.VelocityEngine

public final class VelocityEngine
extends Object

This is a helper class for creating velocity engines.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	VelocityEngine() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Properties	getDefaultProperties() Returns the default velocity engine properties.
static VelocityEngine	newVelocityEngine() Creates a new velocity engine with default properties.
static VelocityEngine	newVelocityEngine(Properties props) Creates a new velocity engine with the supplied properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityEngine

private VelocityEngine()

Default constructor.

Method Detail

newVelocityEngine

@Nonnull
public static VelocityEngine newVelocityEngine()

Creates a new velocity engine with default properties. See getDefaultProperties().

Returns:

velocity engine

newVelocityEngine

@Nonnull
public static VelocityEngine newVelocityEngine(@Nonnull
                                       Properties props)

Creates a new velocity engine with the supplied properties.

Parameters:

props - velocity engine properties

Returns:

velocity engine

getDefaultProperties

@Nonnull
public static Properties getDefaultProperties()

Returns the default velocity engine properties. Default properties include:

• "string.resource.loader.class","org.apache.velocity.runtime.resource.loader.StringResourceLoader"
• "classpath.resource.loader.class","org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader"
• "resource.loader", "classpath, string"

Returns:

velocity engine properties