Apache Velocity

https://velocity.apache.org/engine/devel/apidocs/
Admin
Apache Velocity is a Java-based templating engine that permits anyone to use a simple yet powerful...
Tokens:280,484
Snippets:5,413
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### Template usage example

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/Template.html

Example showing how to retrieve a template and populate a context with data.

```java
 // set up and initialize Velocity before this code block

 Template template = Velocity.getTemplate("test.wm");
 Context context = new VelocityContext();

 context.put("foo", "bar");
 context.put("customer", new Customer());
```

--------------------------------

### JarResourceLoader Path Configuration Example

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/JarResourceLoader.html

An example of setting the path property for a JAR file located on the local filesystem.

```properties
    resource.loader.jar.path = jar:file:/opt/myfiles/jar1.jar
```

--------------------------------

### EventExample.main(String[])

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/example/EventExample.html

Static main method for running the example.

```APIDOC
## main(String[] args)

### Description
Static main method for running the example. This is the entry point for the EventExample demonstration.

### Method
main

### Parameters
- **args** (String[]) - Command line arguments.

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### Extended Properties File Syntax Example

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/ExtProperties.html

An example demonstrating various features of the extended properties file format, including comments, multi-line values, token lists, and escaped characters.

```text
      # lines starting with # are comments

      # This is the simplest property
      key = value

      # A long property may be separated on multiple lines
      longvalue = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
                  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

      # This is a property with many tokens
      tokens_on_a_line = first token, second token

      # This sequence generates exactly the same result
      tokens_on_multiple_lines = first token
      tokens_on_multiple_lines = second token

      # commas may be escaped in tokens
      commas.escaped = Hi\, what'up?
```

--------------------------------

### BlockMacro Usage Example

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/directive/BlockMacro.html

An example demonstrating how to define a macro and invoke it using the BlockMacro directive syntax.

```velocity
 #set($foobar = "yeah!")

 #macro(strong $txt)
 <strong>$bodyContent</strong> $txt
 #end

 #@strong($foobar)
 <u>This text is underlined and bold</u>
 #end
 
```

```text
 <strong><u>This text is underlined and bold<u></strong> yeah!
 
```

--------------------------------

### process()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/Template.html

Gets the named resource as a stream, parses and initializes the template.

```APIDOC
## process()

### Description
Gets the named resource as a stream, parses and initializes the template.

### Method
`public boolean process()`

### Parameters
None.

### Returns
- **true** (boolean) - if successful.

### Throws
- **ResourceNotFoundException** - if template not found from any available source.
- **ParseErrorException** - if template cannot be parsed due to syntax (or other) error.
```

--------------------------------

### get(String fieldName)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/app/FieldMethodizer.html

Accessor method to get the fields by name.

```APIDOC
## get(String fieldName)

### Description
Accessor method to get the fields by name.

### Method
get

### Signature
public Object get(String fieldName)

### Parameters
- **fieldName** (String) - Required - Name of static field to retrieve.

### Returns
- **Object** - The value of the given field.

### Example
Object value = fm.get("COUNTER_NAME");
```

--------------------------------

### get(String key)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/context/Context.html

Gets the value corresponding to the provided key from the context.

```APIDOC
## get(String key)

### Description
Gets the value corresponding to the provided key from the context.

### Method
get

### Parameters
- **key** (String) - Required - The name of the desired value.

### Returns
- **Object** - The value corresponding to the provided key.
```

--------------------------------

### EventExample.main(String[] args)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/example/EventExample.html

The main entry point for the EventExample class. It is a static method that can be invoked directly to run the example.

```APIDOC
## EventExample.main(String[] args)

### Description
Main method to run the EventExample demonstration.

### Method
main

### Signature
public static void main(String[] args)

### Parameters
- **args** (String[]) - Required - Command line arguments.
```

--------------------------------

### get() - SimplePool

Source: https://velocity.apache.org/engine/devel/apidocs/index-all.html

Method in class org.apache.velocity.util.SimplePool that gets an object from the pool, null if the pool is empty.

```APIDOC
## get() - SimplePool

