A C D E F G H I J L O P Q R S U V W X

A

AbstractChainableUberspector - Class in org.xwiki.velocity.introspection

Default implementation of a chainable uberspector that forwards all calls to the wrapped uberspector (when that is possible).

AbstractChainableUberspector() - Constructor for class org.xwiki.velocity.introspection.AbstractChainableUberspector

C

ChainableUberspector - Interface in org.xwiki.velocity.introspection

Interface that marks uberspectors as chainable, meaning that multiple uberspectors can be combined in a chain (using the Decorator pattern).

ChainingUberspector - Class in org.xwiki.velocity.introspection

Since the current version of the Velocity engine (1.5) does not allow more than one uberspector, this class is a workaround.

ChainingUberspector() - Constructor for class org.xwiki.velocity.introspection.ChainingUberspector

clearMacroNamespace(String) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

Clear the internal Velocity Macro cache for the passed namespace.

clearMacroNamespace(String) - Method in interface org.xwiki.velocity.VelocityEngine

Clear the internal Velocity Macro cache for the passed namespace.

compile(String) - Method in class org.xwiki.velocity.tools.RegexTool

Compiles a regular expression into a java Pattern object.

createContext() - Method in class org.xwiki.velocity.internal.DefaultVelocityContextFactory

Creates and initializes a new Velocity Context.

createContext() - Method in interface org.xwiki.velocity.VelocityContextFactory

Creates and initializes a new Velocity Context.

createVelocityEngine(String, Properties) - Method in class org.xwiki.velocity.internal.DefaultVelocityFactory

Creates a new Velocity engine instance, which will be cached using a specific key for later reuse.

createVelocityEngine(String, Properties) - Method in interface org.xwiki.velocity.VelocityFactory

Creates a new Velocity engine instance, which will be cached using a specific key for later reuse.

D

DefaultVelocityConfiguration - Class in org.xwiki.velocity.internal

All configuration options for the Velocity subsystem.

DefaultVelocityConfiguration() - Constructor for class org.xwiki.velocity.internal.DefaultVelocityConfiguration

DefaultVelocityContextFactory - Class in org.xwiki.velocity.internal

Default implementation for VelocityContextFactory.

DefaultVelocityContextFactory() - Constructor for class org.xwiki.velocity.internal.DefaultVelocityContextFactory

DefaultVelocityEngine - Class in org.xwiki.velocity.internal

Default implementation of the Velocity service which initializes the Velocity system using configuration values defined in the component's configuration.

DefaultVelocityEngine() - Constructor for class org.xwiki.velocity.internal.DefaultVelocityEngine

DefaultVelocityFactory - Class in org.xwiki.velocity.internal

Default implementation for VelocityFactory.

DefaultVelocityFactory() - Constructor for class org.xwiki.velocity.internal.DefaultVelocityFactory

DeprecatedCheckUberspector - Class in org.xwiki.velocity.introspection

Chainable Velocity Uberspector that checks for deprecated method calls.

DeprecatedCheckUberspector() - Constructor for class org.xwiki.velocity.introspection.DeprecatedCheckUberspector

E

end - Variable in class org.xwiki.velocity.tools.RegexTool.RegexResult

EscapeTool - Class in org.xwiki.velocity.tools

Tool for working with escaping in Velocity templates.

EscapeTool() - Constructor for class org.xwiki.velocity.tools.EscapeTool

evaluate(Context, Writer, String, String) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

Renders the input string using the context into the output writer.

evaluate(Context, Writer, String, Reader) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

Renders the input string using the context into the output writer.

evaluate(Context, Writer, String, String) - Method in interface org.xwiki.velocity.VelocityEngine

Renders the input string using the context into the output writer.

evaluate(Context, Writer, String, Reader) - Method in interface org.xwiki.velocity.VelocityEngine

Renders the input string using the context into the output writer.

F

find(String, String) - Method in class org.xwiki.velocity.tools.RegexTool

G

getCurrentElement() - Method in class org.xwiki.velocity.internal.util.VelocityParserContext

