Skip navigation links
B C D E F G H I J M N O P Q R S T U V W X 

B

b(Object) - Method in class org.xwiki.velocity.tools.EscapeTool
Encode a text using the B encoding specified in RFC 2047.

C

checkObjectExecutePermission(Class, String) - Method in class org.xwiki.velocity.introspection.SecureIntrospector
 
clearMacroNamespace(String) - Method in interface org.xwiki.velocity.VelocityEngine
Clear the internal Velocity Macro cache for the passed namespace.
close() - Method in class org.xwiki.velocity.tools.nio.WrappingDirectoryStream
 
CollectionsTool - Class in org.xwiki.velocity.tools
Velocity Tool allowing to create various type of collections.
CollectionsTool() - Constructor for class org.xwiki.velocity.tools.CollectionsTool
 
ComparisonDateTool - Class in org.xwiki.velocity.tools
Extends the default DateTool from velocity-tools with some useful methods.
ComparisonDateTool() - Constructor for class org.xwiki.velocity.tools.ComparisonDateTool
 
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.
css(String) - Method in class org.xwiki.velocity.tools.EscapeTool
Escapes a CSS identifier.
CSSIdentifierSerializer - Class in org.xwiki.velocity.tools
Implements the specification regarding CSS identifier serialization.
CSSIdentifierSerializer() - Constructor for class org.xwiki.velocity.tools.CSSIdentifierSerializer
 

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
 