### Description
Get an object from the pool, null if the pool is empty.

### Method
Instance method

### Class
org.apache.velocity.util.SimplePool

### Returns
An object from the pool, or null if empty.
```

--------------------------------

### StringResourceLoader.init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

Initializes the StringResourceLoader with the given configuration.

```APIDOC
## StringResourceLoader.init(ExtProperties configuration)

### Description
Initializes the StringResourceLoader with the given configuration.

### Method
init(ExtProperties configuration)

### Parameters
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.runtime.resource.loader

### Class
StringResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### get(String) - Context

Source: https://velocity.apache.org/engine/devel/apidocs/index-all.html

Method in interface org.apache.velocity.context.Context that gets the value corresponding to the provided key from the context.

```APIDOC
## get(String) - Context

### Description
Gets the value corresponding to the provided key from the context.

### Method
Instance method

### Interface
org.apache.velocity.context.Context

### Parameters
- **key** (String) - The key

### Returns
The value associated with the key.
```

--------------------------------

### ClasspathResourceLoader.init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

This is abstract in the base class, so we need it.

```APIDOC
## ClasspathResourceLoader.init(ExtProperties configuration)

### Description
This is abstract in the base class, so we need it.

### Method
init(ExtProperties configuration)

### Parameters
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.runtime.resource.loader

### Class
ClasspathResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### URLResourceLoader.init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

Initializes the URLResourceLoader with the given configuration.

```APIDOC
## URLResourceLoader.init(ExtProperties configuration)

### Description
Initializes the URLResourceLoader with the given configuration.

### Method
init(ExtProperties configuration)

### Parameters
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.runtime.resource.loader

### Class
URLResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### get(String) - AbstractContext

Source: https://velocity.apache.org/engine/devel/apidocs/index-all.html

Method in class org.apache.velocity.context.AbstractContext that gets the value corresponding to the provided key from the context.

```APIDOC
## get(String) - AbstractContext

### Description
Gets the value corresponding to the provided key from the context.

### Method
Instance method

### Class
org.apache.velocity.context.AbstractContext

### Parameters
- **key** (String) - The key

### Returns
The value associated with the key.
```

--------------------------------

### init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.html

Initializes the template loader with a resources class.

```APIDOC
## init(ExtProperties configuration)

### Description
Initializes the template loader with a resources class. This method is called by the Velocity runtime to configure the loader.

### Method
`public void init(ExtProperties configuration)`

### Parameters
- **configuration** (ExtProperties) - The configuration properties for the loader.

```

--------------------------------

### DataSourceResourceLoader.init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

Initializes the DataSourceResourceLoader with the given configuration.

```APIDOC
## DataSourceResourceLoader.init(ExtProperties configuration)

### Description
Initializes the DataSourceResourceLoader with the given configuration.

### Method
init(ExtProperties configuration)

### Parameters
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.runtime.resource.loader

### Class
DataSourceResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### FileResourceLoader.init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

Initializes the FileResourceLoader with the given configuration.

```APIDOC
## FileResourceLoader.init(ExtProperties configuration)

### Description
Initializes the FileResourceLoader with the given configuration.

### Method
init(ExtProperties configuration)

### Parameters
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.runtime.resource.loader

### Class
FileResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### get(String, Template, Template) - VelocimacroManager

Source: https://velocity.apache.org/engine/devel/apidocs/index-all.html

Method in class org.apache.velocity.runtime.VelocimacroManager that gets a VelocimacroProxy object by the name / source template duple.

```APIDOC
## get(String, Template, Template) - VelocimacroManager

### Description
Gets a VelocimacroProxy object by the name / source template duple.

### Method
Instance method

### Class
org.apache.velocity.runtime.VelocimacroManager

### Parameters
- **name** (String) - The macro name
- **sourceTemplate** (Template) - The source template
- **callingTemplate** (Template) - The calling template

### Returns
A VelocimacroProxy object.
```

--------------------------------

