NVelocity.Runtime
Class RuntimeSingleton

This is the Runtime system for Velocity. It is the single access point for all functionality in Velocity. It adheres to the mediator pattern and is the only structure that developers need to be familiar with in order to get Velocity to perform. * The Runtime will also cooperate with external systems like Turbine. Runtime properties can set and then the Runtime is initialized. * Turbine for example knows where the templates are to be loaded from, and where the velocity log file should be placed. * So in the case of Velocity cooperating with Turbine the code might look something like the following: * Runtime.setProperty(Runtime.FILE_RESOURCE_LOADER_PATH, templatePath); Runtime.setProperty(Runtime.RUNTIME_LOG, pathToVelocityLog); Runtime.init(); * ----------------------------------------------------------------------- N O T E S O N R U N T I M E I N I T I A L I Z A T I O N ----------------------------------------------------------------------- Runtime.init() If Runtime.init() is called by itself the Runtime will initialize with a set of default values. ----------------------------------------------------------------------- Runtime.init(String/Properties) * In this case the default velocity properties are layed down first to provide a solid base, then any properties provided in the given properties object will override the corresponding default property. ----------------------------------------------------------------------- *

Template

input.encoding

Template

RuntimeSingleton

public RuntimeSingleton()

Initializes a new instance of the RuntimeSingleton class.

Configuration

public Commons.Collections.ExtendedProperties Configuration

Introspector

public NVelocity.Util.Introspection.Introspector Introspector

RuntimeInstance

public NVelocity.Runtime.RuntimeInstance RuntimeInstance

RuntimeServices

public NVelocity.Runtime.RuntimeServices RuntimeServices

addProperty

public void addProperty(string key,
                        object value_Renamed)

Add a property to the configuration. If it already exists then the value stated here will be added to the configuration entry. For example, if * resource.loader = file * is already present in the configuration and you * addProperty("resource.loader", "classpath") * Then you will end up with a Vector like the following: * ["file", "classpath"] *

Parameters:

String - key

String - value

addVelocimacro

public bool addVelocimacro(string name,
                           string macro,
                           string[] argArray,
                           string sourceTemplate)

Adds a new Velocimacro. Usually called by Macro only while parsing. *

Parameters:

String - name Name of velocimacro

String - macro String form of macro body

String - argArray Array of strings, containing the #macro() arguments. the 0th is the name.

Returns:

boolean True if added, false if rejected for some reason (either parameters or permission settings)

clearProperty

public void clearProperty(string key)

Clear the values pertaining to a particular property. *

Parameters:

String - key of property to clear

debug

public void debug(object message)

Log a debug message. *

Parameters:

Object - message to log

dumpVMNamespace

public bool dumpVMNamespace(string namespace_Renamed)

tells the vmFactory to dump the specified namespace. This is to support clearing the VM list when in inline-VM-local-scope mode

error

public void error(object message)

Log an error message. *

Parameters:

Object - message to log

getBoolean

public bool getBoolean(string key,
                       bool def)

Boolean property accessor method to hide the configuration implementation.

Parameters:

String - key property key

boolean - default default value if property not found

Returns:

boolean value of key or default value

getContent

public NVelocity.Runtime.Resource.ContentResource getContent(string name)

Returns a static content resource from the resource manager. Uses the current value if INPUT_ENCODING as the character encoding. *

Parameters:

name - Name of content resource to get

Returns:

parsed ContentResource object ready for use @throws ResourceNotFoundException if template not found from any available source.

getContent

public NVelocity.Runtime.Resource.ContentResource getContent(string name,
                                                             string encoding)

Returns a static content resource from the resource manager. *

Parameters:

name - Name of content resource to get

encoding - Character encoding to use

Returns:

parsed ContentResource object ready for use @throws ResourceNotFoundException if template not found from any available source.

getInt

public int getInt(string key)

Int property accessor method to hide the configuration implementation. *

Parameters:

String - key property key

Returns:

int value

getInt

public int getInt(string key,
                  int defaultValue)

Int property accessor method to hide the configuration implementation. *

Parameters:

key - property key

int - default value

Returns:

int value

getLoaderNameForResource

public string getLoaderNameForResource(string resourceName)

Determines is a template exists, and returns name of the loader that provides it. This is a slightly less hokey way to support the Velocity.templateExists() utility method, which was broken when per-template encoding was introduced. We can revisit this. *

Parameters:

resourceName - Name of template or content resource

Returns:

class name of loader than can provide it

getProperty

public object getProperty(string key)

Allows an external caller to get a property. The calling routine is required to know the type, as this routine will return an Object, as that is what properties can be. *

Parameters:

key - property to return

getString

public string getString(string key,
                        string defaultValue)

String property accessor method with default to hide the configuration implementation.

Parameters:

String - key property key

String - defaultValue default value to return if key not found in resource manager.

Returns:

String value of key or default

getString

public string getString(string key)

String property accessor method to hide the configuration implementation

Parameters:

key - property key

Returns:

value of key or null

getTemplate

public NVelocity.Template getTemplate(string name)

Returns a

Template

from the resource manager. This method assumes that the character encoding of the template is set by the

input.encoding

property. The default is "ISO-8859-1" *

Parameters:

name - The file name of the desired template.

Returns:

The template. @throws ResourceNotFoundException if template not found from any available source. @throws ParseErrorException if template cannot be parsed due to syntax (or other) error. @throws Exception if an error occurs in template initialization

getTemplate

public NVelocity.Template getTemplate(string name,
                                      string encoding)

Returns a

Template

from the resource manager *

Parameters:

name - The name of the desired template.

encoding - Character encoding of the template

Returns:

The template. @throws ResourceNotFoundException if template not found from any available source. @throws ParseErrorException if template cannot be parsed due to syntax (or other) error. @throws Exception if an error occurs in template initialization

getVelocimacro

public NVelocity.Runtime.Directive.Directive getVelocimacro(string vmName,
                                                            string templateName)

Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro. *

Parameters:

String - vmName Name of velocimacro requested

Returns:

String VelocimacroProxy

info

public void info(object message)

Log an info message. *

Parameters:

Object - message to log

init

public void init()

init

public void init(Commons.Collections.ExtendedProperties p)

Initialize the Velocity Runtime with a Properties object. *

Parameters:

- Properties

init

public void init(string configurationFile)

Initialize the Velocity Runtime with the name of ExtendedProperties object. *

Parameters:

- Properties

isVelocimacro

public bool isVelocimacro(string vmName,
                          string templateName)

Checks to see if a VM exists *

Parameters:

name - Name of velocimacro

Returns:

boolean True if VM by that name exists, false if not

parse

public NVelocity.Runtime.Parser.Node.SimpleNode parse(System.IO.TextReader reader,
                                                      string templateName)

parse

public NVelocity.Runtime.Parser.Node.SimpleNode parse(System.IO.TextReader reader,
                                                      string templateName,
                                                      bool dumpNamespace)

Parse the input and return the root of the AST node structure. *

Parameters:

InputStream - inputstream retrieved by a resource loader

String - name of the template being parsed

dumpNamespace - flag to dump the Velocimacro namespace for this template

setProperty

public void setProperty(string key,
                        object value_Renamed)

Allows an external system to set a property in the Velocity Runtime. *

Parameters:

String - property key

String - property value

warn

public void warn(object message)

Log a warning message. *

Parameters:

Object - message to log