Save This Page
Home » velocity-1.5 » org.apache » velocity » runtime » [javadoc | source]
org.apache.velocity.runtime
public class: RuntimeSingleton [javadoc | source]
java.lang.Object
   org.apache.velocity.runtime.RuntimeSingleton

All Implemented Interfaces:
    RuntimeConstants

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:
RuntimeSingleton.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, templatePath);
RuntimeSingleton.setProperty(RuntimeConstants.RUNTIME_LOG, pathToVelocityLog);
RuntimeSingleton.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
-----------------------------------------------------------------------
RuntimeSingleton.init()

If Runtime.init() is called by itself the Runtime will
initialize with a set of default values.
-----------------------------------------------------------------------
RuntimeSingleton.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.
-----------------------------------------------------------------------
Method from org.apache.velocity.runtime.RuntimeSingleton Summary:
addProperty,   addVelocimacro,   clearProperty,   debug,   dumpVMNamespace,   error,   getApplicationAttribute,   getBoolean,   getConfiguration,   getContent,   getContent,   getEventCartridge,   getInt,   getInt,   getIntrospector,   getLoaderNameForResource,   getLog,   getProperty,   getRuntimeInstance,   getRuntimeServices,   getString,   getString,   getTemplate,   getTemplate,   getUberspect,   getVelocimacro,   info,   init,   init,   init,   isInitialized,   isVelocimacro,   parse,   parse,   setConfiguration,   setProperty,   warn
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.velocity.runtime.RuntimeSingleton Detail:
 public static  void addProperty(String key,
    Object value) 
    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"]
 public static boolean addVelocimacro(String name,
    String macro,
    String[] argArray,
    String sourceTemplate) 
    Adds a new Velocimacro. Usually called by Macro only while parsing.
 public static  void clearProperty(String key) 
    Clear the values pertaining to a particular property.
 public static  void debug(Object message) 
Deprecated! Use - getLog() and call debug() on it.

 public static boolean dumpVMNamespace(String namespace) 
    tells the vmFactory to dump the specified namespace. This is to support clearing the VM list when in inline-VM-local-scope mode
 public static  void error(Object message) 
Deprecated! Use - getLog() and call error() on it.

 public static Object getApplicationAttribute(Object key) 
    Gets the application attribute for the given key
 public static boolean getBoolean(String key,
    boolean def) 
    Boolean property accessor method to hide the configuration implementation.
 public static ExtendedProperties getConfiguration() 
    Return the velocity runtime configuration object.
 public static ContentResource getContent(String name) throws Exception, ResourceNotFoundException, ParseErrorException 
    Returns a static content resource from the resource manager. Uses the current value if INPUT_ENCODING as the character encoding.
 public static ContentResource getContent(String name,
    String encoding) throws Exception, ResourceNotFoundException, ParseErrorException 
    Returns a static content resource from the resource manager.
 public EventCartridge getEventCartridge() 
    Returns the event handlers for the application.
 public static int getInt(String key) 
    Int property accessor method to hide the configuration implementation.
 public static int getInt(String key,
    int defaultValue) 
    Int property accessor method to hide the configuration implementation.
 public static Introspector getIntrospector() 
    Return the Introspector for this RuntimeInstance
 public static 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.
 public static Log getLog() 
    Returns a convenient Log instance that wraps the current LogChute.
 public static 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.
 public static RuntimeInstance getRuntimeInstance() 
Deprecated! Use - getRuntimeServices() instead.

 public static RuntimeServices getRuntimeServices() 
    Returns the RuntimeServices Instance used by this wrapper.
 public static String getString(String key) 
    String property accessor method to hide the configuration implementation
 public static String getString(String key,
    String defaultValue) 
    String property accessor method with default to hide the configuration implementation.
 public static Template getTemplate(String name) throws Exception, ResourceNotFoundException, ParseErrorException 
    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"
 public static Template getTemplate(String name,
    String encoding) throws Exception, ResourceNotFoundException, ParseErrorException 
    Returns a Template from the resource manager
 public static Uberspect getUberspect() 
    Returns the Uberspect object for this Instance.
 public static Directive getVelocimacro(String vmName,
    String templateName) 
    Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro.
 public static  void info(Object message) 
Deprecated! Use - getLog() and call info() on it.

 public static synchronized  void init() throws Exception 
    This is the primary initialization method in the Velocity Runtime. The systems that are setup/initialized here are as follows:
    • Logging System
    • ResourceManager
    • Event Handlers
    • Parser Pool
    • Global Cache
    • Static Content Include System
    • Velocimacro System
 public static  void init(Properties p) throws Exception 
    Initialize the Velocity Runtime with a Properties object.
 public static  void init(String configurationFile) throws Exception 
    Initialize the Velocity Runtime with the name of ExtendedProperties object.
 public static boolean isInitialized() 
    Returns true if the RuntimeInstance has been successfully initialized.
 public static boolean isVelocimacro(String vmName,
    String templateName) 
    Checks to see if a VM exists
 public static SimpleNode parse(Reader reader,
    String templateName) throws ParseException 
    Parse the input and return the root of AST node structure.

    In the event that it runs out of parsers in the pool, it will create and let them be GC'd dynamically, logging that it has to do that. This is considered an exceptional condition. It is expected that the user will set the PARSER_POOL_SIZE property appropriately for their application. We will revisit this.
 public static SimpleNode parse(Reader reader,
    String templateName,
    boolean dumpNamespace) throws ParseException 
    Parse the input and return the root of the AST node structure.
 public static  void setConfiguration(ExtendedProperties configuration) 
    Allow an external system to set an ExtendedProperties object to use. This is useful where the external system also uses the ExtendedProperties class and the velocity configuration is a subset of parent application's configuration. This is the case with Turbine.
 public static  void setProperty(String key,
    Object value) 
    Allows an external system to set a property in the Velocity Runtime.
 public static  void warn(Object message) 
Deprecated! Use - getLog() and call warn() on it.