getDirective(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get any valid Velocity block starting with a sharp character except comments.

getDirectiveEndOfLine(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get the newline consumed by Velocity directive other than macros.

getDirectiveName(char[], int, StringBuffer, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get a Velocity directive name block.

getEnd() - Method in class org.xwiki.velocity.tools.RegexTool.RegexResult

getEscape(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

getGroup() - Method in class org.xwiki.velocity.tools.RegexTool.RegexResult

getIterator(Object, Info) - Method in class org.xwiki.velocity.introspection.AbstractChainableUberspector

getIterator(Object, Info) - Method in class org.xwiki.velocity.introspection.LinkingUberspector

getKeyWord(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get any valid Velocity block starting with a sharp character (#if, #somemaccro(), ##comment etc.).

getMacroParameter(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

getMacroParametersSeparator(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

getMethod(Object, String, Object[], Info) - Method in class org.xwiki.velocity.introspection.AbstractChainableUberspector

getMethod(Object, String, Object[], Info) - Method in class org.xwiki.velocity.introspection.DeprecatedCheckUberspector

getMethod(Object, String, Object[], Info) - Method in class org.xwiki.velocity.introspection.LinkingUberspector

getMethodOrProperty(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get a velocity method call or a property starting with a ..

getMethodParameters(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get the Velocity method parameters (including ( and )).

getMultilinesComment(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get multilines comment (between #* and *#).

getName() - Method in class org.xwiki.velocity.internal.util.VelocityBlock

getParameters(char[], int, StringBuffer, char, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get a group of parameters between two characters.

getProperties() - Method in class org.xwiki.velocity.internal.DefaultVelocityConfiguration

getProperties() - Method in interface org.xwiki.velocity.VelocityConfiguration

getPropertyGet(Object, String, Info) - Method in class org.xwiki.velocity.introspection.AbstractChainableUberspector

getPropertyGet(Object, String, Info) - Method in class org.xwiki.velocity.introspection.DeprecatedCheckUberspector

getPropertyGet(Object, String, Info) - Method in class org.xwiki.velocity.introspection.LinkingUberspector

getPropertySet(Object, String, Object, Info) - Method in class org.xwiki.velocity.introspection.AbstractChainableUberspector

getPropertySet(Object, String, Object, Info) - Method in class org.xwiki.velocity.introspection.DeprecatedCheckUberspector

getPropertySet(Object, String, Object, Info) - Method in class org.xwiki.velocity.introspection.LinkingUberspector

getSimpleComment(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get comment single line comment (starting with ##).

getSpaces(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Match a group of space characters (ASCII 32).

getStart() - Method in class org.xwiki.velocity.tools.RegexTool.RegexResult

getTableElement(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get a Velocity table.

getTemplates() - Method in class org.xwiki.velocity.internal.jmx.JMXVelocityEngine

getTemplates() - Method in interface org.xwiki.velocity.internal.jmx.JMXVelocityEngineMBean

getTools() - Method in class org.xwiki.velocity.internal.DefaultVelocityConfiguration

getTools() - Method in interface org.xwiki.velocity.VelocityConfiguration

getType() - Method in class org.xwiki.velocity.internal.util.VelocityBlock

getType() - Method in class org.xwiki.velocity.internal.util.VelocityParserContext

getVar(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get any valid Velocity starting with a $.

getVar(char[], int, StringBuffer, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get any valid Velocity starting with a $.

getVelocityContext() - Method in interface org.xwiki.velocity.VelocityManager

getVelocityEngine(String) - Method in class org.xwiki.velocity.internal.DefaultVelocityFactory

Retrieves from the cache the Velocity engine corresponding to a specific key, if such an engine was already created.

getVelocityEngine(String) - Method in interface org.xwiki.velocity.VelocityFactory

Retrieves from the cache the Velocity engine corresponding to a specific key, if such an engine was already created.

getVelocityEngine() - Method in interface org.xwiki.velocity.VelocityManager

Get the current Velocity Engine or create one if none has been created.

getVelocityIdentifier(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Get a valid Velocity identifier used for variable of macro.

getWhiteSpaces(char[], int, StringBuffer, VelocityParserContext) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Match a group of Character.isWhitespace(char).

group - Variable in class org.xwiki.velocity.tools.RegexTool.RegexResult

H

hasVelocityEngine(String) - Method in class org.xwiki.velocity.internal.DefaultVelocityFactory

Check if an engine was already created for a certain key.

hasVelocityEngine(String) - Method in interface org.xwiki.velocity.VelocityFactory

Check if an engine was already created for a certain key.

I

init(RuntimeServices) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

init() - Method in class org.xwiki.velocity.introspection.AbstractChainableUberspector

init() - Method in class org.xwiki.velocity.introspection.ChainingUberspector

init() - Method in class org.xwiki.velocity.introspection.DeprecatedCheckUberspector

init() - Method in class org.xwiki.velocity.introspection.LinkingUberspector

initialize() - Method in class org.xwiki.velocity.internal.DefaultVelocityConfiguration

initialize() - Method in class org.xwiki.velocity.internal.DefaultVelocityContextFactory

initialize(Properties) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

Initializes the Velocity engine by setting its configuration both from the component's configuration and from the passed properties.

initialize(VelocityContext) - Method in class org.xwiki.velocity.internal.ServicesVelocityContextInitializer

Allow initializing the Velocity Context by putting objects into it.

initialize(ExecutionContext) - Method in class org.xwiki.velocity.internal.VelocityExecutionContextInitializer

initialize(VelocityContext) - Method in interface org.xwiki.velocity.VelocityContextInitializer

Allow initializing the Velocity Context by putting objects into it.

initialize(Properties) - Method in interface org.xwiki.velocity.VelocityEngine

Initializes the Velocity engine by setting its configuration both from the component's configuration and from the passed properties.

initializeUberspector(String) - Method in class org.xwiki.velocity.introspection.ChainingUberspector

Instantiates an uberspector class and adds it to the chain.

initializeUberspector(String) - Method in class org.xwiki.velocity.introspection.LinkingUberspector

Instantiates and initializes an uberspector class and adds it to the array.

inner - Variable in class org.xwiki.velocity.introspection.AbstractChainableUberspector

The wrapped (decorated) uberspector.

instantiateUberspector(String) - Method in class org.xwiki.velocity.introspection.ChainingUberspector

Tries to create an uberspector instance using reflection.

instantiateUberspector(String) - Method in class org.xwiki.velocity.introspection.LinkingUberspector

Tries to create an uberspector instance using reflection.

InvalidVelocityException - Exception in org.xwiki.velocity.internal.util

Thrown by Velocity parser methods when it hit invalid Velocity.

InvalidVelocityException() - Constructor for exception org.xwiki.velocity.internal.util.InvalidVelocityException

isInVelocityBlock() - Method in class org.xwiki.velocity.internal.util.VelocityParserContext

isLevelEnabled(int) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

isValidVelocityIdentifierChar(char) - Method in class org.xwiki.velocity.internal.util.VelocityParser

Indicate if the provided character is valid in a velocity identifier.

J

JMXVelocityEngine - Class in org.xwiki.velocity.internal.jmx

Uses non-stable (ie might need to be modified when we upgrade the Velocity JAR) introspection to access private fields of Velocity.

JMXVelocityEngine(VelocityEngine) - Constructor for class org.xwiki.velocity.internal.jmx.JMXVelocityEngine

JMXVelocityEngineMBean - Interface in org.xwiki.velocity.internal.jmx

MBean API related to Velocity Engines.

L

LinkingUberspector - Class in org.xwiki.velocity.introspection

Since the current version of the Velocity engine (1.5) does not allow more than one uberspector, this class is a workaround.

LinkingUberspector() - Constructor for class org.xwiki.velocity.introspection.LinkingUberspector

log(int, String) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

log(int, String, Throwable) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

O

org.xwiki.velocity - package org.xwiki.velocity

org.xwiki.velocity.internal - package org.xwiki.velocity.internal

org.xwiki.velocity.internal.jmx - package org.xwiki.velocity.internal.jmx

org.xwiki.velocity.internal.util - package org.xwiki.velocity.internal.util

org.xwiki.velocity.introspection - package org.xwiki.velocity.introspection

org.xwiki.velocity.tools - package org.xwiki.velocity.tools

P

popVelocityElement() - Method in class org.xwiki.velocity.internal.util.VelocityParserContext

Go out of a Velocity block.

pushVelocityElement(VelocityBlock) - Method in class org.xwiki.velocity.internal.util.VelocityParserContext

Enter a Velocity block.

Q

quote(String) - Method in class org.xwiki.velocity.tools.RegexTool

Returns a literal pattern String for the specified String.

R

RegexTool - Class in org.xwiki.velocity.tools

Velocity Tool offering various Regex-based APIs to make it easy to manipulate regular expressions from Velocity.

RegexTool() - Constructor for class org.xwiki.velocity.tools.RegexTool

RegexTool.RegexResult - Class in org.xwiki.velocity.tools

Result of a Regex search.

RegexTool.RegexResult(int, int, String) - Constructor for class org.xwiki.velocity.tools.RegexTool.RegexResult

S

ServicesVelocityContextInitializer - Class in org.xwiki.velocity.internal

Registers the Script Service Manager in the Velocity Context so that it's available from Velocity.

ServicesVelocityContextInitializer() - Constructor for class org.xwiki.velocity.internal.ServicesVelocityContextInitializer

setName(String) - Method in class org.xwiki.velocity.internal.util.VelocityBlock

setRuntimeServices(RuntimeServices) - Method in class org.xwiki.velocity.introspection.ChainingUberspector

setRuntimeServices(RuntimeServices) - Method in class org.xwiki.velocity.introspection.LinkingUberspector

setType(VelocityBlock.VelocityType) - Method in class org.xwiki.velocity.internal.util.VelocityBlock

setType(VelocityBlock.VelocityType) - Method in class org.xwiki.velocity.internal.util.VelocityParserContext

start - Variable in class org.xwiki.velocity.tools.RegexTool.RegexResult

startedUsingMacroNamespace(String) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

Notify that a rendering action is starting in the given namespace.

startedUsingMacroNamespace(String) - Method in interface org.xwiki.velocity.VelocityEngine

Notify that a rendering action is starting in the given namespace.

stoppedUsingMacroNamespace(String) - Method in class org.xwiki.velocity.internal.DefaultVelocityEngine

Notify that a rendering action in the given namespace just finished.

stoppedUsingMacroNamespace(String) - Method in interface org.xwiki.velocity.VelocityEngine

Notify that a rendering action in the given namespace just finished.

U

UBERSPECT_ARRAY_CLASSNAMES - Static variable in class org.xwiki.velocity.introspection.LinkingUberspector

The key of the parameter that allows defining the array of uberspectors.

UBERSPECT_CHAIN_CLASSNAMES - Static variable in class org.xwiki.velocity.introspection.ChainingUberspector

The key of the parameter that allows defining the list of chained uberspectors.

V

valueOf(String) - Static method in enum org.xwiki.velocity.internal.util.VelocityBlock.VelocityType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.xwiki.velocity.internal.util.VelocityBlock.VelocityType

Returns an array containing the constants of this enum type, in the order they are declared.

VELOCITY_CONTEXT_ID - Static variable in class org.xwiki.velocity.internal.VelocityExecutionContextInitializer

The id under which the Velocity Context is stored in the Execution Context.

VelocityBlock - Class in org.xwiki.velocity.internal.util

A Velocity element (can be a velocity macro, variable, etc.).

VelocityBlock(String, VelocityBlock.VelocityType) - Constructor for class org.xwiki.velocity.internal.util.VelocityBlock

VelocityBlock.VelocityType - Enum in org.xwiki.velocity.internal.util

The type of found Velocity element.

VelocityConfiguration - Interface in org.xwiki.velocity

Configuration properties for the Velocity module.

VelocityContextFactory - Interface in org.xwiki.velocity

Creates Velocity Context instances, pre-populated with the Velocity Tools enabled in the component's configuration, and by all the enabled VelocityContextInitializer components.

VelocityContextInitializer - Interface in org.xwiki.velocity

Populates new Velocity contexts with custom entries.

VELOCITYDIRECTIVE_ALL - Static variable in class org.xwiki.velocity.internal.util.VelocityParser

All the velocity reserved directives.

VELOCITYDIRECTIVE_BEGIN - Static variable in class org.xwiki.velocity.internal.util.VelocityParser

The directives which start a new level which will have to be close by a #end.

VELOCITYDIRECTIVE_END - Static variable in class org.xwiki.velocity.internal.util.VelocityParser

Close an opened level.

VELOCITYDIRECTIVE_NOPARAM - Static variable in class org.xwiki.velocity.internal.util.VelocityParser

Reserved directives without parameters like #else.

VELOCITYDIRECTIVE_PARAM - Static variable in class org.xwiki.velocity.internal.util.VelocityParser

Reserved directive containing parameter(s) like #if.

VelocityEngine - Interface in org.xwiki.velocity

Initialize a Velocity Engine and make Velocity services available.

VelocityExecutionContextInitializer - Class in org.xwiki.velocity.internal

Allow registering the Velocity Context in the Execution Context object since it's shared during the whole execution of the current request.

VelocityExecutionContextInitializer() - Constructor for class org.xwiki.velocity.internal.VelocityExecutionContextInitializer

VelocityFactory - Interface in org.xwiki.velocity

Allows creating different Velocity engine instances.

VelocityManager - Interface in org.xwiki.velocity

Provides access to the main XWiki Velocity objects.

VelocityParser - Class in org.xwiki.velocity.internal.util

Provide helpers to parse velocity scripts.

VelocityParser() - Constructor for class org.xwiki.velocity.internal.util.VelocityParser

VelocityParserContext - Class in org.xwiki.velocity.internal.util

Provided to VelocityParser helpers to return some information.

VelocityParserContext() - Constructor for class org.xwiki.velocity.internal.util.VelocityParserContext

W

wrap(Uberspect) - Method in class org.xwiki.velocity.introspection.AbstractChainableUberspector

Since uberspectors are dynamically enabled using a configuration string, we cannot simply call the constructors to pass the inner uberspector.

wrap(Uberspect) - Method in interface org.xwiki.velocity.introspection.ChainableUberspector

Since uberspectors are dynamically enabled using a configuration string, we cannot simply call the constructors to pass the inner uberspector.

X

xml(Object) - Method in class org.xwiki.velocity.tools.EscapeTool

Escapes the XML special characters in a String using numerical XML entities.

XWikiVelocityException - Exception in org.xwiki.velocity

Any exception raised in the XWiki Velocity component must raise an exception of this type.

XWikiVelocityException(String) - Constructor for exception org.xwiki.velocity.XWikiVelocityException

Constructs a new exception with the specified detail message.

XWikiVelocityException(String, Throwable) - Constructor for exception org.xwiki.velocity.XWikiVelocityException

Constructs a new exception with the specified detail message and cause.

A C D E F G H I J L O P Q R S U V W X