A B C D E F G H I L O 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

B

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

Encode a text using the B encoding specified in RFC 2047.

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 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 interface org.xwiki.velocity.VelocityContextFactory

Creates and initializes a new Velocity Context.

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

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

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

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

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

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

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

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

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

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.

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

H

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

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

I

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

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

O

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

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

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

Q

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

Encode a text using the Q encoding specified in RFC 2047.

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

Returns a literal pattern String for the specified String.

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

Encode a text using the Quoted-Printable format, as specified in section 6.7 of RFC 2045.

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

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

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

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

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

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

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

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.

VelocityEngine - Interface in org.xwiki.velocity

Initialize a Velocity Engine and make Velocity services available.

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.

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 B C D E F G H I L O Q R S U V W X