Package org.apache.velocity.script
Class VelocityScriptEngineFactory
- java.lang.Object
-
- org.apache.velocity.script.VelocityScriptEngineFactory
-
- All Implemented Interfaces:
javax.script.ScriptEngineFactory
public class VelocityScriptEngineFactory extends java.lang.Object implements javax.script.ScriptEngineFactory
-
-
Field Summary
Fields Modifier and Type Field Description private static java.util.List<java.lang.String>
extensions
private static java.util.List<java.lang.String>
mimeTypes
private static java.util.List<java.lang.String>
names
private static java.util.Properties
parameters
private static java.lang.String
VELOCITY_LANGUAGE
private static java.lang.String
VELOCITY_NAME
private static java.lang.String
VELOCITY_VERSION
-
Constructor Summary
Constructors Constructor Description VelocityScriptEngineFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getEngineName()
get engine namejava.lang.String
getEngineVersion()
get engine versionjava.util.List<java.lang.String>
getExtensions()
get the list of file extensions handled by Velocity: vm, vtl, vhtmljava.lang.String
getLanguageName()
get language namejava.lang.String
getLanguageVersion()
get language version (same as engine version)java.lang.String
getMethodCallSyntax(java.lang.String obj, java.lang.String m, java.lang.String... args)
get Velocity syntax for calling method 'm' on object 'obj' with provided argumentsjava.util.List<java.lang.String>
getMimeTypes()
get the list of Velocity mime typesjava.util.List<java.lang.String>
getNames()
get the list of namesjava.lang.String
getOutputStatement(java.lang.String toDisplay)
get VTL expression used to display specified stringjava.lang.String
getParameter(java.lang.String key)
get engine parameter for provided keyjava.lang.String
getProgram(java.lang.String... statements)
get whole VTL program given VTL linesjavax.script.ScriptEngine
getScriptEngine()
get a Velocity script engine
-
-
-
Field Detail
-
VELOCITY_NAME
private static final java.lang.String VELOCITY_NAME
- See Also:
- Constant Field Values
-
VELOCITY_VERSION
private static final java.lang.String VELOCITY_VERSION
- See Also:
- Constant Field Values
-
VELOCITY_LANGUAGE
private static final java.lang.String VELOCITY_LANGUAGE
- See Also:
- Constant Field Values
-
names
private static java.util.List<java.lang.String> names
-
extensions
private static java.util.List<java.lang.String> extensions
-
mimeTypes
private static java.util.List<java.lang.String> mimeTypes
-
parameters
private static java.util.Properties parameters
-
-
Method Detail
-
getEngineName
public java.lang.String getEngineName()
get engine name- Specified by:
getEngineName
in interfacejavax.script.ScriptEngineFactory
- Returns:
- engine name, aka "Velocity"
-
getEngineVersion
public java.lang.String getEngineVersion()
get engine version- Specified by:
getEngineVersion
in interfacejavax.script.ScriptEngineFactory
- Returns:
- engine version string
-
getExtensions
public java.util.List<java.lang.String> getExtensions()
get the list of file extensions handled by Velocity: vm, vtl, vhtml- Specified by:
getExtensions
in interfacejavax.script.ScriptEngineFactory
- Returns:
- extensions list
-
getLanguageName
public java.lang.String getLanguageName()
get language name- Specified by:
getLanguageName
in interfacejavax.script.ScriptEngineFactory
- Returns:
- language name, aka "VTL"
-
getLanguageVersion
public java.lang.String getLanguageVersion()
get language version (same as engine version)- Specified by:
getLanguageVersion
in interfacejavax.script.ScriptEngineFactory
- Returns:
- language version string
-
getMethodCallSyntax
public java.lang.String getMethodCallSyntax(java.lang.String obj, java.lang.String m, java.lang.String... args)
get Velocity syntax for calling method 'm' on object 'obj' with provided arguments- Specified by:
getMethodCallSyntax
in interfacejavax.script.ScriptEngineFactory
- Parameters:
obj
-m
-args
-- Returns:
- VTL call ${obj.m(args...)}
-
getMimeTypes
public java.util.List<java.lang.String> getMimeTypes()
get the list of Velocity mime types- Specified by:
getMimeTypes
in interfacejavax.script.ScriptEngineFactory
- Returns:
- singleton { 'text/x-velocity' }
-
getNames
public java.util.List<java.lang.String> getNames()
get the list of names- Specified by:
getNames
in interfacejavax.script.ScriptEngineFactory
- Returns:
- { 'velocity', 'Velocity' }
-
getOutputStatement
public java.lang.String getOutputStatement(java.lang.String toDisplay)
get VTL expression used to display specified string- Specified by:
getOutputStatement
in interfacejavax.script.ScriptEngineFactory
- Parameters:
toDisplay
-- Returns:
- escaped string #[[toDisplay]]#
-
getParameter
public java.lang.String getParameter(java.lang.String key)
get engine parameter for provided key- Specified by:
getParameter
in interfacejavax.script.ScriptEngineFactory
- Parameters:
key
-- Returns:
- found parameter, or null
-
getProgram
public java.lang.String getProgram(java.lang.String... statements)
get whole VTL program given VTL lines- Specified by:
getProgram
in interfacejavax.script.ScriptEngineFactory
- Parameters:
statements
- VTL lines- Returns:
- lines concatenated with carriage returns
-
getScriptEngine
public javax.script.ScriptEngine getScriptEngine()
get a Velocity script engine- Specified by:
getScriptEngine
in interfacejavax.script.ScriptEngineFactory
- Returns:
- a new Velocity script engine
-
-