Java Doc for RuntimeSingleton.java in » Template-Engine » Velocity » org » apache » velocity » runtime » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Template Engine » Velocity » org.apache.velocity.runtime

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.velocity.runtime .RuntimeSingleton

RuntimeSingleton

public class RuntimeSingleton implements RuntimeConstants(Code)

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.
 -----------------------------------------------------------------------

author:
   Jason van Zyl
author:
   Jeff Bowden
author:
   Geir Magusson Jr.
author:
   Daniel Rall
See Also:   org.apache.velocity.runtime.RuntimeInstance
version:
   $Id: RuntimeSingleton.java 463298 2006-10-12 16:10:32Z henning $

Method Summary
public static void	addProperty(String key, Object value) Add a property to the configuration.
public static boolean	addVelocimacro(String name, String macro, String argArray, String sourceTemplate) Adds a new Velocimacro.
public static void	clearProperty(String key) Clear the values pertaining to a particular property.
public static void	debug(Object message)
public static boolean	dumpVMNamespace(String namespace) tells the vmFactory to dump the specified namespace.
public static void	error(Object message)
public static Object	getApplicationAttribute(Object key)
public static boolean	getBoolean(String key, boolean def) Boolean property accessor method to hide the configuration implementation. Parameters: key - property key Parameters: def - The default value if property not found.
public static ExtendedProperties	getConfiguration() Return the velocity runtime configuration object.
public static ContentResource	getContent(String name) Returns a static content resource from the resource manager.
public static ContentResource	getContent(String name, String encoding) 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. Parameters: key - property key Parameters: defaultValue - The default value.
public static Introspector	getIntrospector()
public static String	getLoaderNameForResource(String resourceName) Determines is a template exists, and returns name of the loader that provides it.
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.
public static RuntimeInstance	getRuntimeInstance()
public static RuntimeServices	getRuntimeServices() Returns the RuntimeServices Instance used by this wrapper.
public static String	getString(String key, String defaultValue) String property accessor method with default to hide the configuration implementation. Parameters: key - property key Parameters: defaultValue - default value to return if key notfound in resource manager.
public static String	getString(String key)
public static 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.
public static Template	getTemplate(String name, String encoding)
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. Parameters: vmName - Name of velocimacro requested Parameters: templateName - Name of the template that contains the velocimacro.
public static void	info(Object message)
public static synchronized void	init() This is the primary initialization method in the Velocity Runtime.
public static void	init(Properties p) Initialize the Velocity Runtime with a Properties object.
public static void	init(String configurationFile) 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 Parameters: vmName - Name of the Velocimacro. Parameters: templateName - Template on which to look for the Macro.
public static SimpleNode	parse(Reader reader, String templateName) 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.
public static SimpleNode	parse(Reader reader, String templateName, boolean dumpNamespace) 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.
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)

Method Detail

addProperty
public static void addProperty(String key, Object value)(Code)
	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: key - Parameters: value - See Also: RuntimeInstance.addProperty(StringObject)

addVelocimacro
public static boolean addVelocimacro(String name, String macro, String argArray, String sourceTemplate)(Code)
	Adds a new Velocimacro. Usually called by Macro only while parsing. Parameters: name - Name of velocimacro Parameters: macro - String form of macro body Parameters: argArray - Array of strings, containing the#macro() arguments. the 0th is the name. Parameters: sourceTemplate - Name of the template that contains the velocimacro. True if added, false if rejected for somereason (either parameters or permission settings) See Also: RuntimeInstance.addVelocimacro(StringStringString[]String)

clearProperty
public static void clearProperty(String key)(Code)
	Clear the values pertaining to a particular property. Parameters: key - of property to clear See Also: RuntimeInstance.clearProperty(String)

debug
public static void debug(Object message)(Code)
	See Also: Log.debug(Object) Parameters: message - The message to log.

dumpVMNamespace
public static boolean dumpVMNamespace(String namespace)(Code)
	tells the vmFactory to dump the specified namespace. This is to support clearing the VM list when in inline-VM-local-scope mode Parameters: namespace - Namespace to dump. True if namespace was dumped successfully. See Also: RuntimeInstance.dumpVMNamespace(String)

