- cacheData(Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
-
- CALENDAR_FIELDS - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
-
- CallableSub() - Constructor for class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
- capitalize(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Changes the first character of the string value of the specified object
to upper case and returns the resulting string.
- CATCH_EXCEPTIONS_KEY - Static variable in class org.apache.velocity.tools.ToolContext
-
- ceil(Object) - Method in class org.apache.velocity.tools.generic.MathTool
-
- cell(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Truncates or pads the string value of the specified object as necessary
to ensure that the returned string's length equals the default cell size.
- cell(Object, int) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Truncates or pads the string value of the specified object as necessary
to ensure that the returned string's length equals the specified cell size.
- cell(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Truncates or pads the string value of the specified object as necessary
to ensure that the returned string's length equals the default cell size.
- cell(Object, int, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Truncates or pads the string value of the specified object as necessary
to ensure that the returned string's length equals the specified cell size.
- CELL_LENGTH_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
-
- CELL_SUFFIX_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
-
- charset - Variable in class org.apache.velocity.tools.generic.LinkTool
-
- CHARSET_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
-
- children() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
-
- children() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns a new
XmlTool
instance that wraps all the
child
Element
s of all the current internally held nodes
that are
Element
s themselves.
- classname(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- ClassTool - Class in org.apache.velocity.tools.generic
-
- ClassTool() - Constructor for class org.apache.velocity.tools.generic.ClassTool
-
Creates an instance with target type of
Object
.
- ClassTool(ClassTool, Class) - Constructor for class org.apache.velocity.tools.generic.ClassTool
-
Creates a new instance that inspects the specified type
and otherwise shares the configuration values of the specified "parent"
ClassTool instance.
- ClassTool.CallableSub<T extends ClassTool.CallableSub> - Class in org.apache.velocity.tools.generic
-
- ClassTool.ConstructorSub - Class in org.apache.velocity.tools.generic
-
A simplified wrapping interface for inspecting features
of a
Constructor
in an inspected Class.
- ClassTool.FieldSub - Class in org.apache.velocity.tools.generic
-
A simplified wrapping interface for inspecting features
of a
Field
in an inspected Class.
- ClassTool.MethodSub - Class in org.apache.velocity.tools.generic
-
A simplified wrapping interface for inspecting features
of a
Method
in an inspected Class.
- ClassTool.Sub<T extends ClassTool.Sub> - Class in org.apache.velocity.tools.generic
-
- ClassUtils - Class in org.apache.velocity.tools
-
Repository for common class and reflection methods.
- clean(FactoryConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
-
- clean(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
-
- clean(Configuration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
-
- clean(Configuration) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- cleanProperties(Configuration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
-
- clear() - Method in class org.apache.velocity.tools.generic.ValueParser
-
- close() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
-
- CollectionTool - Class in org.apache.velocity.tools.generic
-
CollectionTool allows a user to sort a collection (or array, iterator, etc)
on any arbitrary set of properties exposed by the objects contained
within the collection, and to generate arrays by splitting strings.
- CollectionTool() - Constructor for class org.apache.velocity.tools.generic.CollectionTool
-
- CollectionTool.PropertiesComparator - Class in org.apache.velocity.tools.generic
-
Does all of the comparisons
- combine(Toolbox...) - Method in class org.apache.velocity.tools.Toolbox
-
Returns a new
Toolbox
that is a combination of
this Toolbox with one or more specified
Toolbox
es.
- combine(Map<String, Object>...) - Method in class org.apache.velocity.tools.ToolInfo
-
Combine several property maps
- combinePath(String, String) - Method in class org.apache.velocity.tools.generic.LinkTool
-
If end is null, this will return start and vice versa.
- combineQuery(String, String) - Method in class org.apache.velocity.tools.generic.LinkTool
-
If the second param is null or empty, this will simply return the first
and vice versa.
- compare(Object, Object) - Method in class org.apache.velocity.tools.generic.CollectionTool.PropertiesComparator
-
- compare(Object, Object, int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Internal comparison method.
- compare - Variable in class org.apache.velocity.tools.generic.LoopTool.Comparison
-
- compareTo(Configuration) - Method in class org.apache.velocity.tools.config.Configuration
-
- compareTo(Data) - Method in class org.apache.velocity.tools.config.Data
-
- compareTo(Configuration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
-
- compareTo(Configuration) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- compareTo(T) - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
Compare unique names of inspected and given objects
- Comparison(Calendar, Calendar, int, int, boolean, Locale) - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Comparison object constructor
- Comparison(Object) - Constructor for class org.apache.velocity.tools.generic.LoopTool.Comparison
-
- ComparisonDateTool - Class in org.apache.velocity.tools.generic
-
Tool for comparing
Date
and
Calendar
values
in Velocity templates.
- ComparisonDateTool() - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool
-
- ComparisonDateTool.Comparison - Class in org.apache.velocity.tools.generic
-
- CompoundConfiguration<C extends Configuration> - Class in org.apache.velocity.tools.config
-
- CompoundConfiguration() - Constructor for class org.apache.velocity.tools.config.CompoundConfiguration
-
- condition - Variable in class org.apache.velocity.tools.generic.LoopTool.ActionCondition
-
- condition(LoopTool.ActionCondition) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- CONFIG_FACTORY_METHOD - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
-
- Configuration - Class in org.apache.velocity.tools.config
-
This base configuration class manages a set of
Property
s
for whatever thing the instance of this class represents.
- Configuration() - Constructor for class org.apache.velocity.tools.config.Configuration
-
- ConfigurationCleaner - Class in org.apache.velocity.tools.config
-
- ConfigurationCleaner() - Constructor for class org.apache.velocity.tools.config.ConfigurationCleaner
-
- ConfigurationException - Exception in org.apache.velocity.tools.config
-
- ConfigurationException(String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationException(String, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationException(Data, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationException(Data, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationException(Data, String, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationException(Configuration, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationException(Configuration, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationException(Configuration, String, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
-
- ConfigurationUtils - Class in org.apache.velocity.tools.config
-
Utility methods for handling tool configurations.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.AlternatorTool
-
Deprecated.
Looks for a default auto-alternate value in the given params,
if not, set the default to true.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ClassTool
-
Configure this tool
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Calls the superclass implementation, then looks for a bundle name
and any time units to be skipped.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ContextTool
-
Initializes this instance for the current request.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.DateTool
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.FieldTool
-
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.FormatConfig
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ImportSupport
-
Configure import support
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ImportTool
-
Configuration
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.JsonTool
-
Looks for the "file" parameter and automatically uses
JsonTool.initJSON(String)
to parse the file (searched in filesystem current path and classpath) and set the
resulting JSON object as the root node for this instance.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Configuration
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.LocaleConfig
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.RenderTool
-
Looks for deprecated parse depth and catch.exceptions properties,
as well as any 'forceThreadSafe' setting.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
- configure(Map<String, Object>) - Method in class org.apache.velocity.tools.generic.SafeConfig
-
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.SafeConfig
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ValueParser
-
Does the actual configuration.
- configure(ValueParser) - Method in class org.apache.velocity.tools.generic.XmlTool
-
Configuration.
- configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolboxFactory
-
- configure(Object, Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo
-
Actually performs configuration of the newly instantiated tool
using the combined final set of configuration properties.
- configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolManager
-
Configure the tool manager with this toolbox factory config
- configure(String) - Method in class org.apache.velocity.tools.ToolManager
-
Configure the tool manager with the provided configuration file
- CONFIGURE_METHOD_NAME - Static variable in class org.apache.velocity.tools.ToolInfo
-
- constructor - Variable in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
- constructors - Variable in class org.apache.velocity.tools.generic.ClassTool
-
- ConstructorSub(Constructor) - Constructor for class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
Constructor inspector constructor
- contains(Object) - Method in class org.apache.velocity.tools.generic.ContextTool
-
Returns true
if the context contains a value for the specified
reference name (aka context key).
- containsKey(Object) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- containsKey(String) - Method in class org.apache.velocity.tools.ToolContext
-
- containsValue(Object) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- context - Variable in class org.apache.velocity.tools.generic.ContextTool
-
- CONTEXT_KEY - Static variable in class org.apache.velocity.tools.ToolContext
-
- ContextTool - Class in org.apache.velocity.tools.generic
-
Tool for convenient access to Context
data and
meta-data.
- ContextTool() - Constructor for class org.apache.velocity.tools.generic.ContextTool
-
- ConversionTool - Class in org.apache.velocity.tools.generic
-
- ConversionTool() - Constructor for class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- ConversionUtils - Class in org.apache.velocity.tools
-
Utility methods for parsing or otherwise converting between types.
- convert(Class, Object) - Method in class org.apache.velocity.tools.config.Data.AutoConverter
-
- convert(String) - Method in class org.apache.velocity.tools.config.Data.AutoConverter
-
- convert(Object) - Method in class org.apache.velocity.tools.config.Data
-
- convert(Class, Object) - Method in class org.apache.velocity.tools.config.Data.FieldConverter
-
- convert(Class, Object) - Method in class org.apache.velocity.tools.config.Data.NumberConverter
-
- converter(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- converter(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- convertWith(Converter) - Method in class org.apache.velocity.tools.config.Data
-
This is a convenience method for those doing configuration in java.
- create(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo
-
Returns a new instance of the tool.
- createContext() - Method in class org.apache.velocity.tools.ToolManager
-
create new context with configured toolboxes tools
- createContext(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolManager
-
create new context with configured toolboxes tools,
using the provided tools properties
- createDocumentBuilderFactory() - Static method in class org.apache.velocity.tools.XmlUtils
-
- createFactory() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- createFactory() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- createInfo() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- createToolbox(String) - Method in class org.apache.velocity.tools.ToolboxFactory
-
- createToolbox(String) - Method in class org.apache.velocity.tools.ToolManager
-
Create a toolbox for the given scope
- createURI() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Tries to create a URI from the current port, opacity, scheme,
userInfo, host, path, query and fragment set for this instance,
using the
URI
constructor that is appropriate to the opacity.
- currency(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
-
Convenience method equivalent to $number.format("currency", $foo).
- CURRENT_PREFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
-
- CURRENT_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
-
- GENERIC_DEFAULTS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
-
- get(String) - Static method in enum org.apache.velocity.tools.config.Data.Type
-
- get(Object) - Method in class org.apache.velocity.tools.generic.ContextTool
-
Retrieves the value for the specified reference name (aka context key).
- get(String) - Method in class org.apache.velocity.tools.generic.DateTool
-
- get(String, String) - Method in class org.apache.velocity.tools.generic.DateTool
-
Returns a formatted string representing the date and/or time given by
DateTool.getDate()
in standard, localized patterns.
- get(String) - Method in class org.apache.velocity.tools.generic.FieldTool.FieldToolSub
-
- get(String) - Method in class org.apache.velocity.tools.generic.FieldTool
-
Returns the value for the specified field name as found
in the stored
Map
of field names to values (or placeholders).
- get(int) - Method in class org.apache.velocity.tools.generic.JsonContent
-
Get a value from root array
- get(String) - Method in class org.apache.velocity.tools.generic.JsonContent
-
Get a property from root object
- get(int) - Method in class org.apache.velocity.tools.generic.JsonTool
-
Get nth element from root json array.
- get(String) - Method in class org.apache.velocity.tools.generic.JsonTool
-
Get a property from root object
- get(String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
This serves two purposes:
- get(String, String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
Asks the loop with the specified name for the current value
of the specified sync'ed iterator, if any.
- get(String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- get() - Method in class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
-
- get(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
-
- get(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Accepts objects and uses their string value as the key.
- get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Accepts objects and uses their string value as the key.
- get(Object, String, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Returns the value for the specified key in the ResourceBundle for
the specified basename and locale.
- get(Object, String[], Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Retrieve a resource for the specified key from the first of the
specified bundles in which a matching resource is found.
- get(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- get(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
Convenience method for use in Velocity templates.
- get(Object) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- get(Object) - Method in class org.apache.velocity.tools.generic.XmlTool
-
This will first attempt to find an attribute with the
specified name and return its value.
- get(Number) - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns an
XmlTool
that wraps the specified
Node
from this instance's internal Node list.
- get(String) - Method in class org.apache.velocity.tools.Toolbox
-
- get(String, String) - Method in class org.apache.velocity.tools.Toolbox
-
- get(String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
-
- get(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
-
- get(String) - Method in class org.apache.velocity.tools.ToolContext
-
- getAbbr() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
- getAll(Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
-
- getAllowedTags() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getAllowSubkeys() - Method in class org.apache.velocity.tools.generic.ValueParser
-
Are subkeys allowed ?
- getAnchor() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the anchor (internal document reference) set for this link.
- getAnnotations() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns the
Annotation
s of the Class being inspected.
- getAnnotations() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
Returns the
Annotation
s of the element being inspected.
- getAppendParams() - Method in class org.apache.velocity.tools.generic.LinkTool
-
- getApplicationToolbox() - Method in class org.apache.velocity.tools.ToolManager
-
Get the toolbox for application scoped tools
- getArray() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Gives acces to the wrapped JsonArray, if any
- getAttribute(Node, String, String) - Static method in class org.apache.velocity.tools.XmlUtils
-
Extracts an attribute from a node.
- getAttribute(Node, String) - Static method in class org.apache.velocity.tools.XmlUtils
-
- getAutoAlternateDefault() - Method in class org.apache.velocity.tools.generic.AlternatorTool
-
Deprecated.
Returns true if the default for auto-alternating is true.
- getAverage(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the average of the values from a list
- getAverage(Object[], String) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the sum of the values from a list
- getAverage(Collection) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the average of the values
- getAverage(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the average of the values
- getAverage(double...) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the average of the values in an array of double values
- getAverage(long...) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the average of the values in an array of long values
- getB() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a backslash (\).
- getBackslash() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a backslash (\).
- getBaseRef() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the full URI of this template without any query data.
- getBoolAttribute(Node, String, boolean) - Static method in class org.apache.velocity.tools.XmlUtils
-
Retrieves an attribute as a boolean.
- getBoolAttribute(Node, String) - Static method in class org.apache.velocity.tools.XmlUtils
-
- getBoolean(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getBoolean(String, boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getBoolean(String, Boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getBooleans(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getBundle(String, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Retrieves the
ResourceBundle
for the specified baseName
and locale, if such exists.
- getCalendar() - Method in class org.apache.velocity.tools.generic.DateTool
-
Returns a
Calendar
instance created using the timezone and
locale returned by getTimeZone() and getLocale().
- getCatchExceptions() - Method in class org.apache.velocity.tools.generic.RenderTool
-
Returns true
if this render() and eval() methods will
catch exceptions thrown during rendering.
- getCellLength() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getCellSuffix() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getCharacterEncoding() - Method in class org.apache.velocity.tools.generic.LinkTool
-
- getChild(C) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
-
- getChildren() - Method in class org.apache.velocity.tools.config.CompoundConfiguration
-
- getClass(String) - Static method in class org.apache.velocity.tools.ClassUtils
-
Load a class with a given name.
- getClassname() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getClassname() - Method in class org.apache.velocity.tools.ToolInfo
-
Get tool class name
- getClasspathResource(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
-
Classpath entry URL builder
- getComparable(Object, String) - Static method in class org.apache.velocity.tools.generic.CollectionTool
-
Safely retrieves the comparable value for the specified property
from the specified object.
- getConfiguration() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
-
- getConfigure() - Method in class org.apache.velocity.tools.ToolInfo
-
Try to find a configure()
method.
- getConstructors() - Method in class org.apache.velocity.tools.generic.ClassTool
-
- getContentTypeAttribute(String, String) - Static method in class org.apache.velocity.tools.generic.ImportSupport
-
Get the value associated with a content-type attribute.
- getContextPath() - Method in class org.apache.velocity.tools.generic.LinkTool
-
- getConvertedValue() - Method in class org.apache.velocity.tools.config.Data
-
- getConverter() - Method in class org.apache.velocity.tools.config.Data
-
- getConverter() - Method in enum org.apache.velocity.tools.config.Data.Type
-
- getCount() - Method in class org.apache.velocity.tools.generic.LoopTool
-
Returns the number of items the current loop has handled.
- getCount(String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
Returns the number of items the specified loop has handled.
- getCount() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- getCurrent() - Method in class org.apache.velocity.tools.generic.Alternator
-
Returns the current item without shifting the list index.
- getD() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a dollar sign ($).
- getData() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- getData(String) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
Search for Data by key
- getData(Data) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
Search for Data by value
- getData() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- getData() - Method in class org.apache.velocity.tools.ToolboxFactory
-
- getDate() - Method in class org.apache.velocity.tools.generic.DateTool
-
- getDateFormat(String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- getDateFormat(String, String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- getDateFormat(int, int, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- getDateFormat() - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- getDateFormat(String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getDateFormat(String, String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getDateStyleAsInt(String) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Checks a string to see if it matches one of the standard DateFormat
style patterns: full, long, medium, short, or default.
- getDay() - Method in class org.apache.velocity.tools.generic.DateTool
-
- getDay(Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getDays() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the number of days between the dates being compared.
- getDefaultAlternate() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getDefaultBundle() - Method in class org.apache.velocity.tools.generic.ResourceTool
-
- getDefaultKey() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
Returns the default key value for the set tool class.
- getDefaultTools() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- getDepth() - Method in class org.apache.velocity.tools.generic.LoopTool
-
Returns the number of loops currently on the stack.
- getDifference() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
- getDirectory() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the directory stack
in the set
LinkTool.getPath()
value, by just trimming
off all that follows the last "/".
- getDollar() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a dollar sign ($).
- getDouble(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getDouble(String, Double) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getDouble(String, double) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getDoubles(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getE() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders an exclamation mark (!).
- getElement() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
- getElement() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
- getElement() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
- getElement() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- getElements(String, Node) - Static method in class org.apache.velocity.tools.XmlUtils
-
Search for elements using an XPath expression
- getExact() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
- getExactDifference() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Internal helper returning a cached map of all
exact bygone time units per field.
- getExclamation() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders an exclamation mark (!).
- getExists() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- getFactory() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getFactory() - Method in class org.apache.velocity.tools.ToolInfo
-
Get factory class
- getFactoryClassname() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getFields() - Method in class org.apache.velocity.tools.generic.ClassTool
-
- getFieldValue(String) - Static method in class org.apache.velocity.tools.ClassUtils
-
Given a static field path, aka classname.field, get the field value.
- getFieldValue(Class, String) - Static method in class org.apache.velocity.tools.ClassUtils
-
Given a class and a static field name, get the field value.
- getFile() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the last section of the path,
which is all that follows the final "/".
- getFileResource(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
-
Overridable local file URL builder.
- getFirst() - Method in class org.apache.velocity.tools.generic.LoopTool
-
- getFirst() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- getFirst() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns an
XmlTool
that wraps only the
first
Node
from this instance's internal Node list.
- getFormat() - Method in class org.apache.velocity.tools.generic.FormatConfig
-
This returns the configured default format for this tool.
- getFromCache(String, String) - Method in class org.apache.velocity.tools.Toolbox
-
- getFromClass(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- getFromClass(Class) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- getFromInfo(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
-
- getFull() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
- getFullName() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns the fully-qualified name for the inspected Class.
- getGenericTools() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- getGlobalProperty(String) - Method in class org.apache.velocity.tools.ToolboxFactory
-
- getH() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a hash (#).
- getHash() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a hash (#).
- getHasNext() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- getHeight() - Method in class org.apache.velocity.tools.generic.DisplayTool.Measurements
-
- getHost() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Return the host value for this instance.
- getHours() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the number of hours between the dates being compared.
- getIndex() - Method in class org.apache.velocity.tools.generic.LoopTool
-
Returns the 0-based index of the item the current loop is handling.
- getIndex(String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
Returns the 0-based index of the item the specified loop is handling.
- getIndex() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- getInstance(String) - Static method in class org.apache.velocity.tools.ClassUtils
-
Get an instance of a named class.
- getInstance() - Method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- getInstance() - Method in class org.apache.velocity.tools.ConversionUtils
-
- getInstance() - Static method in class org.apache.velocity.tools.Scope
-
- getInt(String, int) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getIntAttribute(Node, String, int) - Static method in class org.apache.velocity.tools.XmlUtils
-
- getIntAttribute(Node, String) - Static method in class org.apache.velocity.tools.XmlUtils
-
- getInteger(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getInteger(String, Integer) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getInts(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getInvalidScopes() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getIterator(Object) - Static method in class org.apache.velocity.tools.ClassUtils
-
Retrieves an Iterator from or creates and Iterator for the specified object.
- getIterator(Object) - Method in class org.apache.velocity.tools.generic.LoopTool
-
- getJavadocRef() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
- getJavadocRef() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
Simply returns the name of the field.
- getJavadocRef() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- getKey() - Method in class org.apache.velocity.tools.config.Data
-
- getKey() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
Returns the key set for this tool.
- getKey() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Should return the key under which this tool has been configured.
- getKey() - Method in class org.apache.velocity.tools.ToolInfo
-
Get tool key
- getKeys() - Method in class org.apache.velocity.tools.generic.ContextTool
-
Return a
Set
of the available reference keys in the current
context.
- getKeys() - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Lists available keys
- getKeys(String, String, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Returns a
List
of the key strings in the ResourceBundle
with the specified baseName and locale.
- getKeys(String, String[], Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
Returns a
List
of the key strings in the specified
ResourceBundles.
- getKeys() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- getKeys() - Method in class org.apache.velocity.tools.Toolbox
-
- getKeys() - Method in class org.apache.velocity.tools.ToolContext
-
- getLast() - Method in class org.apache.velocity.tools.generic.LoopTool
-
- getLast() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- getLast() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns an
XmlTool
that wraps only the
last
Node
from this instance's internal Node list.
- getLastSyncedValues() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- getListDelimiter() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getListFinalDelimiter() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getLocale() - Method in class org.apache.velocity.tools.generic.LocaleConfig
-
This returns the configured default
Locale
for this tool.
- getLocale(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getLocale(String, Locale) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getLocales(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getLog(VelocityEngine, String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
- getLog() - Method in class org.apache.velocity.tools.generic.SafeConfig
-
Get logger
- getLog() - Method in class org.apache.velocity.tools.ToolManager
-
Get logger
- getLong(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getLong(String, Long) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getMethods() - Method in class org.apache.velocity.tools.generic.ClassTool
-
- getMilliseconds() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the number of milliseconds between the dates being compared.
- getMinutes() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the number of minutes between the dates being compared.
- getModifiers() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
- getModifiers() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
- getModifiers() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
- getModifiers() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- getMonth() - Method in class org.apache.velocity.tools.generic.DateTool
-
- getMonth(Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getMonths() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the approximate number of months between the dates being compared, or the bygone
number of months after the bygone number of years in exact mode.
- getN() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a new line character appropriate for the
operating system ("\n" in java).
- getName() - Method in class org.apache.velocity.tools.config.Property
-
- getName() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
- getName() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
- getName() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns the simple name (i.e.
- getName() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
- getName() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- getName() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- getName() - Method in class org.apache.velocity.tools.generic.XmlTool
-
- getNewline() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a new line character appropriate for the
operating system ("\n" in java).
- getNext() - Method in class org.apache.velocity.tools.generic.Alternator
-
Returns the current item, then shifts the list index.
- getNodeName() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns the name of the root node.
- getNodes(String, Node) - Static method in class org.apache.velocity.tools.XmlUtils
-
Search for nodes using an XPath expression
- getNumber(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getNumber(String, Number) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getNumberFormat(String, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- getNumberFormat(int, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- getNumberFormat() - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- getNumberFormat(String, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
-
- getNumbers(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getNumberStyleAsInt(String) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Checks a string to see if it matches one of the standard
NumberFormat style patterns:
number, currency, percent, integer, or default.
- getObject() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Gives access to the wrapped JsonObject, if any
- getPackage() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns the name of the package to which the inspected Class belongs.
- getParameterCount() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
Returns the number of expected parameters.
- getParameters() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
- getParameters() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
- getParameters() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
- getParams() - Method in class org.apache.velocity.tools.generic.LinkTool
-
- getParent() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- getParent() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
-
- getParent() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns a new
XmlTool
instance that wraps
the parent
Element
of the first/sole
Node
being wrapped by this instance.
- getParseDepth() - Method in class org.apache.velocity.tools.generic.RenderTool
-
Get the maximum number of loops allowed when recursing.
- getPath() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the current path value for this instance.
- getPath() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns the XPath that identifies the first/sole
Node
represented by this instance.
- getPort() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the port value, if any.
- getProperties() - Method in class org.apache.velocity.tools.config.Configuration
-
- getProperties() - Method in class org.apache.velocity.tools.Toolbox
-
- getProperties() - Method in class org.apache.velocity.tools.ToolInfo
-
Get tool properties
- getProperty(String) - Method in class org.apache.velocity.tools.config.Configuration
-
- getProperty(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Safely retrieves the specified property from the specified object.
- getPropertyMap() - Method in class org.apache.velocity.tools.config.Configuration
-
- getPropertyName() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
If this method can be treated as a bean property in Velocity
(which does not exactly follow the javabean spec for such things)
then it will return the "bean property" equivalent of the method name.
- getProps() - Method in class org.apache.velocity.tools.ToolInfo
-
Get tools property (synchronized version)
- getProtocol(String) - Static method in class org.apache.velocity.tools.generic.ImportSupport
-
Returns protocol, or null for a local URL
- getQ() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a double quotation mark (").
- getQuery() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the current query as a string, if any.
- getQuote() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a double quotation mark (").
- getRandom() - Method in class org.apache.velocity.tools.generic.MathTool
-
- getRaw() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- getReadOnly() - Method in class org.apache.velocity.tools.generic.ValueParser
-
Is the Map read-only?
- getRelative() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
- getRequestToolbox() - Method in class org.apache.velocity.tools.ToolManager
-
Get the toolbox for request scoped tools
- getResource(String, Object) - Static method in class org.apache.velocity.tools.ClassUtils
-
Load a given resource.
- getResourceAsStream(String, Object) - Static method in class org.apache.velocity.tools.ClassUtils
-
This is a convenience method to load a resource as a stream.
- getResourceReader(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
-
Get a reader of a local resource, first trying with a file (or a webapp resource for the view flavor)
then with a classpath entry.
- getResources(String, Object) - Static method in class org.apache.velocity.tools.ClassUtils
-
Load all resources with the specified name.
- getResourceString(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
-
Fetch a local resource, first trying with a file (or a webapp resource for the view flavor)
then with a classpath entry.
- getRestrictTo() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getReturns() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
- getRoot() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the "root" for this URI, if it has one.
- getRuleSet() - Method in class org.apache.velocity.tools.config.XmlFactoryConfiguration
-
Retrieves the rule set Digester should use to parse and load
the toolbox for this manager.
- getS() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a single quotation mark (').
- getScheme() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Return the scheme value for this instance.
- getScope() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
-
- getSeconds() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the number of seconds between the dates being compared.
- getSelf() - Method in class org.apache.velocity.tools.generic.LinkTool
-
- getShowDeprecated() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns the current showDeprecated setting.
- getSignature() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
Get (and cache) inspected callable signature
- getSingleQuote() - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Renders a single quotation mark (').
- getSkipSetters() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getSource() - Method in exception org.apache.velocity.tools.config.ConfigurationException
-
- getSource() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
Returns the original source of this particular instance.
- getSource(boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getSource() - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getSources() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
Returns the list of sources for this configuration info in
order starting from the source name given to this instance
(if any) and going to the most recently added source.
- getStaticValue() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
Returns the value of the field if and only if
it is a static field that has no access restrictions
set by the security manager.
- getString(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getString(String, String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getStrings(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getStringsDelimiter() - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Gets the configured strings delimiter
- getStringsDelimiter() - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
Gets the delimiter used for separating values in a single String value.
- getStringsTrim() - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Gets whether to trim strings
- getStringsTrim() - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- getSubkey(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
subkey getter that returns a map subkey#2 -> value
for every "subkey.subkey2" found entry
- getSubkeys() - Method in class org.apache.velocity.tools.generic.ValueParser
-
returns the set of all possible first-level subkeys, including complete keys without dots (or returns keySet() if allowSubKeys is false)
- getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
- getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
- getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
- getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- getSuper() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns a new ClassTool instance that is inspecting the
superclass of the Class being inspected by this instance.
- getSystemCalendar() - Static method in class org.apache.velocity.tools.generic.DateTool
-
- getSystemDate() - Static method in class org.apache.velocity.tools.generic.DateTool
-
- getSystemTime() - Static method in class org.apache.velocity.tools.generic.DateTool
-
- getTab() - Method in class org.apache.velocity.tools.generic.MarkupTool
-
- getTarget() - Method in enum org.apache.velocity.tools.config.Data.Type
-
- getTargetClass() - Method in class org.apache.velocity.tools.config.Data
-
- getText(String, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Retrieves the specified text resource.
- getText() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns the concatenated text content of all the internally held
nodes.
- getThis() - Method in class org.apache.velocity.tools.generic.ContextTool
-
Returns the context being analyzed by this tool.
- getThis() - Method in class org.apache.velocity.tools.generic.LoopTool
-
- getTimeZone() - Method in class org.apache.velocity.tools.generic.DateTool
-
- getTool(String) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
-
- getToolbox(String) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- getToolbox() - Method in class org.apache.velocity.tools.generic.ContextTool
-
Returns a read-only view of the toolbox
Map
for this context.
- getToolbox() - Method in class org.apache.velocity.tools.ToolContext
-
Returns a
Map
of all tools available to this
context.
- getToolboxes() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- getToolboxes() - Method in class org.apache.velocity.tools.ToolContext
-
- getToolboxFactory() - Method in class org.apache.velocity.tools.ToolManager
-
- getToolClass() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getToolClass() - Method in class org.apache.velocity.tools.ToolInfo
-
Get tool class
- getToolClassMap() - Method in class org.apache.velocity.tools.Toolbox
-
Return a new
Map
link tools' keys to their
Class
es.
- getToolClassMap() - Method in class org.apache.velocity.tools.ToolContext
-
Gets a map of keys to classes for all available tools.
- getToolConfiguration() - Method in exception org.apache.velocity.tools.config.InvalidScopeException
-
- getToolInfo(String) - Method in class org.apache.velocity.tools.ToolboxFactory
-
- getToolProperties() - Method in class org.apache.velocity.tools.ToolContext
-
- getTools() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
-
- getTotal(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the sum of the values from a list
- getTotal(Object[], String) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the sum of the values from a list
- getTotal(Collection) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the sum of the values
- getTotal(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the sum of the values
- getTotal(double...) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the sum of the values
- getTotal(long...) - Method in class org.apache.velocity.tools.generic.MathTool
-
Get the sum of the values
- getTruncateAtWord() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getTruncateLength() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getTruncateSuffix() - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- getType() - Method in class org.apache.velocity.tools.config.Data
-
- getType() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
- getType() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns the
Class
being inspected by this instance.
- getTypes() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns a
Set
of all
Class
es that are
part of the signatures (i.e.
- getUniqueName() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
Build a unique method/ctor name by appending the simple names of
the expected parameter types, thereby distinguishing constructors
and overloaded methods with a useful name that would still be a
valid method name.
- getUniqueName() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
-
Simply returns the name of the field, since field names
cannot be overloaded.
- getUniqueName() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- getUri() - Method in class org.apache.velocity.tools.generic.LinkTool
-
If the tool is not in "safe mode"--which it is by default--
this will return the
URI
representation of this instance,
if any.
- getUser() - Method in class org.apache.velocity.tools.generic.LinkTool
-
- getUserCanOverwriteTools() - Method in class org.apache.velocity.tools.ToolContext
-
Default is true
.
- getUserCanOverwriteTools() - Method in class org.apache.velocity.tools.ToolManager
-
Get whether template user can overwrite tools keys
- getValidScopes() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- getValue() - Method in class org.apache.velocity.tools.config.Data
-
- getValue(Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getValue(Object, Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getValue(int, Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getValue() - Method in class org.apache.velocity.tools.generic.FieldTool.MutableField
-
- getValue(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getValue(String, Object) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- getValues() - Method in class org.apache.velocity.tools.generic.ContextTool
-
Return a
Set
of the available values in the current
context.
- getValues(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
Returns an array of values.
- getVelocityEngine() - Method in class org.apache.velocity.tools.ToolManager
-
Get the underlying VelocityEngine being used.
- getVelocityView() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
-
Returns a
FactoryConfiguration
including all default
"velocity-tools-view" tools available as well as the default "GenericTools".
- getWeeks() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the number of weeks between the dates being compared.
- getWidth() - Method in class org.apache.velocity.tools.generic.DisplayTool.Measurements
-
- getYear() - Method in class org.apache.velocity.tools.generic.DateTool
-
- getYear(Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- getYears() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Return the approximate number of years between the dates being compared, or the bygone
number of years in exact mode.
- id(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
-
- idiv(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
-
Does integer division on the int values of the specified numbers.
- ImportSupport - Class in org.apache.velocity.tools.generic
-
Provides methods to import arbitrary local or remote resources as strings, generic version.
- ImportSupport() - Constructor for class org.apache.velocity.tools.generic.ImportSupport
-
- importSupport - Variable in class org.apache.velocity.tools.generic.ImportTool
-
ImportSupport utility which provides underlying i/o
- importSupport - Variable in class org.apache.velocity.tools.generic.JsonTool
-
ImportSupport utility which provides underlying i/o
- importSupport - Variable in class org.apache.velocity.tools.generic.XmlTool
-
ImportSupport utility which provides underlying i/o
- ImportSupport.SafeClosingHttpURLConnectionReader - Class in org.apache.velocity.tools.generic
-
- ImportTool - Class in org.apache.velocity.tools.generic
-
General-purpose text-importing tool for templates.
- ImportTool() - Constructor for class org.apache.velocity.tools.generic.ImportTool
-
- in(String) - Method in class org.apache.velocity.tools.generic.FieldTool
-
Returns a
FieldTool.FieldToolSub
holding a
Map
of all the public static field names to values (or a placeholder
if the value is not final) for the specified class(name).
- in(Object) - Method in class org.apache.velocity.tools.generic.FieldTool
-
Returns a
FieldTool.FieldToolSub
holding a
Map
of all the public static field names to values (or a placeholder
if the value is not final) for the
Class
of the
specified Object.
- in(Class) - Method in class org.apache.velocity.tools.generic.FieldTool
-
Returns a
FieldTool.FieldToolSub
holding a
Map
of all the public static field names to values (or a placeholder
if the value is not final) for the specified
Class
.
- INCLUDE_KEY - Static variable in class org.apache.velocity.tools.generic.FieldTool
-
The key used for specifying which classes should be inspected
for public static methods to be made available.
- info(String) - Method in class org.apache.velocity.tools.generic.LogTool
-
- initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.generic.ImportTool
-
Importsupport initialization
- initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.generic.JsonTool
-
ImportSupport initialization
- initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.generic.XmlTool
-
ImportSupport initialization
- initJSON(String) - Method in class org.apache.velocity.tools.generic.JsonTool
-
Initialize JSON content from a string.
- initJSON(Reader) - Method in class org.apache.velocity.tools.generic.JsonTool
-
Initialize JSON content from a reader.
- initLog() - Method in class org.apache.velocity.tools.ToolManager
-
init logger
- initLogger(ValueParser) - Method in class org.apache.velocity.tools.generic.SafeConfig
-
Initialize logger.
- insecure() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns a new instance with the scheme set to "http".
- insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
- insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
- insert(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
- insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
- insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- insert(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- inspect(String) - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns a new ClassTool instance that is inspecting the
Class with the specified name.
- inspect(Object) - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns a new ClassTool instance that is inspecting the
Class of the specified
Object
.
- inspect(Class) - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns a new ClassTool instance that is inspecting the
the specified
Class
.
- inspect(Class) - Method in class org.apache.velocity.tools.generic.FieldTool
-
Looks for all public, static fields in the specified class and
stores their value (if final) or else a
FieldTool.MutableField
for
in a
Map
under the fields' names.
- INSPECT_KEY - Static variable in class org.apache.velocity.tools.generic.ClassTool
-
- INSTANCE - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
-
- INSTANCE - Static variable in class org.apache.velocity.tools.ConversionUtils
-
- integer(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
-
Convenience method equivalent to $number.format("integer", $foo).
- internalEval(Context, String) - Method in class org.apache.velocity.tools.generic.RenderTool
-
- internalGet(String) - Method in class org.apache.velocity.tools.ToolContext
-
- internalRecurse(Context, String, int) - Method in class org.apache.velocity.tools.generic.RenderTool
-
- internalSort(List, List) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Internal sorting method.
- InvalidScope - Annotation Type in org.apache.velocity.tools.config
-
- InvalidScopeException - Exception in org.apache.velocity.tools.config
-
- InvalidScopeException(ToolboxConfiguration, ToolConfiguration) - Constructor for exception org.apache.velocity.tools.config.InvalidScopeException
-
- invoke(Method, Object, Object) - Method in class org.apache.velocity.tools.ToolInfo
-
Invoke a single argument method on a tool
- isAbsolute() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns true if this instance has a scheme value
and is not being forced to create relative URIs.
- isAbstract() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is declared abstract.
- isAbstract() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isArray() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Check if wrapped object is a JsonArray
- isAuto() - Method in class org.apache.velocity.tools.generic.Alternator
-
- isConfigLocked() - Method in class org.apache.velocity.tools.generic.SafeConfig
-
- isCustom() - Method in enum org.apache.velocity.tools.config.Data.Type
-
- isDeprecated(AnnotatedElement) - Static method in class org.apache.velocity.tools.generic.ClassTool
-
Check if an annotation deprecates its class
- isDeprecated() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class has been deprecated.
- isDeprecated() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
Inspected object deprecation status
- isEmpty() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
-
- isEmpty() - Method in class org.apache.velocity.tools.generic.ValueParser
-
- isEmpty() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns
true
if there are no
Node
s internally held
by this instance.
- isFinal() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is declared final.
- isFinal() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isFirst() - Method in class org.apache.velocity.tools.generic.LoopTool
-
- isFirst(String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
- isFirst() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- isInterface() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is an interface.
- isInterface() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isLast() - Method in class org.apache.velocity.tools.generic.LoopTool
-
- isLast(String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
- isLast() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- isList() - Method in enum org.apache.velocity.tools.config.Data.Type
-
- isNative() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isNull() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Check if wrapped object is null
- isObject() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Check if wrapped object is a JsonObject
- isOpaque() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns true if this instance represents an opaque URI.
- isOrphan() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
-
- isPrivate() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is declared private.
- isPrivate() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isProtected() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is declared protected.
- isProtected() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isPublic() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is declared public.
- isPublic() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isRelative() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns true if this instance is being forced to
return relative URIs or has a null scheme value.
- isRemoteURL(String) - Static method in class org.apache.velocity.tools.generic.ImportSupport
-
Returns whether an URL is remote or local
- isSafeMode() - Method in class org.apache.velocity.tools.generic.SafeConfig
-
Returns true
if this tool is in "safe mode".
- isSecure() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns true if this instance's scheme is "https".
- isSkipSetters() - Method in class org.apache.velocity.tools.ToolInfo
-
Get whether setters are to be skipped
- isStatic() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is an inner class
that has been declared static or is a standard outer class..
- isStatic() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isStrict() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if the inspected Class is declared strictfp
(uses strict floating point math).
- isStrict() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isSyncedWith(String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- isSynchronized() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isTransient() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isVarArgs() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
- isVarArgs() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
-
Returns true if the final parameter for the constructor was declared
as a vararg.
- isVarArgs() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
Returns true if the final parameter for the method was declared
as a vararg.
- isVoid() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
-
Returns true if the return type of this method is void.
- isVolatile() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- isXHTML() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns true if the query delimiter used by this instance is
using &
as the delimiter for query data pairs
or just using &
.
- isXmlMimeType(String) - Static method in class org.apache.velocity.tools.XmlUtils
-
Checkes whether the given mime type is an XML format
- iterator() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Get an iterator.
- iterator() - Method in class org.apache.velocity.tools.generic.JsonTool
-
Get an iterator.
- iterator() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns an
Iterator
that returns new
XmlTool
instances for each
Node
held internally by this instance.
- SAFE_MODE_KEY - Static variable in class org.apache.velocity.tools.generic.SafeConfig
-
Many tools interested in locking configure() also have other
things they wish to secure.
- SafeConfig - Class in org.apache.velocity.tools.generic
-
Implements common logic and constants for tools which automatically
locks down the public void configure(Map params)
method after
it is called once.
- SafeConfig() - Constructor for class org.apache.velocity.tools.generic.SafeConfig
-
- scheme - Variable in class org.apache.velocity.tools.generic.LinkTool
-
- scheme(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns a new instance with the specified value set as its scheme.
- SCHEME_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
-
- Scope - Class in org.apache.velocity.tools
-
A specialized constants class to provide some compile-time typo checking and
runtime validation for scopes specified in annotations, toolbox configs, etc.
- search(String, Node) - Static method in class org.apache.velocity.tools.XmlUtils
-
Search for nodes using an XPath expression
- SECOND_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
-
- secure() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns a new instance with the scheme set to "https".
- SECURE_SCHEME - Static variable in class org.apache.velocity.tools.generic.LinkTool
-
- self - Variable in class org.apache.velocity.tools.generic.LinkTool
-
- SESSION - Static variable in class org.apache.velocity.tools.Scope
-
- set(Object, Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Sets a new key=value pair to the existing query
data, overwriting any previous pair(s) that have
the same key.
- setAllowedTags(String[]) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setAllowSubkeys(boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
-
allow or disallow subkeys
- setAppendParams(boolean) - Method in class org.apache.velocity.tools.generic.LinkTool
-
- setAuto(boolean) - Method in class org.apache.velocity.tools.generic.Alternator
-
If set to true, the list index will shift automatically after a
call to toString().
- setAutoAlternateDefault(boolean) - Method in class org.apache.velocity.tools.generic.AlternatorTool
-
Deprecated.
Sets the default for auto-alternating.
- setCatchExceptions(boolean) - Method in class org.apache.velocity.tools.generic.RenderTool
-
Sets whether or not the render() and eval() methods should catch
exceptions during their execution or not.
- setCellLength(int) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setCellSuffix(String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setCharacterEncoding(String) - Method in class org.apache.velocity.tools.generic.LinkTool
-
- setChildren(Collection<C>) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
-
- setClass(String) - Method in class org.apache.velocity.tools.config.Data
-
This doesn't take a
Class
parameter because
this class was not created for all-java configuration.
- setClass(Class) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
Deprecated.
- setClass(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- setClass(Class) - Method in class org.apache.velocity.tools.ToolInfo
-
Set the tool class
- setClassname(String) - Method in class org.apache.velocity.tools.config.Data
-
- setClassname(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- setConverter(Class) - Method in class org.apache.velocity.tools.config.Data
-
- setConverter(String) - Method in class org.apache.velocity.tools.config.Data
-
- setData(Collection<Data>) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- setDataClass(Class) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
-
- setDateFormat(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- setDefaultAlternate(String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setDefaultBundle(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
-
- setFactory(Class) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- setFactory(Class) - Method in class org.apache.velocity.tools.ToolInfo
-
Set the factory class used to create tool instances.
- setFactoryClassname(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- setForceRelative(boolean) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Sets whether or not the
LinkTool.createURI()
method should ignore the
scheme, user, port and host values for non-opaque URIs, thus making
LinkTool.toString()
print the link as a relative one, not an absolute
one.
- setFormat(String) - Method in class org.apache.velocity.tools.generic.FormatConfig
-
Sets the default format for this instance.
- setFragment(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Sets the anchor for this instance and treats empty strings like null.
- setFromURI(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
If the specified value is null, this will set the scheme, userInfo,
host, port, path, query, and fragment all to their null-equivalent
values.
- setHost(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Sets host
- setKey(String) - Method in class org.apache.velocity.tools.config.Data
-
- setKey(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- setKey(String) - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Sets the key under which this tool has been configured.
- setKey(String) - Method in class org.apache.velocity.tools.ToolInfo
-
Set the tool key
- setListDelimiter(String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setListFinalDelimiter(String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setLocale(Locale) - Method in class org.apache.velocity.tools.generic.LocaleConfig
-
Sets the default locale for this instance.
- setLockConfig(boolean) - Method in class org.apache.velocity.tools.generic.SafeConfig
-
Only allow subclass access to this.
- setLog(Logger) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
-
- setName(String) - Method in class org.apache.velocity.tools.config.Property
-
- setNumberFormat(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- setParam(Object, Object, boolean) - Method in class org.apache.velocity.tools.generic.LinkTool
-
If there is no existing value for this key in the query, it
will simply add it and its value to the query.
- setParams(Object, boolean) - Method in class org.apache.velocity.tools.generic.LinkTool
-
- setParseDepth(int) - Method in class org.apache.velocity.tools.generic.RenderTool
-
Set the maximum number of loops allowed when recursing.
- setPath(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
If this instance is not opaque and the specified value does
not start with a '/' character, then that will be prepended
automatically.
- setPort(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
If the specified object is null, this will set the port value
to -1 to indicate that.
- setProperties(Collection<Property>) - Method in class org.apache.velocity.tools.config.Configuration
-
- setProperties(ExtProperties, Data) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
-
- setProperty(String, Object) - Method in class org.apache.velocity.tools.config.Configuration
-
- setProperty(Object, String, Object) - Method in class org.apache.velocity.tools.ToolInfo
-
Set a property on a tool instance
- setPropertyClass(Class) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
-
- setPropertyMap(Map<String, Object>) - Method in class org.apache.velocity.tools.config.Configuration
-
- setQuery(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
If the specified value is null, it will set the query to null.
- setReadOnly(boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
-
Set or unset read-only behaviour
- setRestrictTo(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- setRoot(Node) - Method in class org.apache.velocity.tools.generic.XmlTool
-
Sets a singular root
Node
for this instance.
- setRuleSet(RuleSet) - Method in class org.apache.velocity.tools.config.XmlFactoryConfiguration
-
Sets the RuleSet
this loader will use to
digest the xml toolbox.
- setSafeMode(boolean) - Method in class org.apache.velocity.tools.generic.ImportSupport
-
Sets or clears safe mode
- setSafeMode(boolean) - Method in class org.apache.velocity.tools.generic.SafeConfig
-
Set or clear safe mode.
- setScheme(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
This will treat empty strings like null values
and will trim any trailing ':' character.
- setScope(String) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
-
- setSkipSetters(Boolean) - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- setSkipSetters(boolean) - Method in class org.apache.velocity.tools.ToolInfo
-
Set whether or not to skip setters.
- setSource(String) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
Sets the name of the original source of this particular instance.
- setSource(Map<String, Object>) - Method in class org.apache.velocity.tools.generic.ValueParser
-
- setStringsDelimiter(String) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sets the delimiter used for separating values in a single String value.
- setStringsDelimiter(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- setStringsDelimiter(String) - Method in class org.apache.velocity.tools.generic.ValueParser
-
Sets the delimiter used for separating values in a single String value.
- setStringsTrim(boolean) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sets whether strings should be trimmed when separated from
a delimited string value.
- setStringsTrim(boolean) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- setTab(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
-
Configuration
- setTargetClass(Class) - Method in class org.apache.velocity.tools.config.Data
-
- setTimeZone(TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
-
Sets time zone
- setToolboxConfigurationClass(Class) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
-
- setToolboxes(Collection<ToolboxConfiguration>) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- setToolboxFactory(ToolboxFactory) - Method in class org.apache.velocity.tools.ToolManager
-
Sets the underlying ToolboxFactory being used.
- setToolConfigurationClass(Class) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
-
- setTools(Collection<ToolConfiguration>) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
-
- setTruncateAtWord(boolean) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setTruncateLength(int) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setTruncateSuffix(String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
- setType(Data.Type) - Method in class org.apache.velocity.tools.config.Data
-
- setType(String) - Method in class org.apache.velocity.tools.config.Data
-
- setType(Class) - Method in class org.apache.velocity.tools.generic.ClassTool
-
Set the class to inspect
- setUserCanOverwriteTools(boolean) - Method in class org.apache.velocity.tools.ToolContext
-
Set whether or not tool references can be overwritten within a template.
- setUserCanOverwriteTools(boolean) - Method in class org.apache.velocity.tools.ToolManager
-
Set whether template user can overwrite tools keys
- setUserInfo(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Sets user info
- setValue(Object) - Method in class org.apache.velocity.tools.config.Data
-
- setVelocityContext(Context) - Method in class org.apache.velocity.tools.generic.RenderTool
-
- setVelocityEngine(VelocityEngine) - Method in class org.apache.velocity.tools.generic.RenderTool
-
Allow user to specify a VelocityEngine to be used
in place of the Velocity singleton.
- setVelocityEngine(VelocityEngine) - Method in class org.apache.velocity.tools.ToolManager
-
Sets the underlying VelocityEngine being used.
- setXHTML(boolean) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Controls the delimiter used for separating query data pairs.
- shift() - Method in class org.apache.velocity.tools.generic.Alternator
-
Manually shifts the list index.
- shift() - Method in class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
-
If the sync'ed iterator has any more values,
this sets the next() value as the current one.
- SHOW_DEPRECATED_KEY - Static variable in class org.apache.velocity.tools.generic.ClassTool
-
- signature - Variable in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
- signature(boolean) - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
Internal method to get the inspected callable signature.
- size() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Get size of root object or array.
- size() - Method in class org.apache.velocity.tools.generic.JsonTool
-
Get size of root object or array.
- size() - Method in class org.apache.velocity.tools.generic.ValueParser
-
- size() - Method in class org.apache.velocity.tools.generic.XmlTool
-
Returns the number of
Node
s internally held by this instance.
- skip(long) - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
-
- skip(int) - Method in class org.apache.velocity.tools.generic.LoopTool
-
Skips ahead the specified number of iterations (if possible).
- skip(int, String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
This tells the specified loop to skip ahead the specified number of
iterations.
- SKIPPED_UNITS_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
-
The key used for specifying time units to be skipped over.
- SkipSetters - Annotation Type in org.apache.velocity.tools.config
-
Annotation specifying that
ToolInfo
should only use the public void configure(Map) method for configuration of
a tool, and skip over the step of trying to find individual
property setters.
- sort(Collection<T>, Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts a Collection using a Comparator.
- sort(T[], Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts an array using a Comparator.
- sort(Map<?, T>, Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts a Map's values using a Comparator.
- sort(Object, Comparator<?>) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts a Collection (or array, or Map's values)
using a Comparator.
- sort(Collection) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sort a collection
- sort(Object[]) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sort an array
- sort(Map) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sort map values
- sort(Object) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sort a collection, array or map
- sort(Object, String) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts the collection on a single property.
- sort(Collection, List) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts the collection on several properties.
- sort(Map, List) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts map values on several properties.
- sort(Object[], List) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
Sorts array on several properties.
- SortTool - Class in org.apache.velocity.tools.generic
-
- SortTool() - Constructor for class org.apache.velocity.tools.generic.SortTool
-
Deprecated.
- space(int) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Returns a string of spaces of the specified length.
- split(String) - Method in class org.apache.velocity.tools.generic.CollectionTool
-
- split(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
-
- sql(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
-
Escapes the characters in a String
to be suitable to pass to an SQL query.
- stop() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
Stops this iterator from doing any further iteration.
- stop(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
Directs this instance to stop iterating immediately prior to
any element equal to the specified Object.
- stop() - Method in class org.apache.velocity.tools.generic.LoopTool
-
This tells the current loop to stop after the current iteration.
- stop(String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
This is just like
LoopTool.stop()
except that the stop command is issued
only to the loop/iterator with the specified name.
- stopAll() - Method in class org.apache.velocity.tools.generic.LoopTool
-
This is just like
LoopTool.stop()
except that the stop command is issued
all the loops being watched by this tool.
- stopTo(String) - Method in class org.apache.velocity.tools.generic.LoopTool
-
This is just like
LoopTool.stop(String)
except that the stop command is issued
both to the loop/iterator with the specified name and all loops nested within
it.
- storage - Variable in class org.apache.velocity.tools.generic.FieldTool
-
- STORE_DYNAMIC_KEY - Static variable in class org.apache.velocity.tools.generic.FieldTool
-
The key used for specifying whether or not the tool should store
fields in classes dynamically looked up from within a template.
- storeDynamicLookups - Variable in class org.apache.velocity.tools.generic.FieldTool
-
- string(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
-
- STRINGS_DELIMITER_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.CollectionTool
-
- STRINGS_DELIMITER_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- STRINGS_DELIMITER_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ValueParser
-
- STRINGS_TRIM_KEY - Static variable in class org.apache.velocity.tools.generic.CollectionTool
-
- stripTags(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Removes HTML tags from the string value of the specified object and
returns the resulting string.
- stripTags(Object, String...) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Removes all not allowed HTML tags from the string value of the specified
object and returns the resulting string.
- Sub() - Constructor for class org.apache.velocity.tools.generic.ClassTool.Sub
-
- sub(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
-
- sub(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
-
- supportsNewInstance() - Method in class org.apache.velocity.tools.generic.ClassTool
-
Returns true if a call to newInstance() on the Class being
inspected is successful; otherwise returns false.
- sync(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
Adds another iterator to be kept in sync with the one
being managed by this instance.
- sync(Object, String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
Adds another iterator to be kept in sync with the one
being managed by this instance.
- sync(Object, Object) - Method in class org.apache.velocity.tools.generic.LoopTool
-
- SyncedIterator(Iterator) - Constructor for class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
-
- SYSTEM_PROPERTY_KEY - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
-
- tag(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
-
- Tag(MarkupTool) - Constructor for class org.apache.velocity.tools.generic.MarkupTool.Tag
-
- takesParameters() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
-
- target(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- test(Object) - Method in interface org.apache.velocity.tools.generic.LoopTool.Condition
-
- test(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.Equals
-
- TIME_UNITS - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Array of all time unit message keys to their millisecond conversion factor.
- timespan(Object, Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
- TIMEZONE_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
-
The key used for specifying a default timezone via tool configuration.
- toBoolean(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- toBoolean(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toBooleans(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toBooleans(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toCalendar(Date, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- toCalendar(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- toCalendar(Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toCalendar(Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toCalendar(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toCalendar(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toCalendar(String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
-
Converts an object to an instance of
Calendar
using the
provided format, locale and time zone.
- toCalendars(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toCalendars(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toDate(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Attempts to convert an unidentified
Object
into a
Date
,
just short of turning it into a string and parsing it.
- toDate(Object, String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Converts an object to an instance of
Date
using the
specified format,
Locale
, and
TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
- toDate(String, String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Converts an object to an instance of
Date
using the
specified format,
Locale
, and
TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
- toDate(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- toDate(Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toDate(Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toDate(Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toDate(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool
-
- toDate(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
-
Converts an object to an instance of
Date
using the
specified format and
Locale
if the object is not already
an instance of Date, Calendar, or Long.
- toDate(String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
-
Converts an object to an instance of
Date
using the
specified format,
Locale
, and
TimeZone
if the
object is not already an instance of Date, Calendar, or Long.
- toDates(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toDates(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toDays(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Returns the number of whole Days in the specified number of milliseconds.
- toDouble(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toDouble(Object) - Method in class org.apache.velocity.tools.generic.MathTool
-
- toDoubles(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toHours(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Returns the number of whole Hours in the specified number of milliseconds.
- toInteger(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toInteger(Object) - Method in class org.apache.velocity.tools.generic.MathTool
-
- toIntegers(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toInts(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toList(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
Convert a singleton or an array as List
- toLocale(String) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- toLocale(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- toLocale(Object) - Method in class org.apache.velocity.tools.generic.LocaleConfig
-
- toLocales(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toLocales(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toLocalizedPattern(String, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
-
Returns a localized date format pattern for the given format.
- toLong(Object) - Method in class org.apache.velocity.tools.generic.MathTool
-
- toMinutes(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Returns the number of whole Minutes in the specified number of milliseconds.
- toMonths(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Returns the number of whole Months in the specified number of milliseconds.
- toNumber(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Attempts to convert an unidentified
Object
into a
Number
,
just short of turning it into a string and parsing it.
- toNumber(Object, boolean) - Static method in class org.apache.velocity.tools.ConversionUtils
-
- toNumber(String, String, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Converts a string to an instance of
Number
using the
specified format and
Locale
to parse it.
- toNumber(Object, String, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Converts an object to an instance of
Number
using the
specified format and
Locale
to parse it, if necessary.
- toNumber(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toNumber(Object) - Method in class org.apache.velocity.tools.generic.MathTool
-
- toNumber(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
-
- toNumber(String, Object) - Method in class org.apache.velocity.tools.generic.NumberTool
-
- toNumber(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
-
Converts an object to an instance of
Number
using the
specified format and
Locale
if the object is not already
an instance of Number.
- toNumbers(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- toNumbers(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
- tool(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
-
- tool(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
-
- tool(String, Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
-
- tool(String, String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
-
- tool(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
-
- tool(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
-
- tool(String, String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
-
- tool(String, Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
-
- toolbox(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
-
- toolbox - Variable in class org.apache.velocity.tools.generic.ContextTool
-
- Toolbox - Class in org.apache.velocity.tools
-
Instances of this class are typically created by a
ToolboxFactory
on a one-per-scope basis.
- Toolbox(Map<String, ToolInfo>) - Constructor for class org.apache.velocity.tools.Toolbox
-
- Toolbox(Map<String, ToolInfo>, Map<String, Object>) - Constructor for class org.apache.velocity.tools.Toolbox
-
- ToolboxConfiguration - Class in org.apache.velocity.tools.config
-
This class handles configuration info for the Toolbox instances
that will eventually be produced by
ToolboxFactory
.
- ToolboxConfiguration() - Constructor for class org.apache.velocity.tools.config.ToolboxConfiguration
-
- toolboxConfigurationClass - Variable in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
-
- ToolboxFactory - Class in org.apache.velocity.tools
-
This class is the central point of action for VelocityTools.
- ToolboxFactory() - Constructor for class org.apache.velocity.tools.ToolboxFactory
-
- ToolConfiguration - Class in org.apache.velocity.tools.config
-
This class handles configuration info for tools, including their key,
classname, path restriction, and properties.
- ToolConfiguration() - Constructor for class org.apache.velocity.tools.config.ToolConfiguration
-
- toolConfigurationClass - Variable in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
-
- ToolContext - Class in org.apache.velocity.tools
-
Context
implementation that keeps a list of
Toolbox
es
and returns them as requested, using its internal context Map as the
dynamic properties passed to the requested tools when they are first
created.
- ToolContext() - Constructor for class org.apache.velocity.tools.ToolContext
-
- ToolContext(VelocityEngine) - Constructor for class org.apache.velocity.tools.ToolContext
-
Creates an instance that automatically has the specified
VelocityEngine and related tool properties set.
- ToolContext(Map<String, Object>) - Constructor for class org.apache.velocity.tools.ToolContext
-
Creates an instance starting with the specified tool properties.
- ToolInfo - Class in org.apache.velocity.tools
-
Manages data needed to create instances of a tool.
- ToolInfo(String, Class) - Constructor for class org.apache.velocity.tools.ToolInfo
-
Creates a new instance using the minimum required info
necessary for a tool.
- ToolInfo(String, Class, Class) - Constructor for class org.apache.velocity.tools.ToolInfo
-
Creates a new instance using the minimum required info
necessary for a tool.
- TOOLKEY_KEY - Static variable in class org.apache.velocity.tools.ToolContext
-
- ToolManager - Class in org.apache.velocity.tools
-
Manages tools for non-web applications.
- ToolManager() - Constructor for class org.apache.velocity.tools.ToolManager
-
Constructs an instance already configured to use the default tools and
any configuration specified via a "org.apache.velocity.tools"
system property.
- ToolManager(boolean) - Constructor for class org.apache.velocity.tools.ToolManager
-
Constructs an instance that may or not include default tools,
and already configured with
any configuration specified via a "org.apache.velocity.tools"
system property.
- ToolManager(boolean, boolean) - Constructor for class org.apache.velocity.tools.ToolManager
-
Constructs an instance that may or not include default tools,
and which may or not be already configured with
any configuration specified via a "org.apache.velocity.tools"
system property.
- toQuery(Map) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Converts the map of keys to values into a query string.
- toQuery(Object, Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Turns the specified key and value into a properly encoded
query pair string.
- toSeconds(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Returns the number of whole Seconds in the specified number of milliseconds.
- toString() - Method in class org.apache.velocity.tools.config.Data
-
- toString() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- toString(boolean) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
-
- toString() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
-
- toString() - Method in class org.apache.velocity.tools.config.ToolConfiguration
-
- toString(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Converts objects to String in a more Tools-ish way than
String.valueOf(Object), especially with nulls, Arrays and Collections.
- toString(Collection) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Returns the first value as a String, if any; otherwise returns null.
- toString() - Method in class org.apache.velocity.tools.generic.Alternator
-
Returns a string representation of the current item or
null
if the current item is null.
- toString() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
-
- toString() - Method in class org.apache.velocity.tools.generic.ClassTool
-
- toString(long, int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Converts the specified positive duration of milliseconds into larger
units up to the specified number of positive units, beginning with the
largest positive unit.
- toString() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
-
Renders this comparison to a String.
- toString(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
Deprecated.
Converts objects to String in a more Tools-ish way than
String.valueOf(Object), especially with nulls, Arrays and Collections.
- toString() - Method in class org.apache.velocity.tools.generic.DateTool
-
- toString() - Method in class org.apache.velocity.tools.generic.DisplayTool.Measurements
-
- toString() - Method in class org.apache.velocity.tools.generic.FieldTool.FieldToolSub
-
Return the toString() value of the internal results Map for this sub.
- toString() - Method in class org.apache.velocity.tools.generic.JsonContent
-
Convert JSON object or array into string
- toString() - Method in class org.apache.velocity.tools.generic.JsonTool
-
Convert JSON object or array into string
- toString() - Method in class org.apache.velocity.tools.generic.LinkTool
-
Returns the full URI reference that's been built with this tool,
including the query string and anchor, e.g.
- toString() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
-
- toString() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
-
- toString() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
-
- toString() - Method in class org.apache.velocity.tools.generic.ValueParser
-
- toString() - Method in class org.apache.velocity.tools.generic.XmlTool
-
If this instance has no XML
Node
s, then this
returns the result of
super.toString()
.
- toStrings(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
-
- toURI(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
-
Turns the specified object into a string and thereby a URI.
- toURL(String) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Converts a string to a
URL
.
- toURL(String, Object) - Static method in class org.apache.velocity.tools.ConversionUtils
-
Converts a string to a
URL
.
- toWeeks(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Returns the number of whole Weeks in the specified number of milliseconds.
- toYears(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
-
Returns the number of whole Years in the specified number of milliseconds.
- trace(String) - Method in class org.apache.velocity.tools.generic.LogTool
-
- truncate(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Limits the string value of 'truncateMe' to the configured max length
in characters (default is 30 characters).
- truncate(Object, int) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Limits the string value of 'truncateMe' to 'maxLength' characters.
- truncate(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Limits the string value of 'truncateMe' to the configured max length
in characters (default is 30 characters).
- truncate(Object, int, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Limits the string value of 'truncateMe' to the specified max length in
characters.
- truncate(Object, int, String, boolean) - Method in class org.apache.velocity.tools.generic.DisplayTool
-
Limits the string value of 'truncateMe' to the latest complete word
within the specified maxLength.
- TRUNCATE_AT_WORD_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
-
- TRUNCATE_LENGTH_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
-
- TRUNCATE_SUFFIX_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
-
- type(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- type(Data.Type) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
-
- type - Variable in class org.apache.velocity.tools.generic.ClassTool
-
- TYPE_ASCENDING_SHORT - Static variable in class org.apache.velocity.tools.generic.CollectionTool.PropertiesComparator
-
- TYPE_DESCENDING_SHORT - Static variable in class org.apache.velocity.tools.generic.CollectionTool.PropertiesComparator
-