com.jcabi.velocity

Class VelocityPage

java.lang.Object

com.jcabi.velocity.VelocityPage

public final class VelocityPage
extends Object

Velocity page, builder/wrapper around Apache Velocity template.

The template should be in classpath:

 String text = new VelocityPage("com/foo/my-template.vm")
   .set("name", "John Doe")
   .toString();

At the moment all logging is forwarded to LOG4J. In Velocity 2.0 there will be an adapter for SLF4J and we'll use it: Slf4jLogChute.

The class is mutable and thread-safe.

Since:

0.1.6

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

Velocity User Guide, Velocity Developer Guide, Slf4jLogChute

Constructor Summary

Constructors

Constructor and Description
VelocityPage(String res) Public ctor, with absolute resource name in classpath.

Method Summary

Methods

Modifier and Type	Method and Description
VelocityPage	set(Map<String,Object> args) Set all names in one go.
VelocityPage	set(String prop, Object value) Set the name to the value specified.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityPage

public VelocityPage(@NotNull
            String res)

Public ctor, with absolute resource name in classpath.

Parameters:

res - Name of resource with template (absolute resource name in classpath)

Method Detail

set

public VelocityPage set(@NotNull
               String prop,
               Object value)

Set the name to the value specified.

Parameters:

prop - Name of the property to set

value - The value to use

Returns:

This object

set

public VelocityPage set(@NotNull
               Map<String,Object> args)

Set all names in one go.

Parameters:

args - Map of arguments

Returns:

This object

Since:

0.8

toString

public String toString()

Overrides:

toString in class Object