error
public static void error(Object message)(Code)
	See Also: Log.error(Object) Parameters: message - The message to log.

getApplicationAttribute
public static Object getApplicationAttribute(Object key)(Code)
	Gets the application attribute for the given key See Also: org.apache.velocity.runtime.RuntimeServices.getApplicationAttribute(Object) Parameters: key - The application attribute for the given key. See Also: RuntimeInstance.getApplicationAttribute(Object)

getBoolean
public static boolean getBoolean(String key, boolean def)(Code)
	Boolean property accessor method to hide the configuration implementation. Parameters: key - property key Parameters: def - The default value if property not found. value of key or default value See Also: RuntimeInstance.getBoolean(Stringboolean)

getConfiguration
public static ExtendedProperties getConfiguration()(Code)
	Return the velocity runtime configuration object. ExtendedProperties configuration object which housesthe velocity runtime properties. See Also: RuntimeInstance.getConfiguration

getContent
public static ContentResource getContent(String name) throws ResourceNotFoundException, ParseErrorException, Exception(Code)
	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 parsed ContentResource object ready for use throws: ResourceNotFoundException - if template not foundfrom any available source. throws: ParseErrorException - When the template could not be parsed. throws: Exception - Any other error. See Also: RuntimeInstance.getContent(String)

getContent
public static ContentResource getContent(String name, String encoding) throws ResourceNotFoundException, ParseErrorException, Exception(Code)
	Returns a static content resource from the resource manager. Parameters: name - Name of content resource to get Parameters: encoding - Character encoding to use parsed ContentResource object ready for use throws: ResourceNotFoundException - if template not foundfrom any available source. throws: ParseErrorException - When the template could not be parsed. throws: Exception - Any other error. See Also: RuntimeInstance.getContent(StringString)

getEventCartridge
public EventCartridge getEventCartridge()(Code)
	Returns the event handlers for the application. The event handlers for the application. See Also: RuntimeInstance.getApplicationEventCartridge

getInt
public static int getInt(String key)(Code)
	Int property accessor method to hide the configuration implementation. Parameters: key - Property key value See Also: RuntimeInstance.getInt(String)

getInt
public static int getInt(String key, int defaultValue)(Code)
	Int property accessor method to hide the configuration implementation. Parameters: key - property key Parameters: defaultValue - The default value. value See Also: RuntimeInstance.getInt(Stringint)

getIntrospector
public static Introspector getIntrospector()(Code)
	Return the Introspector for this RuntimeInstance Introspector object for this runtime instance See Also: RuntimeInstance.getIntrospector

getLoaderNameForResource
public static String getLoaderNameForResource(String resourceName)(Code)
	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 class name of loader than can provide it See Also: RuntimeInstance.getLoaderNameForResource(String)

getLog
public static Log getLog()(Code)
	Returns a convenient Log instance that wraps the current LogChute. A convenience Log instance that wraps the current LogChute. See Also: RuntimeInstance.getLog

getProperty
public static Object getProperty(String key)(Code)
	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 Value of the property or null if it does not exist. See Also: RuntimeInstance.getProperty(String)

getRuntimeInstance
public static RuntimeInstance getRuntimeInstance()(Code)
	The RuntimeInstance used by this Singleton.

getRuntimeServices
public static RuntimeServices getRuntimeServices()(Code)
	Returns the RuntimeServices Instance used by this wrapper. The RuntimeServices Instance used by this wrapper.

getString
public static String getString(String key, String defaultValue)(Code)
	String property accessor method with default to hide the configuration implementation. Parameters: key - property key Parameters: defaultValue - default value to return if key notfound in resource manager. value of key or default See Also: RuntimeInstance.getString(StringString)

getString
public static String getString(String key)(Code)
	String property accessor method to hide the configuration implementation Parameters: key - property key value of key or null See Also: RuntimeInstance.getString(String)

