Index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes All Packages

A

abbr(boolean) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison: Sets whether or not this comparison is to be rendered in abbreviated form or not.
ABBR_SUFFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
abs(Object) - Method in class org.apache.velocity.tools.generic.MathTool
absolute() - Method in class org.apache.velocity.tools.generic.LinkTool: Returns a copy of this LinkTool instance that has LinkTool.setForceRelative(boolean) set to false and sets the scheme to the "http" if no scheme has been set yet.
absolute(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Returns a copy of the link with the specified URI reference either used as or converted to an absolute (non-relative) URI reference.
acquireLocalURLReader(String) - Method in class org.apache.velocity.tools.generic.ImportSupport: Acquire a reader to a local URL - non applicable to the generic version of ImportSupport
acquireLocalURLString(String) - Method in class org.apache.velocity.tools.generic.ImportSupport: Aquire the content of a local URL.
acquireReader(String) - Method in class org.apache.velocity.tools.generic.ImportSupport: Acquire a reader to an URL
acquireRemoteURLReader(String) - Method in class org.apache.velocity.tools.generic.ImportSupport: Acquire a reader to a remote URL
acquireRemoteURLString(String) - Method in class org.apache.velocity.tools.generic.ImportSupport: Aquire the content of a remote URL.
acquireString(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
action - Variable in class org.apache.velocity.tools.generic.LoopTool.ActionCondition
ActionCondition(LoopTool.Action, LoopTool.Condition) - Constructor for class org.apache.velocity.tools.generic.LoopTool.ActionCondition
add(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
add(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
add(String) - Static method in class org.apache.velocity.tools.Scope
addChild(C) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
addChildren(Collection<C>) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
addClass(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
addConfiguration(CompoundConfiguration<C>) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
addConfiguration(Configuration) - Method in class org.apache.velocity.tools.config.Configuration
addConfiguration(Configuration) - Method in class org.apache.velocity.tools.config.ToolConfiguration
addConfiguration(FactoryConfiguration) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
addData(Data) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
addDefaultTools() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration: Adds the ConfigurationUtils.getDefaultTools() configuration to this the current configuration.
addDefaultTools() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
addProperties(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo: Adds a map of properties from a parent scope to the properties for this tool.
addProperty(Property) - Method in class org.apache.velocity.tools.config.Configuration
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet: Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).
addSource(String) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
addTool(ToolConfiguration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
addToolbox(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
addToolbox(Toolbox) - Method in class org.apache.velocity.tools.ToolContext
addToolboxes(ToolContext) - Method in class org.apache.velocity.tools.ToolManager: Add toolboxes to contex
addToolInfo(String, ToolInfo) - Method in class org.apache.velocity.tools.ToolboxFactory
AFTER_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
ALLOWED_TAGS_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
ALLOWSUBKEYS_KEY - Static variable in class org.apache.velocity.tools.generic.ValueParser: The key used for specifying whether to support subkeys
alt(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool: Returns a configured default value if specified value is null.
alt(Object, Object) - Method in class org.apache.velocity.tools.generic.DisplayTool: Returns the second argument if first argument specified is null.
Alternator - Class in org.apache.velocity.tools.generic: Utility class for easily alternating over values in a list.
Alternator(boolean, Object...) - Constructor for class org.apache.velocity.tools.generic.Alternator: Creates a new Alternator for the specified list with the specified automatic shifting preference.
Alternator(Object...) - Constructor for class org.apache.velocity.tools.generic.Alternator: Creates a new Alternator for the specified list.
AlternatorTool - Class in org.apache.velocity.tools.generic: Deprecated.
use CSS3 nth-child(even/odd) selectors or #if($foreach.index % 2)
AlternatorTool() - Constructor for class org.apache.velocity.tools.generic.AlternatorTool: Deprecated.
anchor(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Returns a copy of the link with the specified anchor to be added to the end of the generated hyperlink.
append(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Appends the given value to the end of the current path value.
append(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
append(Object, Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Appends a new key=value pair to the existing query data.
APPEND_PARAMS_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
appendAsArray(StringBuilder, Object, Object[]) - Method in class org.apache.velocity.tools.generic.LinkTool
appendChildren(StringBuilder, String, String) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
appendParams - Variable in class org.apache.velocity.tools.generic.LinkTool
appendPath(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Uses LinkTool.combinePath(java.lang.String, java.lang.String) to add the specified value to the current LinkTool.getPath() value.
appendProperties(StringBuilder) - Method in class org.apache.velocity.tools.config.Configuration
appendQuery(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Uses LinkTool.combineQuery(java.lang.String, java.lang.String) to append the specified value to the current LinkTool.getQuery() value.
APPLICATION - Static variable in class org.apache.velocity.tools.Scope
asList(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
attr(Object) - Method in class org.apache.velocity.tools.generic.XmlTool: Returns the value of the specified attribute for the first/sole Node in the internal Node list for this instance, if that Node is an Element.
attr(Object, Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
attributes() - Method in class org.apache.velocity.tools.generic.XmlTool: Returns a Map of all attributes for the first/sole Node held internally by this instance.
auto(Object...) - Method in class org.apache.velocity.tools.generic.AlternatorTool: Deprecated.

Make an automatic Alternator from the specified objects.
AUTO - org.apache.velocity.tools.config.Data.Type
AUTO_ALTERNATE_DEFAULT_KEY - Static variable in class org.apache.velocity.tools.generic.AlternatorTool: Deprecated.
autoConfigure(boolean) - Method in class org.apache.velocity.tools.ToolManager: Autoconfiguration using the configuration file potentially found in the org.apache.velocity.tools system property.
AutoConverter() - Constructor for class org.apache.velocity.tools.config.Data.AutoConverter
autoLoad() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
autoLoad(boolean) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
AUTOLOADED_PROPS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
AUTOLOADED_XML_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils

B

BEFORE_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet.PropertyAttributeRule
bitwiseAnd(Object...) - Method in class org.apache.velocity.tools.generic.MathTool: Bitwise And
bitwiseAnd(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
bitwiseOr(Object...) - Method in class org.apache.velocity.tools.generic.MathTool: Bitwise Or
bitwiseOr(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
bitwiseXOr(Object...) - Method in class org.apache.velocity.tools.generic.MathTool: Bitwise XOr
bitwiseXOr(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
body(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
body(String, String, String) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet.DataValueInBodyRule
bool(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
BOOLEAN - org.apache.velocity.tools.config.Data.Type
br(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool: Inserts HTML line break tag (<br />) in front of all newline characters of the string value of the specified object and returns the resulting string.
bundle(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
bundle(String) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
BUNDLE_NAME_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The key used for specifying a default locale via toolbox params.
BUNDLES_KEY - Static variable in class org.apache.velocity.tools.generic.ResourceTool

C

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, 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(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_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 Elements of all the current internally held nodes that are Elements themselves.
classname(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
ClassTool - Class in org.apache.velocity.tools.generic: This tool is meant to simplify reflective lookup of information about a Class and its Fields, Methods, and Constructors.
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(Configuration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
clean(Configuration) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils: Convenience method that automatically creates a new ConfigurationCleaner and applies it to the specified Configuration.
clean(FactoryConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
clean(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
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(Map<String, Object>...) - Method in class org.apache.velocity.tools.ToolInfo: Combine several property maps
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 Toolboxes.
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 - Variable in class org.apache.velocity.tools.generic.LoopTool.Comparison
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.
compareTo(Configuration) - Method in class org.apache.velocity.tools.config.Configuration
compareTo(Configuration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
compareTo(Configuration) - Method in class org.apache.velocity.tools.config.ToolConfiguration
compareTo(Data) - Method in class org.apache.velocity.tools.config.Data
compareTo(T) - Method in class org.apache.velocity.tools.generic.ClassTool.Sub: Compare unique names of inspected and given objects
Comparison(Object) - Constructor for class org.apache.velocity.tools.generic.LoopTool.Comparison
Comparison(Calendar, Calendar, int, int, boolean, Locale) - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison: Comparison object constructor
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: This class manages a SortedSet of child Configurations as well as being a Configuration itself.
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: Adds a new LoopTool.ActionCondition for this instance to check against the elements in the iterator being managed.
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 Propertys 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(Configuration, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
ConfigurationException(Configuration, String, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
ConfigurationException(Configuration, 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(Data, 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(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(String) - Method in class org.apache.velocity.tools.ToolManager: Configure the tool manager with the provided configuration file
configure(Map<String, Object>) - Method in class org.apache.velocity.tools.generic.SafeConfig: If SafeConfig.isConfigLocked() returns true, then this method does nothing; otherwise, if false, this will create a new ValueParser from the specified Map of params and call SafeConfig.configure(ValueParser) with it.
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolboxFactory
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolManager: Configure the tool manager with this toolbox factory config
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(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_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: Deprecated.
use NumberTool for numbers and booleans formatting/parsing, DateTool for date/time formatting/parsing, or CollectionTool for toStrings().
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(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
convert(Object) - Method in class org.apache.velocity.tools.config.Data
convert(String) - Method in class org.apache.velocity.tools.config.Data.AutoConverter
converter(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
converter(String) - 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: Returns a new, standard ToolboxFactory configured with the results of ConfigurationUtils.findFromSystemProperty().
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
CUSTOM - org.apache.velocity.tools.config.Data.Type

D

data(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
data(String, String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
data(String, Data.Type, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
Data - Class in org.apache.velocity.tools.config: This class represents configured data.
Data() - Constructor for class org.apache.velocity.tools.config.Data
Data.AutoConverter - Class in org.apache.velocity.tools.config
Data.FieldConverter - Class in org.apache.velocity.tools.config
Data.NumberConverter - Class in org.apache.velocity.tools.config
Data.Type - Enum in org.apache.velocity.tools.config: Delineates the standard, known types and their associated target classes (Data.setTargetClass(java.lang.Class) and converters (Data.setConverter(java.lang.Class)).
dataClass - Variable in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
DataValueInBodyRule() - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet.DataValueInBodyRule
DATE_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ConversionTool: Deprecated.
DateTool - Class in org.apache.velocity.tools.generic: Tool for working with Date and Calendar in Velocity templates.
DateTool() - Constructor for class org.apache.velocity.tools.generic.DateTool
DAY_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
debug(String) - Method in class org.apache.velocity.tools.generic.LogTool
decode(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Delegates decoding of the specified url content to URLDecoder.decode(java.lang.String) using the configured character encoding.
decodeQueryPercents(String) - Method in class org.apache.velocity.tools.generic.LinkTool: This is an ugly (but fast) hack that's needed because URI encodes things that we don't need encoded while not encoding things that we do need encoded.
DEFAULT_ALTERNATE_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
DEFAULT_BUNDLE_NAME - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The default path of the relative format resource bundles.
DEFAULT_CHARSET - Static variable in class org.apache.velocity.tools.generic.LinkTool
DEFAULT_DATE_FORMAT - Static variable in class org.apache.velocity.tools.generic.ConversionTool: Deprecated.
DEFAULT_DELIMITER - Static variable in class org.apache.velocity.tools.generic.MarkupTool
DEFAULT_FORMAT - Static variable in class org.apache.velocity.tools.generic.FormatConfig: The default format to be used when none is specified.
DEFAULT_KEY - Static variable in class org.apache.velocity.tools.generic.EscapeTool
DEFAULT_LOCALE - Static variable in class org.apache.velocity.tools.generic.LocaleConfig: The default Locale to be used when none is specified.
DEFAULT_NUMBER_FORMAT - Static variable in class org.apache.velocity.tools.generic.ConversionTool: Deprecated.
DEFAULT_PARSE_DEPTH - Static variable in class org.apache.velocity.tools.generic.RenderTool: The maximum number of loops allowed when recursing.
DEFAULT_SCHEME - Static variable in class org.apache.velocity.tools.generic.LinkTool
DEFAULT_SCOPE - Static variable in class org.apache.velocity.tools.ToolboxFactory
DEFAULT_STRINGS_DELIMITER - Static variable in class org.apache.velocity.tools.generic.CollectionTool
DEFAULT_STRINGS_DELIMITER - Static variable in class org.apache.velocity.tools.generic.ConversionTool: Deprecated.
DEFAULT_STRINGS_DELIMITER - Static variable in class org.apache.velocity.tools.generic.ValueParser
DEFAULT_STRINGS_TRIM - Static variable in class org.apache.velocity.tools.generic.CollectionTool
DEFAULT_STRINGS_TRIM - Static variable in class org.apache.velocity.tools.generic.ConversionTool: Deprecated.
DEFAULT_TAB - Static variable in class org.apache.velocity.tools.generic.MarkupTool
DEFAULT_TYPE - Static variable in class org.apache.velocity.tools.config.Data
DefaultKey - Annotation Type in org.apache.velocity.tools.config: Annotation specifying the default key to use for a tool class in the case none was specified.
depth(int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison: Set the maximum number of units to render for this comparison.
DEPTH_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The key used for specifying a different default depth via toolbox params.
DIFF_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
difference(Object, Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool: Returns a ComparisonDateTool.Comparison between the result of the second specified date and the first specified date.
directory() - Method in class org.apache.velocity.tools.generic.LinkTool: Returns a new LinkTool instance with the path set to the result of LinkTool.getDirectory() and the query and fragment set to null.
DisplayTool - Class in org.apache.velocity.tools.generic: Provides general utility methods for controlling the display of references.
DisplayTool() - Constructor for class org.apache.velocity.tools.generic.DisplayTool
DisplayTool.Measurements - Class in org.apache.velocity.tools.generic: Measures the dimensions of the string given to its constructor.
div(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
div(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
dumpString(String, boolean) - Method in class org.apache.velocity.tools.generic.EscapeTool: This code was pulled from the Apache Harmony project.
duplicate() - Method in class org.apache.velocity.tools.generic.LinkTool: Equivalent to clone, but with no checked exceptions.
duplicate(boolean) - Method in class org.apache.velocity.tools.generic.LinkTool: Equivalent to clone, but with no checked exceptions.

E

EasyData(Data, Configuration) - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
EasyFactoryConfiguration - Class in org.apache.velocity.tools.config: FactoryConfiguration subclass that simplifies the process of configuring a ToolboxFactory in Java without the use of an xml or properties configuration file.
EasyFactoryConfiguration() - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration
EasyFactoryConfiguration(boolean) - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration
EasyFactoryConfiguration(boolean, String) - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration
EasyFactoryConfiguration.EasyData - Class in org.apache.velocity.tools.config
EasyFactoryConfiguration.EasyWrap<C extends Configuration> - Class in org.apache.velocity.tools.config
EasyWrap(C, Configuration) - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
encode(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Delegates encoding of the specified url content to URLEncoder.encode(java.lang.String) using the configured character encoding.
ENGINE_KEY - Static variable in class org.apache.velocity.tools.ToolContext
entrySet() - Method in class org.apache.velocity.tools.generic.ValueParser
EQUAL_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
equals(Object) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
equals(Object) - Method in class org.apache.velocity.tools.config.Configuration
equals(Object) - Method in class org.apache.velocity.tools.config.Data
equals(Object) - Method in class org.apache.velocity.tools.config.FactoryConfiguration: This will consider the object equal if it is a FactoryConfiguration and whose FactoryConfiguration.toString(boolean) method, when passed false, returns a String equal to that returned by a call to toString(false) on this instance.
equals(Object) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
equals(Object) - Method in class org.apache.velocity.tools.config.ToolConfiguration
equals(Object) - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
equals(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: This instance is considered equal to any LinkTool instance whose toString() method returns a String equal to that returned by this instance's toString()
Equals(Object) - Constructor for class org.apache.velocity.tools.generic.LoopTool.Equals
error(String) - Method in class org.apache.velocity.tools.generic.LogTool
EscapeTool - Class in org.apache.velocity.tools.generic: Tool for working with escaping in Velocity templates.
EscapeTool() - Constructor for class org.apache.velocity.tools.generic.EscapeTool
eval(String) - Method in class org.apache.velocity.tools.generic.RenderTool: Evaluates a String containing VTL using the context passed to the RenderTool.setVelocityContext(org.apache.velocity.context.Context) method.
eval(Context, String) - Method in class org.apache.velocity.tools.generic.RenderTool: Evaluates a String containing VTL using the current context, and returns the result as a String.
EXACT_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
exclude(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator: Directs this instance to completely exclude any elements equal to the specified Object.
EXCLUDE - org.apache.velocity.tools.generic.LoopTool.Action
exists(String) - Method in class org.apache.velocity.tools.generic.ValueParser: Convenience method for checking whether a certain parameter exists.
exists(String) - Static method in class org.apache.velocity.tools.Scope

F

factory - Variable in class org.apache.velocity.tools.ToolManager
FactoryConfiguration - Class in org.apache.velocity.tools.config: This class serves to define configuration info for a ToolboxFactory.
FactoryConfiguration() - Constructor for class org.apache.velocity.tools.config.FactoryConfiguration
FactoryConfiguration(Class, String) - Constructor for class org.apache.velocity.tools.config.FactoryConfiguration: Allows subclasses to construct an instance that uses their classname.
FactoryConfiguration(String) - Constructor for class org.apache.velocity.tools.config.FactoryConfiguration: Creates a new instance with the specified source name combined with this class's name as the initial source.
fetch(String) - Method in class org.apache.velocity.tools.generic.ImportTool: Returns the supplied URL rendered as a String.
fetch(String) - Method in class org.apache.velocity.tools.generic.JsonTool: Reads and parses a remote or local URL
fetch(String) - Method in class org.apache.velocity.tools.generic.XmlTool: Reads and parses a remote or local URL
field - Variable in class org.apache.velocity.tools.generic.ClassTool.FieldSub
FIELD - org.apache.velocity.tools.config.Data.Type
FIELD_MAXIMA - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
FieldConverter() - Constructor for class org.apache.velocity.tools.config.Data.FieldConverter
fields - Variable in class org.apache.velocity.tools.generic.ClassTool
FieldSub(Field) - Constructor for class org.apache.velocity.tools.generic.ClassTool.FieldSub: FieldSub constructor
FieldTool - Class in org.apache.velocity.tools.generic: This is a simple tools class to allow easy access to static fields in a class, such as string constants from within a template.
FieldTool() - Constructor for class org.apache.velocity.tools.generic.FieldTool
FieldTool.FieldToolSub - Class in org.apache.velocity.tools.generic: Holds a Map of results for a particular class.
FieldTool.MutableField - Class in org.apache.velocity.tools.generic: Holds a Field and Class reference for later retrieval of the value of a field that is not final and may change at different lookups.
FieldToolSub(Map<String, Object>) - Constructor for class org.apache.velocity.tools.generic.FieldTool.FieldToolSub
FileFactoryConfiguration - Class in org.apache.velocity.tools.config: Provides support for reading a configuration file from a specified path.
FileFactoryConfiguration(Class, String) - Constructor for class org.apache.velocity.tools.config.FileFactoryConfiguration
fillKeyset(Set) - Method in class org.apache.velocity.tools.generic.ContextTool: Actually do the work of filling in the set of keys for ContextTool.getKeys() here so subclasses can add keys too.
find(Object) - Method in class org.apache.velocity.tools.generic.XmlTool: Converts the specified object to a String and calls XmlTool.find(String) with that.
find(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils: Searches for a configuration file at the specified path and returns it in the form of a FactoryConfiguration.
find(String) - Method in class org.apache.velocity.tools.generic.XmlTool: Performs an XPath selection on the current set of Nodes held by this instance and returns a new XmlTool instance that wraps those results.
findConfig(String) - Method in class org.apache.velocity.tools.ToolManager: Find a configuration file
findDeclaredMethod(Class, String, Class...) - Static method in class org.apache.velocity.tools.ClassUtils: Find a declared method in a class.
findFactoryMethod(Class, Class) - Static method in class org.apache.velocity.tools.ClassUtils: Given a factory class and a target class, search for the following methods:
findFromSystemProperty() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils: Returns a FactoryConfiguration loaded from the path specified in the "org.apache.velocity.tools" system property (if any).
findGetter(String, Class) - Static method in class org.apache.velocity.tools.ClassUtils
findGetter(String, Class, boolean) - Static method in class org.apache.velocity.tools.ClassUtils
findInClasspath(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
findInClasspath(String, Object) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils: Searches the classpath for a configuration file matching the specified path.
findInFileSystem(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils: Searches the file system for a configuration file matching the specified path.
findIterator(String) - Method in class org.apache.velocity.tools.generic.LoopTool: Finds the LoopTool.ManagedIterator with the specified name if it is in this instance's iterator stack.
findMethod(Class, String, Class...) - Static method in class org.apache.velocity.tools.ClassUtils: Find a callable method in a class
findSetter(String, Class) - Static method in class org.apache.velocity.tools.ClassUtils
findSetter(String, Class, Predicate<Class>) - Static method in class org.apache.velocity.tools.ClassUtils
findSetter(String, Class, Predicate<Class>, boolean) - Static method in class org.apache.velocity.tools.ClassUtils
findTool(String) - Method in class org.apache.velocity.tools.ToolContext
findURL(String) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
floor(Object) - Method in class org.apache.velocity.tools.generic.MathTool
FORCE_RELATIVE_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
forceRelative - Variable in class org.apache.velocity.tools.generic.LinkTool
format(Object) - Method in class org.apache.velocity.tools.generic.DateTool: Converts the specified object to a date and formats it according to the pattern or style returned by FormatConfig.getFormat().
format(Object) - Method in class org.apache.velocity.tools.generic.NumberTool: Converts the specified object to a number and formats it according to the pattern or style returned by FormatConfig.getFormat().
format(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool: Converts the specified object to a date and returns a formatted string representing that date in the locale returned by LocaleConfig.getLocale().
format(String, Object) - Method in class org.apache.velocity.tools.generic.NumberTool: Converts the specified object to a number and returns a formatted string representing that number in the locale returned by LocaleConfig.getLocale().
format(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool: Converts the specified object to a date and returns a formatted string representing that date in the specified Locale.
format(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool: Converts the specified object to a number and returns a formatted string representing that number in the specified Locale.
format(String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool: Returns a formatted string representing the specified date, Locale, and TimeZone.
format(String, String, Object) - Method in class org.apache.velocity.tools.generic.DateTool: Returns the specified date as a string formatted according to the specified date and/or time styles.
format(String, String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool: Returns the specified date as a string formatted according to the specified Locale and date and/or time styles.
format(String, String, Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool: Returns the specified date as a string formatted according to the specified Locale and date and/or time styles.
format(Collection, String, String, String) - Method in class org.apache.velocity.tools.generic.DisplayTool: Does the actual formatting of the collection.
FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.FormatConfig: The key used for specifying a default format via tool configuration.
FormatConfig - Class in org.apache.velocity.tools.generic: Implements common logic and constants for tools which allow their default format to be configured.
FormatConfig() - Constructor for class org.apache.velocity.tools.generic.FormatConfig
fragment - Variable in class org.apache.velocity.tools.generic.LinkTool
FRAGMENT_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool

G

GENERIC_DEFAULTS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
get() - Method in class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
get(int) - Method in class org.apache.velocity.tools.generic.JsonContent: Get a value from root array
get(int) - Method in class org.apache.velocity.tools.generic.JsonTool: Get nth element from root json array.
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(Object) - Method in class org.apache.velocity.tools.generic.ContextTool: Retrieves the value for the specified reference name (aka context key).
get(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool: Accepts objects and uses their string value as the key.
get(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
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(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, 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(String) - Static method in enum org.apache.velocity.tools.config.Data.Type
get(String) - Method in class org.apache.velocity.tools.generic.DateTool: Returns a formatted string representing the date returned by DateTool.getDate().
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(String) - Method in class org.apache.velocity.tools.generic.JsonContent: Get a property from root object
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) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
get(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
get(String) - 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.Key
get(String) - Method in class org.apache.velocity.tools.generic.ValueParser: Convenience method for use in Velocity templates.
get(String) - Method in class org.apache.velocity.tools.Toolbox
get(String) - Method in class org.apache.velocity.tools.ToolContext
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, 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, String) - Method in class org.apache.velocity.tools.Toolbox
get(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
get(String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
getAbbr() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison: This is equivalent to calling ComparisonDateTool.Comparison.abbr(boolean abbr) with true as the argument, thus setting this comparison to be rendered in abbreviated form.
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 Annotations of the Class being inspected.
getAnnotations() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub: Returns the Annotations of the element being inspected.
getAppendParams() - Method in class org.apache.velocity.tools.generic.LinkTool: Returns true if LinkTool.param(Object,Object) appends values; false if the method overwrites existing value(s) for the specified key.
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) - Static method in class org.apache.velocity.tools.XmlUtils
getAttribute(Node, String, String) - Static method in class org.apache.velocity.tools.XmlUtils: Extracts an attribute from a node.
getAutoAlternateDefault() - Method in class org.apache.velocity.tools.generic.AlternatorTool: Deprecated.

Returns true if the default for auto-alternating is true.
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
getAverage(Object...) - Method in class org.apache.velocity.tools.generic.MathTool: Get the average of the values
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(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool: Get the average of the values from a list
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) - Static method in class org.apache.velocity.tools.XmlUtils
getBoolAttribute(Node, String, boolean) - Static method in class org.apache.velocity.tools.XmlUtils: Retrieves an attribute as a boolean.
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: Returns the configured charset used by the LinkTool.encode(java.lang.Object) and LinkTool.decode(java.lang.Object) methods.
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: Returns a List of ClassTool.ConstructorSubs for each constructor declared constructor in the inspected class.
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: At this level, this only returns the result of LinkTool.getDirectory().
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() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
getCount(String) - Method in class org.apache.velocity.tools.generic.LoopTool: Returns the number of items the specified loop has handled.
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() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
getData() - Method in class org.apache.velocity.tools.ToolboxFactory
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
getDate() - Method in class org.apache.velocity.tools.generic.DateTool: Returns a Date derived from the result of DateTool.getCalendar()
getDateFormat() - Method in class org.apache.velocity.tools.generic.ConversionTool: Deprecated.
use DateTool getDateFormat() methods
getDateFormat(int, int, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils: Returns a DateFormat instance for the specified time style, date style, Locale, and TimeZone.
getDateFormat(String, String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils: Returns a DateFormat instance for the specified date style, time style, Locale, and TimeZone.
getDateFormat(String, String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool: Returns a DateFormat instance for the specified date style, time style, Locale, and TimeZone.
getDateFormat(String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils: Returns a DateFormat instance for the specified format, Locale, and TimeZone.
getDateFormat(String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool: Returns a DateFormat instance for the specified format, Locale, and TimeZone.
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: Returns the "default" FactoryConfiguration.
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: Sets this comparison to be rendered as a ComparisonDateTool.difference(java.lang.Object, java.lang.Object).
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: Sets this comparison to be rendered as if it where generated using the ComparisonDateTool.timespan(Object now, Object then) method.
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: Returns a List of ClassTool.FieldSubs for each field declared field in the inspected class.
getFieldValue(Class, String) - Static method in class org.apache.velocity.tools.ClassUtils: Given a class and a static field name, get the field value.
getFieldValue(String) - Static method in class org.apache.velocity.tools.ClassUtils: Given a static field path, aka classname.field, 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(Class) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
getFromClass(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils: Get a specific FactoryConfiguration class
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: Sets the ComparisonDateTool.Comparison.depth(int depth) to which this comparison is rendered to the maximum number of time units available to the tool.
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: Returns a FactoryConfiguration including all default "GenericTools" available and no others.
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() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
getIndex(String) - Method in class org.apache.velocity.tools.generic.LoopTool: Returns the 0-based index of the item the specified loop is handling.
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
getInstance(String) - Static method in class org.apache.velocity.tools.ClassUtils: Get an instance of a named class.
getInt(String, int) - Method in class org.apache.velocity.tools.generic.ValueParser
getIntAttribute(Node, String) - Static method in class org.apache.velocity.tools.XmlUtils
getIntAttribute(Node, String, int) - 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: Wraps access to ClassUtils.getIterator(java.lang.Object) is a nice little try/catch block to prevent exceptions from escaping into the template.
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() - 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
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(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.
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() - Method in class org.apache.velocity.tools.generic.SafeConfig: Get logger
getLog() - Method in class org.apache.velocity.tools.ToolManager: Get logger
getLog(VelocityEngine, String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
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: Returns a List of ClassTool.MethodSubs for each method declared method in the inspected class.
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: Asks XmlTool.get(Object) for a "name" result.
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.
getNodePath() - Method in class org.apache.velocity.tools.generic.XmlTool: Returns the XPath that identifies the first/sole Node represented by this instance.
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() - Method in class org.apache.velocity.tools.generic.ConversionTool: Deprecated.
use NumberTool format
getNumberFormat(int, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils: Returns a NumberFormat instance for the specified number style and Locale.
getNumberFormat(String, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils: Returns a NumberFormat instance for the specified format and Locale.
getNumberFormat(String, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool: Returns a NumberFormat instance for the specified format and Locale.
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: Deprecated.
use getNodePath()
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(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool: Safely retrieves the specified property from the specified object.
getProperty(String) - Method in class org.apache.velocity.tools.config.Configuration
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: Sets this comparison to be rendered as if it where generated using the ComparisonDateTool.whenIs(Object now, Object then) method.
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() - Method in class org.apache.velocity.tools.generic.ValueParser
getSource(boolean) - 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: Deprecated.
use CollectionTool.getStringsTrim()
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() - Method in class org.apache.velocity.tools.generic.XmlTool: Returns the concatenated text content of all the internally held nodes.
getText(String, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool: Retrieves the specified text resource.
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: Returns the most recent LoopTool.ManagedIterator for this instance.
getTimeZone() - Method in class org.apache.velocity.tools.generic.DateTool: Returns the configured TimeZone.
getTool(String) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
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.
getToolbox(String) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
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: Returns the underlying ToolboxFactory being used.
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 Classes.
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(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
getTotal(Object...) - Method in class org.apache.velocity.tools.generic.MathTool: Get the sum of the values
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(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool: Get the sum of the values from a list
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 Classes 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: Returns the URI.getUserInfo() value for this instance.
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() - Method in class org.apache.velocity.tools.generic.FieldTool.MutableField
getValue(int, Object) - Method in class org.apache.velocity.tools.generic.DateTool
getValue(Object) - Method in class org.apache.velocity.tools.generic.DateTool
getValue(Object, Object) - Method in class org.apache.velocity.tools.generic.DateTool
getValue(String) - Method in class org.apache.velocity.tools.generic.ValueParser: Returns the value mapped to the specified key in the Map returned by ValueParser.getSource().
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.

H

handleParamsBoolean(boolean) - Method in class org.apache.velocity.tools.generic.LinkTool: In this class, this method ignores true values.
hasApplicationTools() - Method in class org.apache.velocity.tools.ToolManager: Check whether this tool manager has application scoped tools
hasChildren() - Method in class org.apache.velocity.tools.config.CompoundConfiguration
hasConfigure() - Method in class org.apache.velocity.tools.ToolInfo: Get whether this tool has a configure() method
hasData() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
hasFloatingPoint(String) - Method in class org.apache.velocity.tools.generic.MathTool
hashCode() - Method in class org.apache.velocity.tools.config.CompoundConfiguration
hashCode() - Method in class org.apache.velocity.tools.config.Configuration
hashCode() - Method in class org.apache.velocity.tools.config.Data
hashCode() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
hashCode() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
hashCode() - Method in class org.apache.velocity.tools.config.ToolConfiguration
hashCode() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
hashCode() - Method in class org.apache.velocity.tools.generic.LinkTool: Returns the hash code for the result of toString().
hasNext() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
hasNext() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator
hasPermission(String) - Method in class org.apache.velocity.tools.ToolInfo
hasPermission(ToolInfo, String) - Method in class org.apache.velocity.tools.Toolbox
hasProperties() - Method in class org.apache.velocity.tools.config.Configuration
hasRequestTools() - Method in class org.apache.velocity.tools.ToolManager: Check whether this tool manager has request scoped tools
hasSubkeys() - Method in class org.apache.velocity.tools.generic.ValueParser: Determines whether there are subkeys available in the source map.
hasTools(String) - Method in class org.apache.velocity.tools.ToolboxFactory
hasTools(String) - Method in class org.apache.velocity.tools.ToolManager: Check for the presence of tools in a given scope
host - Variable in class org.apache.velocity.tools.generic.LinkTool
host(Object) - Method in class org.apache.velocity.tools.generic.LinkTool: Returns a new instance with the specified value set as its host.
HOST_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
HOUR_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
html(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool: Escapes the characters in a String using HTML entities.
HTML_QUERY_DELIMITER - Static variable in class org.apache.velocity.tools.generic.LinkTool: Standard HTML delimiter for query data ('&')

I

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 - 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 - 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.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(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.
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(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).
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(Reader) - Method in class org.apache.velocity.tools.generic.JsonTool: Initialize JSON content from a reader.
initJSON(String) - Method in class org.apache.velocity.tools.generic.JsonTool: Initialize JSON content from a string.
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(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool
insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool
insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
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(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(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_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: Returns true if the SafeConfig.configure(Map) method has been locked.
isCustom() - Method in enum org.apache.velocity.tools.config.Data.Type
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
isDeprecated(AnnotatedElement) - Static method in class org.apache.velocity.tools.generic.ClassTool: Check if an annotation deprecates its class
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 Nodes 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() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
isFirst(String) - Method in class org.apache.velocity.tools.generic.LoopTool
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() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
isLast(String) - Method in class org.apache.velocity.tools.generic.LoopTool
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.

J

java(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool: Escapes the characters in a String using Java String rules.
javadocRef - Variable in class org.apache.velocity.tools.generic.ClassTool.CallableSub
javascript(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool: Escapes the characters in a String using JavaScript String rules.
JsonContent - Class in org.apache.velocity.tools.generic: Container for *either* an array *or* an object
JsonContent(JsonArray) - Constructor for class org.apache.velocity.tools.generic.JsonContent: wraps an array
JsonContent(JsonObject) - Constructor for class org.apache.velocity.tools.generic.JsonContent: wraps an object
JsonTool - Class in org.apache.velocity.tools.generic: Tool which can parse a JSON file.
JsonTool() - Constructor for class org.apache.velocity.tools.generic.JsonTool

K

Key(String, String[], Object, Object[]) - Constructor for class org.apache.velocity.tools.generic.ResourceTool.Key
KEY - Static variable in class org.apache.velocity.tools.Toolbox: The key used to place instances in various scopes.
KEY_CATCH_EXCEPTIONS - Static variable in class org.apache.velocity.tools.generic.RenderTool: Deprecated.
KEY_FORCE_THREAD_SAFE - Static variable in class org.apache.velocity.tools.generic.RenderTool
KEY_PARSE_DEPTH - Static variable in class org.apache.velocity.tools.generic.RenderTool: Deprecated.
keys() - Method in class org.apache.velocity.tools.generic.JsonContent: Iterate keys of root object.
keys() - Method in class org.apache.velocity.tools.generic.JsonTool: Iterate keys of root object.
keySet() - Method in class org.apache.velocity.tools.generic.JsonContent: Get set of root object keys.
keySet() - Method in class org.apache.velocity.tools.generic.JsonTool: Get set of root object keys.
keySet() - Method in class org.apache.velocity.tools.generic.ValueParser
keySet() - Method in class org.apache.velocity.tools.ToolContext

L

LinkTool - Class in org.apache.velocity.tools.generic: The LinkTool provides many methods to work with URIs and can help you:
LinkTool() - Constructor for class org.apache.velocity.tools.generic.LinkTool: Default constructor.
list(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool: Formats a collection or array into the form "A, B and C".
list(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool: Formats a collection or array into the form "A<delim>B<delim>C".
list(Object, String, String) - Method in class org.apache.velocity.tools.generic.DisplayTool: Formats a collection or array into the form "A<delim>B<finaldelim>C".
list(Object, String, String, String) - Method in class org.apache.velocity.tools.generic.DisplayTool: Formats a specified property of collection or array of objects into the form "A<delim>B<finaldelim>C".
LIST - org.apache.velocity.tools.config.Data.Type
LIST_AUTO - org.apache.velocity.tools.config.Data.Type
LIST_BOOLEAN - org.apache.velocity.tools.config.Data.Type
LIST_DELIM_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
LIST_FIELD - org.apache.velocity.tools.config.Data.Type
LIST_FINAL_DELIM_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
LIST_NUMBER - org.apache.velocity.tools.config.Data.Type
LIST_STRING - org.apache.velocity.tools.config.Data.Type
load(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils: Returns a FactoryConfiguration loaded from a configuration file at the specified path.
locale(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
locale(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
locale(Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison: Sets the locale used to look up the textual portions of the rendering.
LOCALE_KEY - Static variable in class org.apache.velocity.tools.ToolContext
LocaleConfig - Class in org.apache.velocity.tools.generic: Implements common logic and constants for tools which allow their default Locale to be configured.
LocaleConfig() - Constructor for class org.apache.velocity.tools.generic.LocaleConfig
LOCK_CONFIG_KEY - Static variable in class org.apache.velocity.tools.generic.SafeConfig: The key used for specifying whether or not to prevent templates from reconfiguring this tool.
log - Variable in class org.apache.velocity.tools.generic.SafeConfig
log - Variable in class org.apache.velocity.tools.ToolManager
LOG_KEY - Static variable in class org.apache.velocity.tools.ToolContext
LOGGER_NAME_KEY - Static variable in class org.apache.velocity.tools.generic.SafeConfig: Key used to explicitely specify the logger name
LogTool - Class in org.apache.velocity.tools.generic: This tool is used to log from within templates.
LogTool() - Constructor for class org.apache.velocity.tools.generic.LogTool
LoopTool - Class in org.apache.velocity.tools.generic: A convenience tool to use with #foreach loops.
LoopTool() - Constructor for class org.apache.velocity.tools.generic.LoopTool
LoopTool.Action - Enum in org.apache.velocity.tools.generic: Represents an automatic action taken by a LoopTool.ManagedIterator when a LoopTool.Condition is satisfied by the subsequent element.
LoopTool.ActionCondition - Class in org.apache.velocity.tools.generic: Composition class which associates an LoopTool.Action and LoopTool.Condition for a LoopTool.ManagedIterator.
LoopTool.Comparison - Class in org.apache.velocity.tools.generic: Base condition class for conditions (assumption here is that conditions are all comparative.
LoopTool.Condition - Interface in org.apache.velocity.tools.generic: Represents a function into which a LoopTool.ManagedIterator can pass it's next element to see if an LoopTool.Action should be taken.
LoopTool.Equals - Class in org.apache.velocity.tools.generic: Simple condition that checks elements in the iterator for equality to a specified Object.
LoopTool.ManagedIterator - Class in org.apache.velocity.tools.generic: Iterator implementation that wraps a standard Iterator and allows it to be prematurely stopped, skipped ahead, and associated with a name for advanced nested loop control.
LoopTool.SyncedIterator - Class in org.apache.velocity.tools.generic: Simple wrapper to make it easy to keep an arbitray Iterator in sync with a LoopTool.ManagedIterator.

M

make(boolean, Object...) - Method in class org.apache.velocity.tools.generic.AlternatorTool: Deprecated.

Returns a new Alternator for the specified list with the specified automatic shifting preference.
make(Object...) - Method in class org.apache.velocity.tools.generic.AlternatorTool: Deprecated.

Make an automatic Alternator from the specifed objects.
manage(Iterator, String) - Method in class org.apache.velocity.tools.generic.LoopTool
ManagedIterator(String, Iterator, LoopTool) - Constructor for class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
manual(Object...) - Method in class org.apache.velocity.tools.generic.AlternatorTool: Deprecated.

Make a manual Alternator from the specified objects.
mark(int) - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
markSupported() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
MarkupTool - Class in org.apache.velocity.tools.generic: NOTE: This tools is considered "alpha" quality due to lack of testing and a generally unpolished API.
MarkupTool() - Constructor for class org.apache.velocity.tools.generic.MarkupTool
MarkupTool.Tag - Class in org.apache.velocity.tools.generic
matches(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ActionCondition: Returns true if the specified value meets the set LoopTool.Condition
matches(MarkupTool.Tag) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
matchType(double, Number...) - Method in class org.apache.velocity.tools.generic.MathTool: Takes the original argument(s) and returns the resulting value as an instance of the best matching type (Integer, Long, or Double).
matchType(Number, double) - Method in class org.apache.velocity.tools.generic.MathTool
matchType(Number, Number, double) - Method in class org.apache.velocity.tools.generic.MathTool
MathTool - Class in org.apache.velocity.tools.generic: Tool for performing math in Velocity.
MathTool() - Constructor for class org.apache.velocity.tools.generic.MathTool
max(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
max(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
measure(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool: Returns the DisplayTool.Measurements of the string value of the specified object.
Measurements(String) - Constructor for class org.apache.velocity.tools.generic.DisplayTool.Measurements
message(String, Object...) - Method in class org.apache.velocity.tools.generic.DisplayTool: Uses MessageFormat to format the specified String with the specified arguments.
method - Variable in class org.apache.velocity.tools.generic.ClassTool.MethodSub
methods - Variable in class org.apache.velocity.tools.generic.ClassTool
MethodSub(Method) - Constructor for class org.apache.velocity.tools.generic.ClassTool.MethodSub: Method inspector constructor
MILLIS_PER_DAY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The number of milliseconds in a day.
MILLIS_PER_HOUR - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The number of milliseconds in an hour.
MILLIS_PER_MINUTE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The number of millseconds in a minute.
MILLIS_PER_MONTH - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: An approximation of the number of milliseconds in a month.
MILLIS_PER_SECOND - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The number of milliseconds in a second.
MILLIS_PER_WEEK - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: The number of milliseconds in a week.
MILLIS_PER_YEAR - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool: An approximation of the number of milliseconds in a year.
MILLISECOND_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
min(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
min(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
MINUTE_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
missed(Object, Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
missed(List<Object>, List<Object>) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
mod(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool: Does integer modulus on the int values of the specified numbers.
MONTH_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
mul(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
mul(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
MutableField(Field, Class) - Constructor for class org.apache.velocity.tools.generic.FieldTool.MutableField

N

name(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

newInstance() - Method in class org.apache.velocity.tools.ToolInfo

Creates a new instance for this tool.

next() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator

next() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator

node() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns the first/sole Node from this instance's internal Node list, if any.

NodeIterator(Iterator<Node>) - Constructor for class org.apache.velocity.tools.generic.XmlTool.NodeIterator

nodePath(Node) - Static method in class org.apache.velocity.tools.XmlUtils

Builds the xpath expression for a node (tries to use id/name nodes when possible to get a unique path)

nodeToString(Node) - Static method in class org.apache.velocity.tools.XmlUtils

XML Node to string

normalizeQuery(String) - Method in class org.apache.velocity.tools.generic.LinkTool

NullKeyException - Exception in org.apache.velocity.tools.config

NullKeyException(Data) - Constructor for exception org.apache.velocity.tools.config.NullKeyException

NullKeyException(ToolConfiguration) - Constructor for exception org.apache.velocity.tools.config.NullKeyException

number(Object) - Method in class org.apache.velocity.tools.generic.NumberTool

Convenience method equivalent to $number.format("number", $foo).

number(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration

NUMBER - org.apache.velocity.tools.config.Data.Type

NUMBER_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.

NumberConverter() - Constructor for class org.apache.velocity.tools.config.Data.NumberConverter

NumberTool - Class in org.apache.velocity.tools.generic

Tool for working with Number in Velocity templates.

NumberTool() - Constructor for class org.apache.velocity.tools.generic.NumberTool

O

ONE_DAY_SUFFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool

opaque - Variable in class org.apache.velocity.tools.generic.LinkTool

org.apache.velocity.tools - package org.apache.velocity.tools

org.apache.velocity.tools.config - package org.apache.velocity.tools.config

org.apache.velocity.tools.generic - package org.apache.velocity.tools.generic

Contains a collection of reusable, general-purpose "tools" for Velocity.

orphan() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

P

param(Object, Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Adds a key=value pair to the query data.

params(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

This method can do two different things.

parent() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

parent(MarkupTool.Tag) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

parents() - Method in class org.apache.velocity.tools.generic.XmlTool

Returns a new XmlTool instance that wraps the parent Elements of each of the Nodes being wrapped by this instance.

parse(Reader) - Static method in class org.apache.velocity.tools.XmlUtils

Attempts to parse the input xml into a single element.

parse(String) - Method in class org.apache.velocity.tools.generic.JsonTool

Parses the given JSON string and uses the resulting Document as the root Node.

parse(String) - Method in class org.apache.velocity.tools.generic.MarkupTool

parse(String) - Method in class org.apache.velocity.tools.generic.XmlTool

Parses the given XML string and uses the resulting Document as the root Node.

parse(String) - Static method in class org.apache.velocity.tools.XmlUtils

Attempts to parse the input xml into a single element.

parseBoolean(String) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.

Converts a parameter value into a Boolean Sub-classes can override to allow for customized boolean parsing.

parseDate(String) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toDate(Object)

parseDate(String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toDate(String, Object, Locale)}

parseDate(String, String) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toDate(String, Object)

parseDate(String, String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toDate(String, Object, Locale)}

parseDate(String, String, Object, TimeZone) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toDate(String, Object, Locale, TimeZone)}

parseLocale(String) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.

Converts a String value into a Locale.

parseNumber(String) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use NumberTool.toNumber(Object)

parseNumber(String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use NumberTool.toNumber(String, Object, Locale)

parseNumber(String, String) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use NumberTool.toNumber(String, Object)

parseNumber(String, String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use NumberTool.toNumber(String, Object, Locale)

parseQuery(String) - Method in class org.apache.velocity.tools.generic.LinkTool

Uses LinkTool.normalizeQuery(java.lang.String) to make all delimiters in the specified query string match the current query delimiter and then uses LinkTool.parseQuery(String,String) to parse it according to that same delimiter.

parseQuery(String, String) - Method in class org.apache.velocity.tools.generic.LinkTool

This will use the specified query delimiter to parse the specified query string into a map of keys to values.

parseStringList(String) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.

Converts a single String value into an array of Strings by splitting it on the tool's set stringsDelimiter.

parseStringList(String) - Method in class org.apache.velocity.tools.generic.ValueParser

path - Variable in class org.apache.velocity.tools.generic.LinkTool

path(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a new instance with the specified value set as its path.

PATH_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool

PATH_KEY - Static variable in class org.apache.velocity.tools.ToolContext

percent(Object) - Method in class org.apache.velocity.tools.generic.NumberTool

Convenience method equivalent to $number.format("percent", $foo).

plural(int, String) - Method in class org.apache.velocity.tools.generic.DisplayTool

Builds plural form of a passed word if 'value' is plural, otherwise returns 'singular'.

plural(int, String, String) - Method in class org.apache.velocity.tools.generic.DisplayTool

Returns 'plural' parameter if passed 'value' is plural, otherwise 'singular' is returned.

PLURAL_SUFFIX - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool

pop() - Method in class org.apache.velocity.tools.generic.LoopTool

Don't let templates call this, but allow subclasses and ManagedIterator to have access.

port - Variable in class org.apache.velocity.tools.generic.LinkTool

port(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a new instance with the specified value set as its port number.

PORT_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool

pow(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool

prepareContext(ToolContext) - Method in class org.apache.velocity.tools.ToolManager

Prepare context

prepend(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

printf(String, Object...) - Method in class org.apache.velocity.tools.generic.DisplayTool

Uses String.format(Locale,String,Object...) to format the specified String with the specified arguments.

PropertiesComparator(List) - Constructor for class org.apache.velocity.tools.generic.CollectionTool.PropertiesComparator

PropertiesFactoryConfiguration - Class in org.apache.velocity.tools.config

This reads in configuration info formatted as a property file using ExtProperties.

PropertiesFactoryConfiguration() - Constructor for class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

PropertiesFactoryConfiguration(String) - Constructor for class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

Creates an instance using the specified string as an identifier to distinguish this instance when debugging.

property(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap

property(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration

Property - Class in org.apache.velocity.tools.config

Simple extension of Data that treats "name" as an alias for "key".

Property() - Constructor for class org.apache.velocity.tools.config.Property

PropertyAttributeRule() - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet.PropertyAttributeRule

propertyClass - Variable in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet

propertyKey(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool

Escapes the characters in a String using java.util.Properties rules for escaping property keys.

propertyValue(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool

Escapes the characters in a String using java.util.Properties rules for escaping property values.

put(String, Object) - Method in class org.apache.velocity.tools.generic.ValueParser

put(String, Object) - Method in class org.apache.velocity.tools.ToolContext

putAll(Map) - Method in class org.apache.velocity.tools.ToolContext

putAll(Map<? extends String, ? extends Object>) - Method in class org.apache.velocity.tools.generic.ValueParser

putData(String, Object) - Method in class org.apache.velocity.tools.ToolboxFactory

putGlobalProperties(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolboxFactory

putProperties(String, Map<String, Object>) - Method in class org.apache.velocity.tools.ToolboxFactory

putProperty(String, Object) - Method in class org.apache.velocity.tools.ToolInfo

Puts a new property for this tool.

putToolProperties(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolContext

putToolProperty(String, Object) - Method in class org.apache.velocity.tools.ToolContext

putVelocityEngine(VelocityEngine) - Method in class org.apache.velocity.tools.ToolContext

Puts the specified VelocityEngine in the tool properties, as well as the Log for that engine.

Q

query - Variable in class org.apache.velocity.tools.generic.LinkTool

query(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Sets the specified value as the current query data, after normalizing the pair delimiters.

QUERY_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool

queryDelim - Variable in class org.apache.velocity.tools.generic.LinkTool

R

random(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool

This returns a random Number within the specified range.

read() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader

read(char[]) - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader

read(char[], int, int) - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader

read(String) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration

Reads a configuration file from the specified file path and sets up the configuration from that.

read(String) - Method in class org.apache.velocity.tools.generic.ImportTool

Returns the supplied resource rendered as a String.

read(String) - Method in class org.apache.velocity.tools.generic.JsonTool

Reads and parses a local JSON resource file

read(String) - Method in class org.apache.velocity.tools.generic.XmlTool

Reads and parses a local resource file

read(String, boolean) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration

read(String, boolean, Logger) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration

read(URL) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils

Returns a FactoryConfiguration read from a known configuration file type at the specified URL.

read(URL) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration

read(URL, boolean) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration

read(URL, boolean, Logger) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration

read(ExtProperties) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

readData(ExtProperties) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

readImpl(URL) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration

Reads an configuration from an URL.

readImpl(URL) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

Reads an properties file from an InputStream and uses it to configure this FactoryConfiguration.

readImpl(URL) - Method in class org.apache.velocity.tools.config.XmlFactoryConfiguration

Reads an XML document from an URL and uses it to configure this FactoryConfiguration.

READONLY_KEY - Static variable in class org.apache.velocity.tools.generic.ValueParser

The key used for specifying whether to be read-only

readProperties(ExtProperties, Configuration) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

readToolboxes(ExtProperties) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

readTools(ExtProperties, ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration

ready() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader

recurse(String) - Method in class org.apache.velocity.tools.generic.RenderTool

Recursively evaluates a String containing VTL using the current context, and returns the result as a String.

recurse(Context, String) - Method in class org.apache.velocity.tools.generic.RenderTool

Recursively evaluates a String containing VTL using the current context, and returns the result as a String.

relative() - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a copy of this LinkTool instance that has LinkTool.setForceRelative(boolean) set to true.

relative(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a copy of the link with the specified directory-relative URI reference set as the end of the path and LinkTool.setForceRelative(boolean) set to true.

RELATIVE_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool

remove() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator

This operation is unsupported.

remove() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator

remove(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a new LinkTool instance that has any value(s) under the specified key removed from the query data.

remove(Object) - Method in class org.apache.velocity.tools.generic.ValueParser

remove(String) - Method in class org.apache.velocity.tools.ToolContext

removeChild(C) - Method in class org.apache.velocity.tools.config.CompoundConfiguration

removeData(Data) - Method in class org.apache.velocity.tools.config.FactoryConfiguration

removeParam(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Removes the query pair(s) with the specified key from the query data and returns the remove value(s), if any.

removeProperty(String) - Method in class org.apache.velocity.tools.config.Configuration

removeProperty(Property) - Method in class org.apache.velocity.tools.config.Configuration

removeTool(ToolConfiguration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration

removeToolbox(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.FactoryConfiguration

render(Object, Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool

Renders the specified resource value and arguments as a String.

render(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

Render tag

render_attributes(StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

Render tag attributes

render_body(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

Render tag body

render_classes(StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

render tag classes

render_end(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

Render tag end

render_id(StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

render tag id

render_name(StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

Render tag name

render_start(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

Start tag rendering

RenderTool - Class in org.apache.velocity.tools.generic

This tool exposes methods to evaluate the given strings as VTL (Velocity Template Language) using either a pre-configured context or one you provide directly.

RenderTool() - Constructor for class org.apache.velocity.tools.generic.RenderTool

REQUEST - Static variable in class org.apache.velocity.tools.Scope

reset() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader

RESOURCE_KEY - Static variable in class org.apache.velocity.tools.generic.ImportSupport

Configuration key for XmlTool and JsonTool, used to specify a local resource

ResourceTool - Class in org.apache.velocity.tools.generic

Tool for accessing ResourceBundles and formatting messages therein.

ResourceTool() - Constructor for class org.apache.velocity.tools.generic.ResourceTool

ResourceTool.Key - Class in org.apache.velocity.tools.generic

Internal class used to enable an elegant syntax for accessing resources.

restrictTo(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap

restrictTo(String) - Method in class org.apache.velocity.tools.ToolInfo

retrieve(Field, Class) - Method in class org.apache.velocity.tools.generic.FieldTool

Retrieves and returns the value of the specified Field in the specified Class.

root() - Method in class org.apache.velocity.tools.generic.JsonTool

Get JSON root object.

root() - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a new LinkTool instance that represents the "root" of the current one, if it has one.

root() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

round(Object) - Method in class org.apache.velocity.tools.generic.MathTool

Rounds a number to the nearest whole Integer

roundTo(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool

Rounds a number to the specified number of decimal places.

S

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

Sets whether or not the LinkTool.setParam(java.lang.Object, java.lang.Object, boolean) method will override existing query values for the same key or simply append the new value to a list of existing values.

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

Deprecated.
use addChildren(collection)

setClass(Class) - Method in class org.apache.velocity.tools.config.ToolConfiguration

Deprecated.

setClass(Class) - Method in class org.apache.velocity.tools.ToolInfo

Set the tool class

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(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration

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

Deprecated.
use DateTool setDateFormat() methods

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

Deprecated.
use NumberTool format

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

If append is false, this simply delegates to LinkTool.setQuery(java.lang.Object).

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(Object, String, Object) - Method in class org.apache.velocity.tools.ToolInfo

Set a property on a tool instance

setProperty(String, Object) - Method in class org.apache.velocity.tools.config.Configuration

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

Set whether or not to skip setters.

setSkipSetters(Boolean) - Method in class org.apache.velocity.tools.config.ToolConfiguration

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

Deprecated.
use CollectionTool.setStringsDelimiter(String)

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

Deprecated.
use CollectionTool.setStringsTrim(boolean)

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(Class) - Method in class org.apache.velocity.tools.generic.ClassTool

Set the class to inspect

setType(String) - Method in class org.apache.velocity.tools.config.Data

setType(Data.Type) - Method in class org.apache.velocity.tools.config.Data

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

Sets the Context to be used by the RenderTool.eval(String) and RenderTool.recurse(String) methods.

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 Nodes internally held by this instance.

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.

skip(long) - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader

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(Object) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sort a collection, array or map

sort(Object[]) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sort an array

sort(Object[], List) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sorts array on several properties.

sort(Object, String) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sorts the collection on a single property.

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(Collection<T>, Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sorts a Collection using a Comparator.

sort(Collection, List) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sorts the collection on several properties.

sort(Map) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sort map values

sort(Map<?, T>, Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sorts a Map's values using a Comparator.

sort(Map, List) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sorts map values on several properties.

sort(T[], Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool

Sorts an array using a Comparator.

SortTool - Class in org.apache.velocity.tools.generic

Deprecated.
use CollectionTool sort methods

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() - Method in class org.apache.velocity.tools.generic.LoopTool

This tells the current loop to stop after the current 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(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.

STOP - org.apache.velocity.tools.generic.LoopTool.Action

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

STRING - org.apache.velocity.tools.config.Data.Type

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(Object...) - Method in class org.apache.velocity.tools.generic.MathTool

sub(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool

Sub() - Constructor for class org.apache.velocity.tools.generic.ClassTool.Sub

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, Object) - Method in class org.apache.velocity.tools.generic.LoopTool

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.

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

T

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

Returns a ComparisonDateTool.Comparison between the result of the second specified date and the first specified date.

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

Converts any Object to a boolean using ConversionUtils.toString(Object) and Boolean.valueOf(String).

toBoolean(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.

toBoolean(Object) - Method in class org.apache.velocity.tools.generic.NumberTool

Converts an object to an instance of Boolean if the object is not already an instance of Boolean.

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(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toCalendar(Object)

toCalendar(Object) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Calendar using the format returned by FormatConfig.getFormat(), the locale returned by LocaleConfig.getLocale() and the time zone returned by DateTool.getTimeZone().

toCalendar(Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Calendar using the provided locale, the format returned by FormatConfig.getFormat() and the time zone returned by DateTool.getTimeZone().

toCalendar(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Calendar using the provided format, the locale returned by LocaleConfig.getLocale() and the time zone returned by DateTool.getTimeZone().

toCalendar(String, Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Calendar using the provided format and locale, and the time zone returned by DateTool.getTimeZone().

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.

toCalendar(Date, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils

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) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toDate(Object)

toDate(Object) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Date using the format returned by FormatConfig.getFormat(),the Locale returned by LocaleConfig.getLocale(), and the TimeZone returned by DateTool.getTimeZone() if the object is not already an instance of Date, Calendar, or Long.

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(Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Date using the format returned by FormatConfig.getFormat(),the provided Locale, and the TimeZone returned by DateTool.getTimeZone() if the object is not already an instance of Date, Calendar, or Long.

toDate(Object, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Date using the format returned by FormatConfig.getFormat(),the provided Locale, and TimeZone if the object is not already an instance of Date, Calendar, or Long.

toDate(String, Object) - Method in class org.apache.velocity.tools.generic.DateTool

Converts an object to an instance of Date using the specified format,the Locale returned by LocaleConfig.getLocale(), and the TimeZone returned by DateTool.getTimeZone() if the object is not already an instance of Date, Calendar, or Long.

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.

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.

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

Deprecated.
use NumberTool.toNumber(Object).doubleValue()

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

Deprecated.
use NumberTool.toNumber(Object).intValue()

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(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use DateTool.toLocale(Object)

toLocale(Object) - Method in class org.apache.velocity.tools.generic.LocaleConfig

toLocale(String) - Static method in class org.apache.velocity.tools.ConversionUtils

Converts a string to a Locale

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

Deprecated.
use NumberTool.toNumber(Object).longValue()

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) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.

toNumber(Object) - Method in class org.apache.velocity.tools.generic.MathTool

Deprecated.
use NumberTool.toNumber(Object)

toNumber(Object) - Method in class org.apache.velocity.tools.generic.NumberTool

Converts an object to an instance of Number using the format returned by FormatConfig.getFormat() and the Locale returned by LocaleConfig.getLocale() if the object is not already an instance of Number.

toNumber(Object, boolean) - Static method in class org.apache.velocity.tools.ConversionUtils

Just like ConversionUtils.toNumber(Object) except that you can tell this to attempt parsing the object as a String by passing true as the second parameter.

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(String, Object) - Method in class org.apache.velocity.tools.generic.NumberTool

Converts an object to an instance of Number using the specified format and the Locale returned by LocaleConfig.getLocale() if the object is not already an instance of Number.

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.

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.

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(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration

tool(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap

tool(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration

tool(String, Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap

tool(String, Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration

tool(String, String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap

tool(String, String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration

toolbox - Variable in class org.apache.velocity.tools.generic.ContextTool

toolbox(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration

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 Toolboxes 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(Map<String, Object>) - Constructor for class org.apache.velocity.tools.ToolContext

Creates an instance starting with the specified tool properties.

ToolContext(VelocityEngine) - Constructor for class org.apache.velocity.tools.ToolContext

Creates an instance that automatically has the specified VelocityEngine and related tool properties set.

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(Object, Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Turns the specified key and value into a properly encoded query pair string.

toQuery(Map) - Method in class org.apache.velocity.tools.generic.LinkTool

Converts the map of keys to values into a query 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() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration

toString() - Method in class org.apache.velocity.tools.config.ToolConfiguration

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() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison

Renders this comparison to a String.

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 Nodes, then this returns the result of super.toString().

toString(boolean) - Method in class org.apache.velocity.tools.config.FactoryConfiguration

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(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(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(Collection) - Static method in class org.apache.velocity.tools.ConversionUtils

Returns the first value as a String, if any; otherwise returns null.

toStrings(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool

Deprecated.
use CollectionTool.split(String)

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, 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(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_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 - Variable in class org.apache.velocity.tools.generic.ClassTool

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

U

uncapitalize(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool

Changes the first character of the string value of the specified object to lower case and returns the resulting string.

unicode(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool

Converts the specified Unicode code point and/or escape sequence into the associated Unicode character.

uniqueName - Variable in class org.apache.velocity.tools.generic.ClassTool.CallableSub

UNIT_KEYS - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool

unurl(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool

Unscape the characters in a String encoded as an HTTP parameter value.

uri(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a copy of the link with the given URI reference set.

URI_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool

url(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool

Escape the characters in a String to be suitable to use as an HTTP parameter value.

URL_KEY - Static variable in class org.apache.velocity.tools.generic.ImportSupport

Configuration key for ImportTool, XmlTool and JsonTool, used to specify a local or remote source URL

USE_CLASS_LOGGER_KEY - Static variable in class org.apache.velocity.tools.generic.SafeConfig

Key used to specify whether or not tools shall use loggers named after the tools classes.

user - Variable in class org.apache.velocity.tools.generic.LinkTool

user(Object) - Method in class org.apache.velocity.tools.generic.LinkTool

Returns a new instance with the specified value set as its user info.

USER_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool

V

VALID_SCHEME_CHARS - Static variable in class org.apache.velocity.tools.generic.ImportSupport

validate() - Method in class org.apache.velocity.tools.config.CompoundConfiguration

validate() - Method in class org.apache.velocity.tools.config.Configuration

validate() - Method in class org.apache.velocity.tools.config.Data

validate() - Method in class org.apache.velocity.tools.config.FactoryConfiguration

validate() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration

validate() - Method in class org.apache.velocity.tools.config.ToolConfiguration

ValidScope - Annotation Type in org.apache.velocity.tools.config

value() - Method in enum org.apache.velocity.tools.config.Data.Type

value() - Method in annotation type org.apache.velocity.tools.config.DefaultKey

value() - Method in annotation type org.apache.velocity.tools.config.InvalidScope

value() - Method in annotation type org.apache.velocity.tools.config.ValidScope

valueOf(String) - Static method in enum org.apache.velocity.tools.config.Data.Type

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

valueOf(String) - Static method in enum org.apache.velocity.tools.generic.LoopTool.Action

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

ValueParser - Class in org.apache.velocity.tools.generic

Utility class for easy parsing of String values held in a Map.

ValueParser() - Constructor for class org.apache.velocity.tools.generic.ValueParser

ValueParser(Map<String, Object>) - Constructor for class org.apache.velocity.tools.generic.ValueParser

values() - Static method in enum org.apache.velocity.tools.config.Data.Type

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

values() - Static method in enum org.apache.velocity.tools.generic.LoopTool.Action

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

values() - Method in class org.apache.velocity.tools.generic.ValueParser

values() - Static method in class org.apache.velocity.tools.Scope

velocity - Variable in class org.apache.velocity.tools.ToolManager

velocity(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool

Escapes the characters in a String using "poor man's escaping" for Velocity templates by replacing all '$' characters with '${esc.d}' and all '#' characters with '${esc.h}'.

VIEW_DEFAULTS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils

W

warn(String) - Method in class org.apache.velocity.tools.generic.LogTool

watch(Object) - Method in class org.apache.velocity.tools.generic.LoopTool

Tells the LoopTool to watch the specified Array, Collection, Map, Iterator, Iterable, Enumeration or POJO with an iterator() method while the template iterates over the values within it.

watch(Object, String) - Method in class org.apache.velocity.tools.generic.LoopTool

This is just like LoopTool.watch(Object) except that it also takes a name which is given to the LoopTool.ManagedIterator that is returned.

WEEK_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool

whenIs(Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool

Returns a ComparisonDateTool.Comparison between the result of DateTool.getCalendar() and the specified date.

whenIs(Object, Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool

Returns a ComparisonDateTool.Comparison between the second specified date and the first specified date.

wrap(String) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag

X

XHTML_MODE_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool

XHTML_QUERY_DELIMITER - Static variable in class org.apache.velocity.tools.generic.LinkTool

XHTML delimiter for query data ('&')

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

Escapes the characters in a String using XML entities.

XmlFactoryConfiguration - Class in org.apache.velocity.tools.config

This reads in configuration info formatted as an XML file using Commons-Digester.

XmlFactoryConfiguration() - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfiguration

Creates an instance

XmlFactoryConfiguration(String) - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfiguration

Creates an instance using the specified string as an identifier to distinguish this instance when debugging

XmlFactoryConfigurationRuleSet - Class in org.apache.velocity.tools.config

This provides set of Rules used by Commons-Digester to process configuration info formatted as XML.

XmlFactoryConfigurationRuleSet() - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet

XmlFactoryConfigurationRuleSet.DataValueInBodyRule - Class in org.apache.velocity.tools.config

Rule for adding configuration properties

XmlFactoryConfigurationRuleSet.PropertyAttributeRule - Class in org.apache.velocity.tools.config

XmlTool - Class in org.apache.velocity.tools.generic

Tool for reading/navigating XML files, with XPath expressions support.

XmlTool() - Constructor for class org.apache.velocity.tools.generic.XmlTool

Default constructor.

XmlTool(List<Node>) - Constructor for class org.apache.velocity.tools.generic.XmlTool

Builds an XmlTool around a nodes list.

XmlTool(Node) - Constructor for class org.apache.velocity.tools.generic.XmlTool

Builds an XmlTool around a node.

XmlTool.NodeIterator - Class in org.apache.velocity.tools.generic

Iterator implementation that wraps a Node list iterator to return new XmlTool instances for each item in the wrapped iterator.s

XmlUtils - Class in org.apache.velocity.tools

Utility class for simplifying parsing of xml documents.

Y

YEAR_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool

Z

ZERO_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
All Classes All Packages