com.verhas.velocitoro
Interface GroovyContext

All Known Implementing Classes:

GroovyContextImpl

public interface GroovyContext

An interface to access context information.

Author:

Peter Verhas

Method Summary

String	getInputFileName()
Map<Object,Object>	getMap()
String	getOutputFileName()
Integer	getPass()
Integer	getPasses()
String	getSourceDir()
String	getTargetDir()

Method Detail

getInputFileName

String getInputFileName()

Returns:

the full path name to the template file that is currently processed.

getOutputFileName

String getOutputFileName()

Returns:

the full path to the file that is written by velocitoro during the processing of this file.

getTargetDir

String getTargetDir()

Returns:

the full path to the target directory where the output files are written.

getSourceDir

String getSourceDir()

Returns:

the full path to the directory where the source files are.

getPass

Integer getPass()

Returns:

the actual pass executing. It starts from zero.

getPasses

Integer getPasses()

Returns:

the total number of passes to be executed.

getMap

Map<Object,Object> getMap()

Returns:

a generic Map object that can be used to store object between the executions of the different scripts. The content of the Map is guaranteed to remain intact during the execution of the different scripts and the passes. This Map can be used to exchange data between passes and scripts.