getTemplate
public static Template getTemplate(String name) throws ResourceNotFoundException, ParseErrorException, Exception(Code)
	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. The template. throws: ResourceNotFoundException - if template not foundfrom any available source. throws: ParseErrorException - if template cannot be parsed dueto syntax (or other) error. throws: Exception - if an error occurs in template initialization See Also: RuntimeInstance.getTemplate(String)

getTemplate
public static Template getTemplate(String name, String encoding) throws ResourceNotFoundException, ParseErrorException, Exception(Code)
	Returns a `Template` from the resource manager Parameters: name - The name of the desired template. Parameters: encoding - Character encoding of the template The template. throws: ResourceNotFoundException - if template not foundfrom any available source. throws: ParseErrorException - if template cannot be parsed dueto syntax (or other) error. throws: Exception - if an error occurs in template initialization throws: ParseErrorException - When the template could not be parsed. throws: Exception - Any other error. See Also: RuntimeInstance.getTemplate(StringString)

getUberspect
public static Uberspect getUberspect()(Code)
	Returns the Uberspect object for this Instance. The Uberspect object for this Instance. See Also: org.apache.velocity.runtime.RuntimeServices.getUberspect See Also: RuntimeInstance.getUberspect

getVelocimacro
public static Directive getVelocimacro(String vmName, String templateName)(Code)
	Returns the appropriate VelocimacroProxy object if strVMname is a valid current Velocimacro. Parameters: vmName - Name of velocimacro requested Parameters: templateName - Name of the template that contains the velocimacro. The requested VelocimacroProxy. See Also: RuntimeInstance.getVelocimacro(StringString)

info
public static void info(Object message)(Code)
	See Also: Log.info(Object) Parameters: message - The message to log.

init
public static synchronized void init() throws Exception(Code)
	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 throws: Exception - When an error occured during initialization. See Also: RuntimeInstance.init

init
public static void init(Properties p) throws Exception(Code)
	Initialize the Velocity Runtime with a Properties object. Parameters: p - throws: Exception - When an error occurs during initialization. See Also: RuntimeInstance.init(Properties)

init
public static void init(String configurationFile) throws Exception(Code)
	Initialize the Velocity Runtime with the name of ExtendedProperties object. Parameters: configurationFile - throws: Exception - When an error occurs during initialization. See Also: RuntimeInstance.init(String)

isInitialized
public static boolean isInitialized()(Code)
	Returns true if the RuntimeInstance has been successfully initialized. True if the RuntimeInstance has been successfully initialized. See Also: RuntimeInstance.isInitialized

isVelocimacro
public static boolean isVelocimacro(String vmName, String templateName)(Code)
	Checks to see if a VM exists Parameters: vmName - Name of the Velocimacro. Parameters: templateName - Template on which to look for the Macro. True if VM by that name exists, false if not See Also: RuntimeInstance.isVelocimacro(StringString)

parse
public static SimpleNode parse(Reader reader, String templateName) throws ParseException(Code)
	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. Parameters: reader - Reader retrieved by a resource loader Parameters: templateName - name of the template being parsed A root node representing the template as an AST tree. throws: ParseException - When the template could not be parsed. See Also: RuntimeInstance.parse(ReaderString)

parse
public static SimpleNode parse(Reader reader, String templateName, boolean dumpNamespace) throws ParseException(Code)
	Parse the input and return the root of the AST node structure. Parameters: reader - Reader retrieved by a resource loader Parameters: templateName - name of the template being parsed Parameters: dumpNamespace - flag to dump the Velocimacro namespace for this template A root node representing the template as an AST tree. throws: ParseException - When the template could not be parsed. See Also: RuntimeInstance.parse(ReaderStringboolean)

setConfiguration
public static void setConfiguration(ExtendedProperties configuration)(Code)
	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. Parameters: configuration - See Also: RuntimeInstance.setConfiguration(ExtendedProperties)

setProperty
public static void setProperty(String key, Object value)(Code)
	Allows an external system to set a property in the Velocity Runtime. Parameters: key - property key Parameters: value - property value See Also: RuntimeInstance.setProperty(StringObject)

warn
public static void warn(Object message)(Code)
	See Also: Log.warn(Object) Parameters: message - The message to log.

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.