### ReInit(InputStream dstream, int startline, int startcolumn)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/parser/VelocityCharStream.html

Reinitializes the character stream with an InputStream input, starting line, and starting column.

```APIDOC
## ReInit(InputStream dstream, int startline, int startcolumn)

### Description
Reinitializes the character stream with an InputStream input, starting line, and starting column.

### Method
ReInit(InputStream dstream, int startline, int startcolumn)

### Parameters
- **dstream** (InputStream) - Required - The input stream.
- **startline** (int) - Required - The starting line number.
- **startcolumn** (int) - Required - The starting column number.
```

--------------------------------

### init(String configurationFile)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/RuntimeServices.html

Initialize the Velocity Runtime with the name of an ExtProperties object.

```APIDOC
## init(String configurationFile)

### Description
Initialize the Velocity Runtime with the name of an ExtProperties object.

### Method
init

### Signature
void init(String configurationFile)

### Parameters
- **configurationFile** (String) - Required - The name of the configuration file.

### Returns
void
```

--------------------------------

### ReInit(Reader dstream, int startline, int startcolumn)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/parser/VelocityCharStream.html

Reinitializes the character stream with a Reader input, starting line, and starting column.

```APIDOC
## ReInit(Reader dstream, int startline, int startcolumn)

### Description
Reinitializes the character stream with a Reader input, starting line, and starting column.

### Method
ReInit(Reader dstream, int startline, int startcolumn)

### Parameters
- **dstream** (Reader) - Required - The input reader.
- **startline** (int) - Required - The starting line number.
- **startcolumn** (int) - Required - The starting column number.
```

--------------------------------

### init(DataSource, ExtProperties)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/DatabaseObjectsFactory.html

Initializes the factory with the DataSourceResourceLoader properties.

```APIDOC
## init(DataSource dataSource, ExtProperties properties)

### Description
Initializes the factory with the DataSourceResourceLoader properties.

### Method
void

### Parameters
- **dataSource** (DataSource) - Required - data source
- **properties** (ExtProperties) - Required - DataSourceResourceLoader properties

### Throws
- SQLException

```

--------------------------------

### init(String configurationFile)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/RuntimeSingleton.html

Initialize the Velocity Runtime with the name of a properties file.

```APIDOC
## init(String configurationFile)

### Description
Initialize the Velocity Runtime with the name of a properties file.

### Method
init

### Signature
public static void init(String configurationFile)

### Parameters
- **configurationFile** (String) - Required - The name of the properties file.

### Returns
void

### Example
RuntimeSingleton.init("velocity.properties");
```

--------------------------------

### AbstractContext(Context inner)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/context/AbstractContext.html

Chaining constructor that accepts a Context argument. It will relay get() operations into this Context in the event the 'local' get() returns null.

```APIDOC
## AbstractContext(Context inner)

### Description
Chaining constructor that accepts a Context argument. It will relay get() operations into this Context in the event the 'local' get() returns null.

### Constructor
`public AbstractContext(Context inner)`

### Parameters
- **inner** (Context) - Required - context to be chained

### Returns
No return value.
```

--------------------------------

### EventExample.log(int, String, Throwable)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/example/EventExample.html

This prints the level, message, and the Throwable's message to System.out.

```APIDOC
## log(int level, String message, Throwable t)

### Description
This prints the level, message, and the Throwable's message to System.out. It is a logging method that includes exception information.

### Method
log

### Parameters
- **level** (int) - The log level.
- **message** (String) - The log message.
- **t** (Throwable) - The throwable to log.

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### ReInit(InputStream dstream, int startline, int startcolumn, int buffersize)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/parser/VelocityCharStream.html

Reinitializes the character stream with an InputStream input, starting line, starting column, and buffer size.

```APIDOC
## ReInit(InputStream dstream, int startline, int startcolumn, int buffersize)

### Description
Reinitializes the character stream with an InputStream input, starting line, starting column, and buffer size.

### Method
ReInit(InputStream dstream, int startline, int startcolumn, int buffersize)