disjunction(Collection<E>, Collection<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Returns a Collection containing the exclusive disjunction (symmetric difference) of the given Collections.

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.
evaluate(Writer, String, Reader) - Method in interface org.xwiki.velocity.VelocityManager
Renders the input string using the context into the output writer.
exists(Path, LinkOption...) - Method in class org.xwiki.velocity.tools.nio.NIOTool

F

find(String, String) - Method in class org.xwiki.velocity.tools.RegexTool
 
findAll(String, String) - Method in class org.xwiki.velocity.tools.RegexTool
 
fromString(String) - Method in class org.xwiki.velocity.tools.JSONTool
Parse JSON String into an Object.

G

getArrayList() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new ArrayList, an unbounded list with constant access time and good performance for most additions at the end of the list, but which performs poorly when deleting items, when inserting a new item in the list and when appending a new item requires resizing the allocated space.
getAttribute(Path, String, LinkOption...) - Method in class org.xwiki.velocity.tools.nio.NIOTool
getBlockingQueue() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new BlockingQueue, an unbounded queue that additionally supports operations that wait for the queue to become non-empty when retrieving an element.
getCurrentVelocityContext() - Method in interface org.xwiki.velocity.VelocityManager
 
getDateFormatSymbols(Locale) - Method in class org.xwiki.velocity.tools.ComparisonDateTool
 
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.SecureUberspector
Get an iterator from the given object.
getLastModifiedTime(Path, LinkOption...) - Method in class org.xwiki.velocity.tools.nio.NIOTool
getLinkedList() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new LinkedList, optimized for insertion and deletion of items, and for sequential iteration over the items, but not for quick access to random positions in the list.
getMap() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new Map, providing good speed for insertion, retrieval and deletion of items, but with no guarantees on the order of the map.
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.MethodArgumentsUberspector
 
getName() - Method in class org.xwiki.velocity.introspection.TryCatchDirective
 
getOrderedMap() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new Map, which ensures that iterating the map will always return the entries in the same order as they were added.
getOrderedSet() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new Set, which ensures that iterating the set will always return the entries in the same order as they were added.
getPriorityQueue() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new Queue, which instead of the FIFO ordering uses the natural order of the items added to the queue, so that the retrieved item is always the lowest one.
getProperties() - Method in interface org.xwiki.velocity.VelocityConfiguration
 
getPropertyGet(Object, String, Info) - Method in class org.xwiki.velocity.introspection.DeprecatedCheckUberspector
 
getPropertySet(Object, String, Object, Info) - Method in class org.xwiki.velocity.introspection.DeprecatedCheckUberspector
 
getQueue() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new Queue, an unbounded list where items are ordered in a FIFO (first-in-first-out) manner.
getSet() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new Set, providing good speed for insertion, retrieval and deletion of items, but with no guarantees on the order of the set.
getSortedMap() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new SortedMap, which ensures that iterating the map will always return the entries in the natural order of the keys.
getSortedSet() - Method in class org.xwiki.velocity.tools.CollectionsTool
Create and return a new SortedSet, which ensures that iterating the set will always return the entries in the natural order of the items.
getStart() - Method in class org.xwiki.velocity.tools.RegexTool.RegexResult
 
getTools() - Method in interface org.xwiki.velocity.VelocityConfiguration
 
getType() - Method in class org.xwiki.velocity.introspection.TryCatchDirective
 
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.DeprecatedCheckUberspector
 
init() - Method in class org.xwiki.velocity.introspection.SecureUberspector
 
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.
intersection(Collection<E>, Collection<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Returns a Collection containing the intersection of the given Collections.
isDirectory(Path, LinkOption...) - Method in class org.xwiki.velocity.tools.nio.NIOTool
isReadable(Path) - Method in class org.xwiki.velocity.tools.nio.NIOTool
isRegularFile(Path, LinkOption...) - Method in class org.xwiki.velocity.tools.nio.NIOTool
isSymbolicLink(Path) - Method in class org.xwiki.velocity.tools.nio.NIOTool
iterator() - Method in class org.xwiki.velocity.tools.nio.WrappingDirectoryStream
 

J

json(Object) - Method in class org.xwiki.velocity.tools.EscapeTool
Escapes the characters in a String using JSON String rules: escapes with backslash double quotes, back and forward slashes, newlines, the control characters \b, \t and \f, and with \uXXXX any non-ASCII characters.
JSONTool - Class in org.xwiki.velocity.tools
Velocity tool to facilitate serialization of Java objects to the JSON format.
JSONTool() - Constructor for class org.xwiki.velocity.tools.JSONTool
 

M

MethodArgumentsUberspector - Class in org.xwiki.velocity.introspection
Chainable Velocity Uberspector that tries to convert method arguments to formal parameter types when the passed arguments don't match the method signature.
MethodArgumentsUberspector() - Constructor for class org.xwiki.velocity.introspection.MethodArgumentsUberspector
 

N

newBufferedReader(Path, Charset) - Method in class org.xwiki.velocity.tools.nio.NIOTool
newDirectoryStream(Path) - Method in class org.xwiki.velocity.tools.nio.NIOTool
newDirectoryStream(Path, DirectoryStream.Filter) - Method in class org.xwiki.velocity.tools.nio.NIOTool
newDirectoryStream(Path, String) - Method in class org.xwiki.velocity.tools.nio.NIOTool
NIOTool - Class in org.xwiki.velocity.tools.nio
Provides access to some of the static NIO2 Files methods.
NIOTool() - Constructor for class org.xwiki.velocity.tools.nio.NIOTool
 

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
 
org.xwiki.velocity.tools.nio - package org.xwiki.velocity.tools.nio
 

P

parse(String) - Method in class org.xwiki.velocity.tools.JSONTool
Deprecated.
since 9.9RC1, use JSONTool.fromString(String) instead
parseQuery(String) - Method in class org.xwiki.velocity.tools.URLTool
Parse a query string into a map of key-value pairs.

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.
quoteReplacement(String) - Method in class org.xwiki.velocity.tools.RegexTool
Returns a literal replacement String for the specified String.

R

readAllBytes(Path) - Method in class org.xwiki.velocity.tools.nio.NIOTool
readAllLines(Path, Charset) - Method in class org.xwiki.velocity.tools.nio.NIOTool
readAttributes(Path, String, LinkOption...) - Method in class org.xwiki.velocity.tools.nio.NIOTool
RegexResult(int, int, String) - Constructor for class org.xwiki.velocity.tools.RegexTool.RegexResult
 
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.
removeVelocityEngine(String) - Method in interface org.xwiki.velocity.VelocityFactory
Remove from the cache a Velocity engine corresponding to a specific key, if such an engine was already created.
render(InternalContextAdapter, Writer, Node) - Method in class org.xwiki.velocity.introspection.TryCatchDirective
 
reverse(List<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Reverse the order of the elements within a list, so that the last element is moved to the beginning of the list, the next-to-last element to the second position, and so on.

S

SecureIntrospector - Class in org.xwiki.velocity.introspection
SecureIntrospectorImpl is way too restrictive with allowed Class methods.
SecureIntrospector(String[], String[], Log) - Constructor for class org.xwiki.velocity.introspection.SecureIntrospector
 
SecureUberspector - Class in org.xwiki.velocity.introspection
SecureUberspector is way too restrictive regarding Class methods allowed.
SecureUberspector() - Constructor for class org.xwiki.velocity.introspection.SecureUberspector
 
serialize(String) - Method in class org.xwiki.velocity.tools.CSSIdentifierSerializer
Serialize a CSS identifier.
serialize(Object) - Method in class org.xwiki.velocity.tools.JSONTool
Serialize a Java object to the JSON format.
setRuntimeServices(RuntimeServices) - Method in class org.xwiki.velocity.introspection.MethodArgumentsUberspector
 
setRuntimeServices(RuntimeServices) - Method in class org.xwiki.velocity.introspection.SecureUberspector
 
size(Path) - Method in class org.xwiki.velocity.tools.nio.NIOTool
sort(List<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Sort the elements within a list according to their natural order.
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.

T

TryCatchDirective - Class in org.xwiki.velocity.introspection
Allows catching exception from Velocity.
TryCatchDirective() - Constructor for class org.xwiki.velocity.introspection.TryCatchDirective
 

U

union(Collection<E>, Collection<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Returns a Collection containing the union of the given Collections.
unmodifiable(List<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Returns an unmodifiable view of the specified list.
unmodifiable(Map<K, V>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Returns an unmodifiable view of the specified map.
unmodifiable(Set<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Returns an unmodifiable view of the specified set.
unmodifiable(Collection<E>) - Method in class org.xwiki.velocity.tools.CollectionsTool
Returns an unmodifiable view of the specified collection.
url(Map<String, ?>) - Method in class org.xwiki.velocity.tools.EscapeTool
Properly escape a parameter map representing a query string, so that it can be safely used in an URL.
url(Object) - Method in class org.xwiki.velocity.tools.EscapeTool
We override the implementation so that we sync it with the encoding strategy we use for generating URLs.
URLTool - Class in org.xwiki.velocity.tools
Velocity tool to parse URL parts.
URLTool() - Constructor for class org.xwiki.velocity.tools.URLTool
 

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

WrappingDirectoryStream - Class in org.xwiki.velocity.tools.nio
Wrap the DirectoryStream returned by Files.newDirectoryStream(java.nio.file.Path) since the returned class may be private and Velocity tries to call it.
WrappingDirectoryStream(DirectoryStream<Path>) - Constructor for class org.xwiki.velocity.tools.nio.WrappingDirectoryStream
 

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.
B C D E F G H I J M N O P Q R S T U V W X 
Skip navigation links

Copyright © 2004–2019 XWiki. All rights reserved.