org.apache.velocity.anakia

Class AnakiaTask.Context

java.lang.Object

org.apache.velocity.anakia.AnakiaTask.Context

Enclosing class:

AnakiaTask

public class AnakiaTask.Context
extends java.lang.Object

A context implementation that loads all values from an XML file.

Constructor Summary

Constructors

Constructor and Description
AnakiaTask.Context() Public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.jdom.Document	getContextDocument() Retrieve the context document object.
long	getLastModified() Retrieve the time the source file was last modified.
java.lang.String	getName() Get the name of the context.
void	setFile(java.lang.String file) Build the context based on a file path.
void	setName(java.lang.String name) Set the name of the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnakiaTask.Context

public AnakiaTask.Context()

Public constructor.

Method Detail

getName

public java.lang.String getName()

Get the name of the context.

Returns:

The name of the context.

setName

public void setName(java.lang.String name)

Set the name of the context.

Parameters:

name -

Throws:

java.lang.IllegalArgumentException - if a reserved word is used as a name, specifically any of "relativePath", "treeWalk", "xpath", "escape", "date", or "project"

setFile

public void setFile(java.lang.String file)

Build the context based on a file path.

Parameters:

file -

getLastModified

public long getLastModified()

Retrieve the time the source file was last modified.

Returns:

The time the source file was last modified.

getContextDocument

public org.jdom.Document getContextDocument()

Retrieve the context document object.

Returns:

The context document object.