### Parameters
- **dstream** (InputStream) - Required - The input stream.
- **startline** (int) - Required - The starting line number.
- **startcolumn** (int) - Required - The starting column number.
- **buffersize** (int) - Required - The buffer size.
```

--------------------------------

### EventExample.log(int, String)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/example/EventExample.html

This just prints the message and level to System.out.

```APIDOC
## log(int level, String message)

### Description
This just prints the message and level to System.out. It is a simple logging method that outputs the log level and message.

### Method
log

### Parameters
- **level** (int) - The log level.
- **message** (String) - The log message.

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### ReInit(Reader dstream, int startline, int startcolumn, int buffersize)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/parser/VelocityCharStream.html

Reinitializes the character stream with a Reader input, starting line, starting column, and buffer size.

```APIDOC
## ReInit(Reader dstream, int startline, int startcolumn, int buffersize)

### Description
Reinitializes the character stream with a Reader input, starting line, starting column, and buffer size.

### Method
ReInit(Reader dstream, int startline, int startcolumn, int buffersize)

### Parameters
- **dstream** (Reader) - Required - The input reader.
- **startline** (int) - Required - The starting line number.
- **startcolumn** (int) - Required - The starting column number.
- **buffersize** (int) - Required - The buffer size.
```

--------------------------------

### init Method

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/directive/BlockMacro.html

Initializes the BlockMacro directive.

```java
public void init(RuntimeServices rs,
                 String macroName,
                 InternalContextAdapter context,
                 Node node)
          throws TemplateInitException
```

--------------------------------

### getEncoding()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/Resource.html

Gets the encoding of this resource.

```APIDOC
## getEncoding()

### Description
Gets the encoding of this resource.

### Method
getEncoding

### Returns
String - The encoding of this resource.

### Signature
public String getEncoding()

```

--------------------------------

### EventExample.formatAndLog(int, String, Object...)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/example/EventExample.html

This prints the level and formatted message to System.out.

```APIDOC
## formatAndLog(int level, String format, Object... arguments)

### Description
This prints the level and formatted message to System.out. It formats the message with the given arguments and logs it.

### Method
formatAndLog

### Parameters
- **level** (int) - The log level.
- **format** (String) - The format string.
- **arguments** (Object...) - The arguments for the format string.

### Returns
- **void** - This method does not return a value.
```

--------------------------------

### getName()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/Resource.html

Gets the name of this template.

```APIDOC
## getName()

### Description
Gets the name of this template.

### Method
getName

### Returns
String - The name of this template.

### Signature
public String getName()

```

--------------------------------

### init

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/ResourceLoader.html

Initializes the resource loader. This method is called by the runtime to set up the loader with configuration.

```APIDOC
## init

### Description
Initializes the resource loader. This method is called by the runtime to set up the loader with configuration.

### Method
init

### Signature
`public void init(ExtendedProperties configuration)`

### Parameters
- **configuration** (ExtendedProperties) - Required - Configuration properties for the loader.

### Returns
void
```

--------------------------------

### getCurrentResource()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/VelocityContext.html

Gets the current resource.

```APIDOC
## getCurrentResource()

### Description
Gets the current resource.

### Method
`public Resource getCurrentResource()`

### Parameters
None.

### Returns
- **Resource** - The current resource.
```

--------------------------------

### getNextToken

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/parser/StandardParser.html

Gets the next token from the parser.

```APIDOC
## getNextToken

### Description
Gets the next token from the parser.

### Method
public final Token getNextToken()

### Returns
- Token - The next token.

```

--------------------------------

### Add Resources to Repository

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/StringResourceLoader.html

How to retrieve the default repository and add a string template to it.

```java
   StringResourceRepository repo = StringResourceLoader.getRepository();

   String myTemplateName = "/some/imaginary/path/hello.vm";
   String myTemplate = "Hi, ${username}... this is some template!";
   repo.putStringResource(myTemplateName, myTemplate);
```

--------------------------------

### getSpaceGobbling

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/RuntimeServices.html

Get space gobbling mode.

```APIDOC
## getSpaceGobbling

### Description
Get space gobbling mode.

### Method
getSpaceGobbling

### Signature
RuntimeConstants.SpaceGobbling getSpaceGobbling()

### Returns
RuntimeConstants.SpaceGobbling - space gobbling mode
```

--------------------------------

### getKeys()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/context/Context.html

Get all the keys for the values in the context.

```APIDOC
## getKeys()

### Description
Get all the keys for the values in the context.

### Method
getKeys

### Parameters
None

### Returns
- **String[]** - All the keys for the values in the context.
```

--------------------------------

### Configure StringResourceLoader

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/StringResourceLoader.html

Example configuration properties for the StringResourceLoader. The repository.class property is optional and defaults to StringResourceRepositoryImpl.

```properties
 resource.loaders = string
 resource.loader.string.description = Velocity StringResource loader
 resource.loader.string.class = org.apache.velocity.runtime.resource.loader.StringResourceLoader
 resource.loader.string.repository.name = MyRepositoryName (optional, to avoid using the default repository)
 resource.loader.string.repository.class = org.apache.velocity.runtime.resource.loader.StringResourceRepositoryImpl
```

--------------------------------

### getMacroLibraries()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/VelocityContext.html

Gets the list of macro libraries.

```APIDOC
## getMacroLibraries()

### Description
Gets the list of macro libraries.

### Method
`public List<Template> getMacroLibraries()`

### Parameters
None.

### Returns
- **List<Template>** - The list of macro libraries.
```

--------------------------------

### SpringResourceLoader.init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

Initializes the SpringResourceLoader with the given configuration.

```APIDOC
## SpringResourceLoader.init(ExtProperties configuration)

### Description
Initializes the SpringResourceLoader with the given configuration.

### Method
init(ExtProperties configuration)

### Parameters
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.spring

### Class
SpringResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### JarResourceLoader.init(ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

Called by Velocity to initialize the loader.

```APIDOC
## JarResourceLoader.init(ExtProperties configuration)

### Description
Called by Velocity to initialize the loader.

### Method
init(ExtProperties configuration)

### Parameters
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.runtime.resource.loader

### Class
JarResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### getCurrentTemplateName()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/VelocityContext.html

Gets the current template name.

```APIDOC
## getCurrentTemplateName()

### Description
Gets the current template name.

### Method
`public String getCurrentTemplateName()`

### Parameters
None.

### Returns
- **String** - The current template name.
```

--------------------------------

### getCurrentMacroName()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/VelocityContext.html

Gets the current macro name.

```APIDOC
## getCurrentMacroName()

### Description
Gets the current macro name.

### Method
`public String getCurrentMacroName()`

### Parameters
None.

### Returns
- **String** - The current macro name.
```

--------------------------------

### init()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/RuntimeServices.html

Primary initialization method for the Velocity Runtime. Sets up logging, resource manager, parser pool, global cache, static content include system, and velocimacro system.

```APIDOC
## init()

### Description
Primary initialization method for the Velocity Runtime. Sets up logging, resource manager, parser pool, global cache, static content include system, and velocimacro system.

### Method
init

### Signature
void init()

### Parameters
None

### Returns
void
```

--------------------------------

### getProperty(String key)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/ExtProperties.html

Gets a property from the configuration.

```APIDOC
## getProperty(String key)

### Description
Gets a property from the configuration.

### Method
getProperty

### Parameters
- `key` (String) - Required - Property to retrieve.

### Returns
Object - value as object. Will return user value if exists, if not then default value if exists, otherwise null.
```

--------------------------------

### ResourceLoader.commonInit(RuntimeServices rs, ExtProperties configuration)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/util/class-use/ExtProperties.html

This initialization is used by all resource loaders and must be called to set up common properties shared by all resource loaders.

```APIDOC
## ResourceLoader.commonInit(RuntimeServices rs, ExtProperties configuration)

### Description
This initialization is used by all resource loaders and must be called to set up common properties shared by all resource loaders.

### Method
commonInit(RuntimeServices rs, ExtProperties configuration)

### Parameters
- **rs** (RuntimeServices) - Required - The runtime services.
- **configuration** (ExtProperties) - Required - The configuration properties.

### Return Type
void

### Package
org.apache.velocity.runtime.resource.loader

### Class
ResourceLoader

### Modifiers
None (instance method)
```

--------------------------------

### isHyphenAllowedInIdentifiers

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/RuntimeServices.html

Get whether hyphens are allowed in identifiers.

```APIDOC
## isHyphenAllowedInIdentifiers

### Description
Get whether hyphens are allowed in identifiers.

### Method
isHyphenAllowedInIdentifiers

### Signature
boolean isHyphenAllowedInIdentifiers()

### Returns
boolean - configured boolean flag

### Since
2.1
```

--------------------------------

### init(String propsFilename)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/app/Velocity.html

Initializes the Velocity runtime engine using default properties plus the properties from the specified properties file.

```APIDOC
## init(String propsFilename)

### Description
Initializes the Velocity runtime engine using default properties plus the properties from the specified properties file.

### Method
init

### Signature
public static void init(String propsFilename)

### Parameters
- **propsFilename** (String) - Required - File containing properties to use to initialize the Velocity runtime.

### Returns
void
```

--------------------------------

### getTemplateNameStack()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/VelocityContext.html

Gets the current template name stack.

```APIDOC
## getTemplateNameStack()

### Description
Gets the current template name stack.

### Method
`public String[] getTemplateNameStack()`

### Parameters
None.

### Returns
- **String[]** - The current template name stack.
```

--------------------------------

### Configure DataSourceResourceLoader in velocity.properties

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.html

Example configuration for setting up the DataSourceResourceLoader within the Velocity properties file.

```properties
 resource.loaders = file, ds

 resource.loader.ds.description = Velocity DataSource Resource Loader   

 resource.loader.ds.class = org.apache.velocity.runtime.resource.loader.DataSourceResourceLoader   

 resource.loader.ds.resource.datasource_url = java:comp/env/jdbc/Velocity   

 resource.loader.ds.resource.table = tb_velocity_template   

 resource.loader.ds.resource.key_column = id_template   

 resource.loader.ds.resource.template_column = template_definition   

 resource.loader.ds.resource.timestamp_column = template_timestamp   

 resource.loader.ds.cache = false   

 resource.loader.ds.modification_check_interval = 60   

 resource.loader.ds.statements_pool_max_size = 50   
```

--------------------------------

### getMacroNameStack()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/VelocityContext.html

Gets the current macro name stack.

```APIDOC
## getMacroNameStack()

### Description
Gets the current macro name stack.

### Method
`public String[] getMacroNameStack()`

### Parameters
None.

### Returns
- **String[]** - The current macro name stack.
```

--------------------------------

### init(InternalContextAdapter context, Object data)

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/runtime/parser/node/SimpleNode.html

Initializes the node with the given context and data. Throws TemplateInitException if initialization fails.

```APIDOC
## init(InternalContextAdapter context, Object data)

### Description
Initializes the node. This method is called during template parsing.

### Method
public Object init(InternalContextAdapter context, Object data) throws TemplateInitException

### Parameters
- **context** (InternalContextAdapter) - the context
- **data** (Object) - initialization data

### Returns
- **Object** - The init result.

### Throws
- **TemplateInitException** - if initialization fails

### See Also
- Node.init(org.apache.velocity.context.InternalContextAdapter, java.lang.Object)

```

--------------------------------

### getEventCartridge()

Source: https://velocity.apache.org/engine/devel/apidocs/org/apache/velocity/VelocityContext.html

Gets the event cartridge associated with this context.

```APIDOC
## getEventCartridge()

### Description
Gets the event cartridge associated with this context.

### Method
`public EventCartridge getEventCartridge()`

### Parameters
None.

### Returns
- **EventCartridge** - The event cartridge.
```
Tokens:
Raw