Skip navigation links
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 

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.
AbstractSearchTool - Class in org.apache.velocity.tools.view
Abstract view tool for doing "searching" and robust pagination of search results.
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.AbstractSearchTool
 
AbstractSearchTool.StoredResults - Class in org.apache.velocity.tools.view
Simple utility class to hold a criterion and its result list.
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
acquireLocalURLReader(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
 
acquireLocalURLString(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
Aquire the content of a local URL.
acquireLocalURLString(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
 
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
acquireRemoteURLReader(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
 
acquireRemoteURLString(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
Aquire the content of a remote URL.
acquireRemoteURLString(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
 
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, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
add(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
 
add(String) - Static method in class org.apache.velocity.tools.Scope
 
add(Cookie) - Method in class org.apache.velocity.tools.view.CookieTool
Adds the specified Cookie to the HttpServletResponse.
add(String, String) - Method in class org.apache.velocity.tools.view.CookieTool
Adds a new Cookie with the specified name and value to the HttpServletResponse.
add(String, String, Object) - Method in class org.apache.velocity.tools.view.CookieTool
Convenience method to add a new Cookie to the response and set an expiry time for it.
addChild(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(FactoryConfiguration) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
addConfiguration(Configuration) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
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
 
addDependencies(Map<String, List<String>>) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Adds the specified files organized by type to this instance's current dependencies.
addFile(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Adds a file to this instance's dependencies under the specified type.
addFile(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
 
addGroup(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
 
addMissingRequestParams(Object...) - Method in class org.apache.velocity.tools.view.LinkTool
Adds all of the current request's parameters to this link's "query data" except for those whose keys match any of the specified strings or already have a value set for them in the current instance.
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
 
addRequestParams(Object...) - Method in class org.apache.velocity.tools.view.LinkTool
Adds the specified parameters (if they exist) from the current request to the query data of a copy of this instance.
addRequestParamsExcept(Object...) - Method in class org.apache.velocity.tools.view.LinkTool
Adds all of the current request's parameters to this link's "query data" except for those whose keys match any of the specified strings.
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
addToolboxes(ToolContext) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
addToolboxesUnderKey(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
 
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.
ALT_VELOCITY_VIEW_KEY - Static variable in class org.apache.velocity.tools.view.ServletUtils
 
Alternator - Class in org.apache.velocity.tools.generic
Utility class for easily alternating over values in a list.
Alternator(Object...) - Constructor for class org.apache.velocity.tools.generic.Alternator
Creates a new Alternator for the specified 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.
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, Object) - Method in class org.apache.velocity.tools.generic.LinkTool
Appends a new key=value pair to the existing query data.
append(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
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
 
APPLICATION - Static variable in interface org.apache.velocity.tools.view.ViewContext
Key used for the servlet context object in templates.
application - Variable in class org.apache.velocity.tools.view.ViewContextTool
 
application - Variable in class org.apache.velocity.tools.view.ViewImportSupport
 
asList(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
 
attr(Object, Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
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.
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_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.
autoConfigure(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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
 
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.view.UiDependencyTool.FileRule
 
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.view.UiDependencyTool.GroupRule
 
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.view.UiDependencyTool.TypeRule
 
bitwiseAnd(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
bitwiseAnd(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
Bitwise And
bitwiseOr(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
bitwiseOr(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
Bitwise Or
bitwiseXOr(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
bitwiseXOr(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
Bitwise XOr
body(String, String, String) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet.DataValueInBodyRule
 
body(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
body(String, String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.FileRule
 
body(String, String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.NeedsRule
 
body(String, String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.TypeRule
 
bodyContentKey - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
bool(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
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.
BreadcrumbTool - Class in org.apache.velocity.tools.view
Helper tool to display a navigation breadcrumb to the end user.
BreadcrumbTool() - Constructor for class org.apache.velocity.tools.view.BreadcrumbTool
 
BreadcrumbTool.NavigationElement - Class in org.apache.velocity.tools.view
Class representing a navigation element
BrowserTool - Class in org.apache.velocity.tools.view
Browser sniffing tool (session or request scope requested, session scope advised).
BrowserTool() - Constructor for class org.apache.velocity.tools.view.BrowserTool
 
BrowserToolDeprecatedMethods - Class in org.apache.velocity.tools.view
Deprecated.
BrowserToolDeprecatedMethods() - Constructor for class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
BUFFER_OUTPUT_PARAM - Static variable in class org.apache.velocity.tools.view.VelocityViewServlet
 
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

cache(String, String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
cacheData(Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
CALENDAR_FIELDS - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
CallableSub() - Constructor for class org.apache.velocity.tools.generic.ClassTool.CallableSub
 
capitalize(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Changes the first character of the string value of the specified object to upper case and returns the resulting string.
CATCH_EXCEPTIONS_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
ceil(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
cell(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Truncates or pads the string value of the specified object as necessary to ensure that the returned string's length equals the default cell size.
cell(Object, int) - Method in class org.apache.velocity.tools.generic.DisplayTool
Truncates or pads the string value of the specified object as necessary to ensure that the returned string's length equals the specified cell size.
cell(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
Truncates or pads the string value of the specified object as necessary to ensure that the returned string's length equals the default cell size.
cell(Object, int, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
Truncates or pads the string value of the specified object as necessary to ensure that the returned string's length equals the specified cell size.
CELL_LENGTH_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
CELL_SUFFIX_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
charset - Variable in class org.apache.velocity.tools.generic.LinkTool
 
CHARSET_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
 
children() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
children() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns a new XmlTool instance that wraps all the child 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(FactoryConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
clean(ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
clean(Configuration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
clean(Configuration) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Convenience method that automatically creates a new ConfigurationCleaner and applies it to the specified Configuration.
CLEAN_CONFIGURATION_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Controls removal of tools or data with invalid configurations before initialization is finished.
cleanProperties(Configuration) - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
clear() - Method in class org.apache.velocity.tools.generic.ValueParser
 
clear() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Discard the output buffer.
clear() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
clearBuffer() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
 
clearBuffer() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
close() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
 
close() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Close the stream.
close() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
close() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
 
CollectionTool - Class in org.apache.velocity.tools.generic
CollectionTool allows a user to sort a collection (or array, iterator, etc) on any arbitrary set of properties exposed by the objects contained within the collection, and to generate arrays by splitting strings.
CollectionTool() - Constructor for class org.apache.velocity.tools.generic.CollectionTool
 
CollectionTool.PropertiesComparator - Class in org.apache.velocity.tools.generic
Does all of the comparisons
combine(Toolbox...) - Method in class org.apache.velocity.tools.Toolbox
Returns a new Toolbox that is a combination of this Toolbox with one or more specified Toolboxes.
combine(Map<String, Object>...) - Method in class org.apache.velocity.tools.ToolInfo
Combine several property maps
combinePath(String, String) - Method in class org.apache.velocity.tools.generic.LinkTool
If end is null, this will return start and vice versa.
combinePath(String, String) - Static method in class org.apache.velocity.tools.view.ServletUtils
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.
comment(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
compare(Object, Object) - Method in class org.apache.velocity.tools.generic.CollectionTool.PropertiesComparator
 
compare(Object, Object, int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Internal comparison method.
compare - Variable in class org.apache.velocity.tools.generic.LoopTool.Comparison
 
compareTo(Configuration) - Method in class org.apache.velocity.tools.config.Configuration
 
compareTo(Data) - Method in class org.apache.velocity.tools.config.Data
 
compareTo(Configuration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
compareTo(Configuration) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
compareTo(T) - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
Compare unique names of inspected and given objects
Comparison(Calendar, Calendar, int, int, boolean, Locale) - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Comparison object constructor
Comparison(Object) - Constructor for class org.apache.velocity.tools.generic.LoopTool.Comparison
 
ComparisonDateTool - Class in org.apache.velocity.tools.generic
Tool for comparing Date and Calendar values in Velocity templates.
ComparisonDateTool() - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool
 
ComparisonDateTool.Comparison - Class in org.apache.velocity.tools.generic
 
CompoundConfiguration<C extends Configuration> - Class in org.apache.velocity.tools.config
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
 
CONFIGURATION_KEY - Static variable in class org.apache.velocity.tools.view.ServletUtils
Key used to access a live FactoryConfiguration previously placed in the ServletContext attributes.
ConfigurationCleaner - Class in org.apache.velocity.tools.config
 
ConfigurationCleaner() - Constructor for class org.apache.velocity.tools.config.ConfigurationCleaner
 
ConfigurationException - Exception in org.apache.velocity.tools.config
 
ConfigurationException(String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(String, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Data, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Data, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Data, String, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Configuration, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Configuration, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Configuration, String, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationUtils - Class in org.apache.velocity.tools.config
Utility methods for handling tool configurations.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated.
Looks for a default auto-alternate value in the given params, if not, set the default to true.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ClassTool
Configure this tool
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.CollectionTool
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Calls the superclass implementation, then looks for a bundle name and any time units to be skipped.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ContextTool
Initializes this instance for the current request.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.DateTool
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.DisplayTool
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.EscapeTool
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.FieldTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.FormatConfig
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ImportSupport
Configure import support
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ImportTool
Configuration
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.JsonTool
Looks for the "file" parameter and automatically uses JsonTool.initJSON(String) to parse the file (searched in filesystem current path and classpath) and set the resulting JSON object as the root node for this instance.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.LinkTool
Configuration
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.LocaleConfig
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.RenderTool
Looks for deprecated parse depth and catch.exceptions properties, as well as any 'forceThreadSafe' setting.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
configure(Map<String, Object>) - Method in class org.apache.velocity.tools.generic.SafeConfig
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(ValueParser) - Method in class org.apache.velocity.tools.generic.SafeConfig
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.ValueParser
Does the actual configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.generic.XmlTool
Configuration.
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolboxFactory
 
configure(Object, Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo
Actually performs configuration of the newly instantiated tool using the combined final set of configuration properties.
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.ToolManager
Configure the tool manager with this toolbox factory config
configure(String) - Method in class org.apache.velocity.tools.ToolManager
Configure the tool manager with the provided configuration file
configure(ValueParser) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
Configuration
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ImportTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.view.IncludeTool
Extracts the default language from the specified ViewContext, looking first at the Velocity context, then the servlet context, then lastly at the JVM default.
configure(ViewToolContext) - Method in class org.apache.velocity.tools.view.IncludeTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.view.JsonTool
Configuration.
configure(ValueParser) - Method in class org.apache.velocity.tools.view.LinkTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ParameterTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.view.UiDependencyTool
 
configure(JeeConfig, VelocityEngine) - Method in class org.apache.velocity.tools.view.VelocityView
 
configure(JeeConfig, ToolboxFactory) - Method in class org.apache.velocity.tools.view.VelocityView
Here's the configuration lookup/loading order: If loadDefaults is true, ConfigurationUtils.getDefaultTools() Config file optionally specified by servletContext org.apache.velocity.tools init-param Config file optionally at /WEB-INF/tools.xml (conventional location) Config file optionally specified by servlet org.apache.velocity.tools init-param Remember that as these configurations are added on top of each other, the newer values will always override the older ones.
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ViewContextTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ViewImportSupport
 
configure(FactoryConfiguration) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
configure(ValueParser) - Method in class org.apache.velocity.tools.view.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
 
containsKey(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Indicates whether the specified key is in the context.
containsValue(Object) - Method in class org.apache.velocity.tools.generic.ValueParser
 
CONTENT_TYPE_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
The HTTP content type context key.
context - Variable in class org.apache.velocity.tools.generic.ContextTool
 
context - Variable in class org.apache.velocity.tools.view.JeeContextConfig
 
context - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
context(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Sets a custom {context} variable for the formats to use.
CONTEXT_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
CONTEXT_KEY - Static variable in class org.apache.velocity.tools.view.VelocityViewFilter
 
contextDestroyed(ServletContextEvent) - Method in class org.apache.velocity.tools.examples.showcase.sample.SampleListInitializer
 
contextInitialized(ServletContextEvent) - Method in class org.apache.velocity.tools.examples.showcase.sample.SampleListInitializer
 
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 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(String) - Method in class org.apache.velocity.tools.config.Data.AutoConverter
 
convert(Object) - Method in class org.apache.velocity.tools.config.Data
 
convert(Class, Object) - Method in class org.apache.velocity.tools.config.Data.FieldConverter
 
convert(Class, Object) - Method in class org.apache.velocity.tools.config.Data.NumberConverter
 
converter(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
converter(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
convertWith(Converter) - Method in class org.apache.velocity.tools.config.Data
This is a convenience method for those doing configuration in java.
CookieTool - Class in org.apache.velocity.tools.view
View tool for convenient cookie access and creation.
CookieTool() - Constructor for class org.apache.velocity.tools.view.CookieTool
 
CookieTool.SugarCookie - Class in org.apache.velocity.tools.view
Extends Cookie to add some fluid API sugar and a toString() method that renders the Cookie's value instead of the usual Object.toString() shenanigans.
create(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolInfo
Returns a new instance of the tool.
create(String, String) - Method in class org.apache.velocity.tools.view.CookieTool
Creates a new Cookie with the specified name and value.
create(String, String, Object) - Method in class org.apache.velocity.tools.view.CookieTool
Convenience method to create a new Cookie and set an expiry time for it.
CREATE_SESSION_PROPERTY - Static variable in class org.apache.velocity.tools.view.ViewToolManager
 
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
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityView
Creates and returns an initialized Velocity context.
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
 
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Get a configured Velocity context for the current request and response
createContext(Map<String, Object>) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
createContext(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
createDigester() - Method in class org.apache.velocity.tools.view.UiDependencyTool
Creates the Digester used by UiDependencyTool.read(java.lang.String, boolean) to create the group info for this instance out of the specified XML file.
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
 
customize(BreadcrumbTool.NavigationElement, HttpServletRequest) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
Let the user customize programmatically the name and URL of a specific element.

D

Data - Class in org.apache.velocity.tools.config
This class represents configured data.
Data() - Constructor for class org.apache.velocity.tools.config.Data
 
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.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_BODY_CONTENT_KEY - Static variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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_CONTENT_TYPE - Static variable in class org.apache.velocity.tools.view.VelocityView
The default content type for the response
DEFAULT_CRITERIA_KEY - Static variable in class org.apache.velocity.tools.view.AbstractSearchTool
 
DEFAULT_DATE_FORMAT - Static variable in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
DEFAULT_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The default filename for the servlet's default layout
DEFAULT_DELIMITER - Static variable in class org.apache.velocity.tools.generic.MarkupTool
 
DEFAULT_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The default error template's filename.
DEFAULT_FORMAT - Static variable in class org.apache.velocity.tools.generic.FormatConfig
The default format to be used when none is specified.
DEFAULT_INDEX_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_ITEMS_PER_PAGE - Static variable in class org.apache.velocity.tools.view.PagerTool
the default number of items shown per page
DEFAULT_ITEMS_PER_PAGE_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_KEY - Static variable in class org.apache.velocity.tools.generic.EscapeTool
 
DEFAULT_LANGUAGE_KEY - Static variable in class org.apache.velocity.tools.view.IncludeTool
The key used to search initialization, context, and JVM parameters for the default language to use.
DEFAULT_LAYOUT_DIR - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The default layout directory
DEFAULT_LOCALE - Static variable in class org.apache.velocity.tools.generic.LocaleConfig
The default Locale to be used when none is specified.
DEFAULT_NEW_ITEMS_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_NUMBER_FORMAT - Static variable in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
DEFAULT_OUTPUT_ENCODING - Static variable in class org.apache.velocity.tools.view.VelocityView
Default encoding for the output stream
DEFAULT_PARSE_DEPTH - Static variable in class org.apache.velocity.tools.generic.RenderTool
The maximum number of loops allowed when recursing.
DEFAULT_PROPERTIES_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
Default Runtime properties.
DEFAULT_SCHEME - Static variable in class org.apache.velocity.tools.generic.LinkTool
 
DEFAULT_SCOPE - Static variable in class org.apache.velocity.tools.ToolboxFactory
 
DEFAULT_SLIP_SIZE - Static variable in class org.apache.velocity.tools.view.PagerTool
the default max number of page indices to list
DEFAULT_SLIP_SIZE_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
 
DEFAULT_SOURCE_FILE - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
 
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_TOOLBOX_KEY - Static variable in interface org.apache.velocity.tools.view.ViewContext
Default key used to store toolboxes in request/session/application attributes.
DEFAULT_TOOLBOX_KEY - Static variable in class org.apache.velocity.tools.view.ViewToolManager
 
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.
defaultLanguage - Variable in class org.apache.velocity.tools.view.IncludeTool
The two character abbreviation for the request's default language.
defaultLayout - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
 
delete(String) - Method in class org.apache.velocity.tools.view.CookieTool
Retrieves the specified cookie and sets the Max-Age to 0 to tell the browser to delete the cookie.
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.
destroy() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
 
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.
discover(Class) - Method in class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
 
discover(Class, Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
 
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, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
div(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
 
doEndTag() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
Simply prepares the request (and/or session) toolbox(es) for other filters, servlets or whatnot to use.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Handles GET - calls doRequest()
domain(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Handle a POST request - calls doRequest()
doRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Handles with both GET and POST requests
doStartTag() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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.
end(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool.GroupRule
 
engine - Variable in class org.apache.velocity.tools.view.IncludeTool
 
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
 
error(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
Overrides VelocityViewServlet to display user's custom error template
error(HttpServletRequest, HttpServletResponse, Throwable) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Invoked when there is an error thrown in any part of doRequest() processing.
errorTemplate - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
 
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.
evalBody(Writer) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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.
execute(Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
 
execute(Object, Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
 
executeQuery(Object) - Method in class org.apache.velocity.tools.examples.showcase.tool.MySearchTool
This is a very simplistic implementation that looks for the string value of the criteria in the string value of every item in our stupid static database.
executeQuery(Object) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Executes a query for the specified criteria.
executeSimpleTag(InternalContextAdapter, Node, PageContext, SimpleTag) - Static method in class org.apache.velocity.tools.view.jsp.jspimpl.JspUtils
Executes a SimpleTag.
executeTag(InternalContextAdapter, Node, PageContext, Tag) - Static method in class org.apache.velocity.tools.view.jsp.jspimpl.JspUtils
Executes a Tag.
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
 
exists(String) - Method in class org.apache.velocity.tools.view.IncludeTool
Checks to see whether a #parse-able template or #include-able resource exists under the specified name/path.
exists(String, String) - Method in class org.apache.velocity.tools.view.IncludeTool
Checks to see whether a localized version of the named template exists for the specified language.
ExternalWriterHttpServletResponse - Class in org.apache.velocity.tools.view.jsp.jspimpl
Copied from Tiles Request sandbox.
ExternalWriterHttpServletResponse(HttpServletResponse, PrintWriter) - Constructor for class org.apache.velocity.tools.view.jsp.jspimpl.ExternalWriterHttpServletResponse
Constructor.

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(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.
FactoryConfiguration(Class, String) - Constructor for class org.apache.velocity.tools.config.FactoryConfiguration
Allows subclasses to construct an instance that uses their classname.
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_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
 
FileRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.FileRule
 
fillContext(Context, HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
Overrides VelocityViewServlet to check the request for an alternate layout
fillContext(Context, HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Standard extension point to populate the context with additional entries
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.
fillKeyset(Set) - Method in class org.apache.velocity.tools.view.ViewContextTool
 
filter - Variable in class org.apache.velocity.tools.view.JeeFilterConfig
 
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(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) - 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.
find(String, Locale) - Method in class org.apache.velocity.tools.view.IncludeTool
Calls IncludeTool.find(String, String) using the language extracted from locale.
find(String) - Method in class org.apache.velocity.tools.view.IncludeTool
Calls IncludeTool.find(String, String) using the default language.
find(String, String) - Method in class org.apache.velocity.tools.view.IncludeTool
Finds the a localized version of the requested Velocity resource (such as a file or template) which is most appropriate for the locale of the current request.
findAttribute(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
findConfig(String) - Method in class org.apache.velocity.tools.ToolManager
Find a configuration file
findConfig(String) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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.
findInitParameter(String) - Method in interface org.apache.velocity.tools.view.JeeConfig
Looks for the specified init-param in the servlet/filter config (i.e.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeContextConfig
Only checks the ServletContext's init-params for the specified parameter.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeFilterConfig
Looks for the specified init-param in the servlet/filter config (i.e.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeServletConfig
Looks for the specified init-param in the servlet/filter config (i.e.
findInitParameter(String) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
Looks up an init parameter with the specified key in either the FilterConfig or, failing that, in the ServletContext.
findInitParameter(ServletConfig, String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Looks up an init parameter with the specified key in either the ServletConfig or, failing that, in the ServletContext.
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.
findLayout(HttpServletRequest) - Method in class org.apache.velocity.tools.examples.showcase.ShowcaseLayoutServlet
Searches for a non-default layout to be used for this request.
findLayout(HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
Searches for a non-default layout to be used for this request.
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
 
findTool(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, String, HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findTool(String, String, HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
findURL(String) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
 
floor(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
flush() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Flush the stream.
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(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, 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, 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(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.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.NumberTool
Converts the specified object to a number and returns a formatted string representing that number in the specified Locale.
format(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Applies the format string to the given value.
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
 
formatElementName(String) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
Automatic default formatting of URI elements
forward(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
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(String) - Static method in enum org.apache.velocity.tools.config.Data.Type
 
get(Object) - Method in class org.apache.velocity.tools.generic.ContextTool
Retrieves the value for the specified reference name (aka context key).
get(String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date returned by DateTool.getDate().
get(String, String) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a formatted string representing the date and/or time given by DateTool.getDate() in standard, localized patterns.
get(String) - Method in class org.apache.velocity.tools.generic.FieldTool.FieldToolSub
 
get(String) - Method in class org.apache.velocity.tools.generic.FieldTool
Returns the value for the specified field name as found in the stored Map of field names to values (or placeholders).
get(int) - Method in class org.apache.velocity.tools.generic.JsonContent
Get a value from root array
get(String) - Method in class org.apache.velocity.tools.generic.JsonContent
Get a property from root object
get(int) - Method in class org.apache.velocity.tools.generic.JsonTool
Get nth element from root json array.
get(String) - Method in class org.apache.velocity.tools.generic.JsonTool
Get a property from root object
get(String) - Method in class org.apache.velocity.tools.generic.LoopTool
This serves two purposes:
get(String, String) - Method in class org.apache.velocity.tools.generic.LoopTool
Asks the loop with the specified name for the current value of the specified sync'ed iterator, if any.
get(String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
get() - Method in class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
 
get(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
 
get(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
Accepts objects and uses their string value as the key.
get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool
Accepts objects and uses their string value as the key.
get(Object, String, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
Returns the value for the specified key in the ResourceBundle for the specified basename and locale.
get(Object, String[], Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
Retrieve a resource for the specified key from the first of the specified bundles in which a matching resource is found.
get(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
get(String) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
get(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Convenience method for use in Velocity templates.
get(Object) - Method in class org.apache.velocity.tools.generic.ValueParser
 
get(Object) - Method in class org.apache.velocity.tools.generic.XmlTool
This will first attempt to find an attribute with the specified name and return its value.
get(Number) - Method in class org.apache.velocity.tools.generic.XmlTool
Returns an XmlTool that wraps the specified Node from this instance's internal Node list.
get(String) - Method in class org.apache.velocity.tools.Toolbox
 
get(String, String) - Method in class org.apache.velocity.tools.Toolbox
 
get(String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
get(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
get(String) - Method in class org.apache.velocity.tools.ToolContext
 
get(String) - Method in class org.apache.velocity.tools.view.BrowserTool
 
get(String) - Method in class org.apache.velocity.tools.view.CookieTool
Returns the Cookie with the specified name, if it exists.
get(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Looks up and returns the object with the specified key.
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.
getAcceptLanguage() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAll(Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
getAll() - Method in class org.apache.velocity.tools.view.CookieTool
Expose array of Cookies for this request to the template.
getAll() - Method in class org.apache.velocity.tools.view.ParameterTool
 
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(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getAttribute(String, int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getAttribute(String) - Method in class org.apache.velocity.tools.view.jsp.JspToolContext
 
getAttribute(String) - Method in interface org.apache.velocity.tools.view.ViewContext
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAttribute(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Searches for the named attribute in request, session (if valid), and application scope(s) in order and returns the value associated or null.
getAttribute(Node, String, String) - Static method in class org.apache.velocity.tools.XmlUtils
Extracts an attribute from a node.
getAttribute(Node, String) - Static method in class org.apache.velocity.tools.XmlUtils
 
GetAttributeExecutor(Logger, Introspector, Class, String) - Constructor for class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
 
getAttributeNamesInScope(int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getAttributesScope(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getAutoAlternateDefault() - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated.
Returns true if the default for auto-alternating is true.
getAverage(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values from a list
getAverage(Object[], String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values from a list
getAverage(Collection) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values
getAverage(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values
getAverage(double...) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values in an array of double values
getAverage(long...) - Method in class org.apache.velocity.tools.generic.MathTool
Get the average of the values in an array of long values
getB() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a backslash (\).
getBackslash() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a backslash (\).
getBaseRef() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the full URI of this template without any query data.
getBodyContentKey() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getBoolAttribute(Node, String, boolean) - Static method in class org.apache.velocity.tools.XmlUtils
Retrieves an attribute as a boolean.
getBoolAttribute(Node, String) - Static method in class org.apache.velocity.tools.XmlUtils
 
getBoolean(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBoolean(String, boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBoolean(String, Boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBooleans(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getBrowser() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getBrowser() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
getBrowser() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
getBundle(String, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
Retrieves the ResourceBundle for the specified baseName and locale, if such exists.
getCache() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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
 
getConfiguration(ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
getConfiguration(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
getConfiguration(String) - Method in class org.apache.velocity.tools.view.VelocityView
 
getConfiguration(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
 
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.
getContextKey() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
 
getContextPath() - Method in class org.apache.velocity.tools.generic.LinkTool
At this level, this only returns the result of LinkTool.getDirectory().
getContextPath() - Method in class org.apache.velocity.tools.view.LinkTool
Initially, this returns the context path that addresses this web application, e.g.
getContextURL() - Method in class org.apache.velocity.tools.view.LinkTool
Returns a URL that addresses the web application.
getConvertedValue() - Method in class org.apache.velocity.tools.config.Data
 
getConverter() - Method in class org.apache.velocity.tools.config.Data
 
getConverter() - Method in enum org.apache.velocity.tools.config.Data.Type
 
getCount() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the number of items the current loop has handled.
getCount(String) - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the number of items the specified loop has handled.
getCount() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
getCreateSession() - Method in class org.apache.velocity.tools.examples.showcase.tool.MySearchTool
Override to create a session in which to store search results.
getCreateSession() - Method in class org.apache.velocity.tools.view.PagerTool
 
getCreateSession() - Method in class org.apache.velocity.tools.view.ViewToolManager
 
getCriteria() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Return the criteria object for this request.
getCriteria() - Method in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
 
getCriteriaKey() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
 
getCss() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getCss1() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getCss2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getCss3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getCurrent() - Method in class org.apache.velocity.tools.generic.Alternator
Returns the current item without shifting the list index.
getD() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a dollar sign ($).
getData() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
getData(String) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
Search for Data by key
getData(Data) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
Search for Data by value
getData() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
getData() - Method in class org.apache.velocity.tools.ToolboxFactory
 
getDate() - Method in class org.apache.velocity.tools.generic.DateTool
Returns a Date derived from the result of DateTool.getCalendar()
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, 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(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() - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
use DateTool getDateFormat() methods
getDateFormat(String, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Returns a DateFormat instance for the specified format, 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.
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
 
getDefaultContentType() - Method in class org.apache.velocity.tools.view.VelocityView
 
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.
getDefaultToolsConfiguration() - Method in class org.apache.velocity.tools.view.VelocityView
 
getDependencies() - Method in class org.apache.velocity.tools.view.UiDependencyTool
Returns the current dependencies of this instance, organized as an ordered map of file types to lists of the required files of that type.
getDependencies(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Returns the List of files for the specified file type, if any.
getDependencies(UiDependencyTool) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
 
getDepth() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the number of loops currently on the stack.
getDevice() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getDeviceType() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
getDifference() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
getDirectory() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the directory stack in the set LinkTool.getPath() value, by just trimming off all that follows the last "/".
getDollar() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a dollar sign ($).
getDom0() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getDom1() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getDom2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getDom3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getDotnet() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
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 (!).
getELContext() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
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.
getException() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
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
 
getExpressionEvaluator() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getExtension(String) - Static method in class org.apache.velocity.tools.view.BreadcrumbTool
Utility method to return URI file extension
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(String) - Static method in class org.apache.velocity.tools.ClassUtils
Given a static field path, aka classname.field, get the field value.
getFieldValue(Class, String) - Static method in class org.apache.velocity.tools.ClassUtils
Given a class and a static field name, get the field value.
getFile() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the last section of the path, which is all that follows the final "/".
getFileResource(String) - Method in class org.apache.velocity.tools.generic.ImportSupport
Overridable local file URL builder.
getFileResource(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
 
getFilterConfig() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
 
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.
getFirstIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the index of the first item on the current page of results (as determined by the current index, items per page, and the number of items).
getFormat() - Method in class org.apache.velocity.tools.generic.FormatConfig
This returns the configured default format for this tool.
getFormat(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Retrieves the configured format string for the specified file type.
getFromCache(String, String) - Method in class org.apache.velocity.tools.Toolbox
 
getFromClass(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Get a specific FactoryConfiguration class
getFromClass(Class) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
 
getFromInfo(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
getFull() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
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.
getGeckoMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getGeckoMinorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getGeckoVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
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
 
getGroup(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
NOTE: This method may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
getGroupDependencies(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Returns the dependencies of the specified group, organized as an ordered map of file types to lists of the required files of that type.
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.
getIe() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe4up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe55() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe55up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe5up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe6up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe7() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe7up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe8() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIe8up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getIndex() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the 0-based index of the item the current loop is handling.
getIndex(String) - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the 0-based index of the item the specified loop is handling.
getIndex() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
getIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the current search result index.
getIndexKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
getInitParameter(String) - Method in interface org.apache.velocity.tools.view.JeeConfig
Returns an initialization parameter.
getInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeContextConfig
Returns an initialization parameter.
getInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeFilterConfig
Returns an initialization parameter.
getInitParameter(String) - Method in class org.apache.velocity.tools.view.JeeServletConfig
Returns an initialization parameter.
getInitParameterNames() - Method in interface org.apache.velocity.tools.view.JeeConfig
Returns all the parameter names.
getInitParameterNames() - Method in class org.apache.velocity.tools.view.JeeContextConfig
Returns all the parameter names.
getInitParameterNames() - Method in class org.apache.velocity.tools.view.JeeFilterConfig
Returns all the parameter names.
getInitParameterNames() - Method in class org.apache.velocity.tools.view.JeeServletConfig
Returns all the parameter names.
getInputStream(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
getInputStream(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
 
getInstance(String) - Static method in class org.apache.velocity.tools.ClassUtils
Get an instance of a named class.
getInstance() - Method in class org.apache.velocity.tools.config.ConfigurationUtils
 
getInstance() - Method in class org.apache.velocity.tools.ConversionUtils
 
getInstance() - Static method in class org.apache.velocity.tools.Scope
 
getInstance() - Method in class org.apache.velocity.tools.view.ServletUtils
 
getInt(String, int) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getIntAttribute(Node, String, int) - Static method in class org.apache.velocity.tools.XmlUtils
 
getIntAttribute(Node, String) - Static method in class org.apache.velocity.tools.XmlUtils
 
getInteger(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getInteger(String, Integer) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getInts(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getInvalidScopes() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getIPAddress() - Method in class org.apache.velocity.tools.view.BrowserTool
Get the client browser IP address.
getItems() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Gets the results for the given criteria either in memory or by performing a new query for them.
getItems() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the item list.
getItemsPerPage() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the set number of items to be displayed per page of items
getItemsPerPageKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
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
 
getJavascript() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getJspContext() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityJspFragment
 
getKey() - Method in class org.apache.velocity.tools.config.Data
 
getKey() - Method in class org.apache.velocity.tools.config.ToolConfiguration
Returns the key set for this tool.
getKey() - Method in class org.apache.velocity.tools.generic.EscapeTool
Should return the key under which this tool has been configured.
getKey() - Method in class org.apache.velocity.tools.ToolInfo
Get tool key
getKeys() - Method in class org.apache.velocity.tools.generic.ContextTool
Return a Set of the available reference keys in the current context.
getKeys() - Method in class org.apache.velocity.tools.generic.ResourceTool
Lists available keys
getKeys(String, String, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
Returns a List of the key strings in the ResourceBundle with the specified baseName and locale.
getKeys(String, String[], Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
Returns a List of the key strings in the specified ResourceBundles.
getKeys() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
getKeys() - Method in class org.apache.velocity.tools.Toolbox
 
getKeys() - Method in class org.apache.velocity.tools.ToolContext
 
getLanguagesFilter() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
getLastIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the index of the last item on the current page of results (as determined by the current index, items per page, and the number of items).
getLastModified(Resource) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
Checks to see when a resource was last modified
getLastSyncedValues() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
getLatestJspTag(Context) - Static method in class org.apache.velocity.tools.view.jsp.jspimpl.JspUtils
Returns the latest tag encountered.
getList() - Method in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
 
getListDelimiter() - Method in class org.apache.velocity.tools.generic.DisplayTool
 
getListFinalDelimiter() - Method in class org.apache.velocity.tools.generic.DisplayTool
 
getLocale() - Method in class org.apache.velocity.tools.generic.LocaleConfig
This returns the configured default Locale for this tool.
getLocale(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLocale(String, Locale) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLocales(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLog(VelocityEngine, String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
 
getLog() - Method in class org.apache.velocity.tools.generic.SafeConfig
Get logger
getLog() - Method in class org.apache.velocity.tools.ToolManager
Get logger
getLog() - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
getLogId() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getLong(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLong(String, Long) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getMajorVersion() - Method in class org.apache.velocity.tools.view.UAParser.UAEntity
 
getMessage() - Method in class org.apache.velocity.tools.examples.simple.tool.ToyTool
 
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.
getMinorVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getMinorVersion() - Method in class org.apache.velocity.tools.view.UAParser.UAEntity
 
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.
getMutex(HttpSession, String, Object) - Static method in class org.apache.velocity.tools.view.ServletUtils
Returns a mutex (lock object) unique to the specified session and stored under the specified key to allow for reliable synchronization on the session.
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.examples.showcase.sample.Person
 
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.
getName() - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
Displayed name getter
getName() - Method in interface org.apache.velocity.tools.view.JeeConfig
Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.JeeContextConfig
Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.JeeFilterConfig
Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.JeeServletConfig
Returns the name of the servlet (or filter) being used.
getName() - Method in class org.apache.velocity.tools.view.UAParser.UAEntity
 
getNav2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNav3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNav4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNav45() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNav45up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNav4up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNav6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNav6up() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNavgold() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getNewItemsKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
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.
getNextIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the index for the next page of items (as determined by the current index, items per page, and the number of items).
getNodeName() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns the name of the root node.
getNodes(String, Node) - Static method in class org.apache.velocity.tools.XmlUtils
Search for nodes using an XPath expression
getNumber(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getNumber(String, Number) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getNumberFormat(String, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns a NumberFormat instance for the specified format and Locale.
getNumberFormat(int, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns a NumberFormat instance for the specified number style and Locale.
getNumberFormat() - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
use NumberTool format
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
getOpera3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getOpera4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getOpera5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getOpera6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getOpera7() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getOpera8() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getOpera9() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getOperatingSystem() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOperatingSystem() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
getOperatingSystem() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
getOut() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getOutputStream() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
 
getOutputWriter(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Get the output stream writer to use.
getPackage() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns the name of the package to which the inspected Class belongs.
getPage() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getPage() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the current "page" of search items.
getPageContext() - Method in class org.apache.velocity.tools.view.jsp.JspToolContext
 
getPageDescription() - Method in class org.apache.velocity.tools.view.PagerTool
Returns a description of the current page.
getPageNumber(int) - Method in class org.apache.velocity.tools.view.PagerTool
Returns the "page number" for the specified index.
getPageNumber() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the "page number" for the current index.
getPagesAvailable() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the number of pages that can be made from this list given the set number of items per page.
getParameterCount() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
Returns the number of expected parameters.
getParameters() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
 
getParameters() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
 
getParameters() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
 
getParams() - Method in class org.apache.velocity.tools.generic.LinkTool
 
getParent() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
getParent() - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
getParent() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns a new XmlTool instance that wraps the parent Element of the first/sole Node being wrapped by this instance.
getParseDepth() - Method in class org.apache.velocity.tools.generic.RenderTool
Get the maximum number of loops allowed when recursing.
getPath() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the current path value for this instance.
getPath() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns the XPath that identifies the first/sole Node represented by this instance.
getPath(HttpServletRequest) - Static method in class org.apache.velocity.tools.view.ServletUtils
Retrieves the path for the specified request regardless of whether this is a direct request or an include by the RequestDispatcher.
getPlain() - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
getPort() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the port value, if any.
getPreferredLanguage() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getPreferredLocale() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getPrevIndex() - Method in class org.apache.velocity.tools.view.PagerTool
Return the index for the previous page of items (as determined by the current index, items per page, and the number of items).
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
getProperties(String) - Method in class org.apache.velocity.tools.view.VelocityView
 
getProperties(String, boolean) - Method in class org.apache.velocity.tools.view.VelocityView
 
getProperty(String) - Method in class org.apache.velocity.tools.config.Configuration
 
getProperty(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
Safely retrieves the specified property from the specified object.
getProperty(String, String) - Method in class org.apache.velocity.tools.view.VelocityView
Simplifies process of getting a property from VelocityEngine, because the VelocityEngine interface sucks compared to the singleton's.
getPropertyGet(Object, String, Info) - Method in class org.apache.velocity.tools.view.WebappUberspector
Property getter
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.
getPropertySet(Object, String, Object, Info) - Method in class org.apache.velocity.tools.view.WebappUberspector
Property setter
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
getPublishToolboxes() - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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
 
getReader() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
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.
getRemaining() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
 
getRemaining() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
getRenderedBody() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getRenderingEngine() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getRenderingEngine() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
getRenderingEngine() - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
getRepository() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getRequest() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getRequest() - Method in class org.apache.velocity.tools.view.ParameterTool
Returns the current ServletRequest for this instance.
getRequest() - Method in interface org.apache.velocity.tools.view.ViewContext
 
getRequest() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
getRequestPath() - Method in class org.apache.velocity.tools.view.LinkTool
Initially, this retrieves the path for the current request regardless of whether this is a direct request or an include by the RequestDispatcher.
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.
getResourceReader(String, String) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
Get Reader so that the Runtime can build a template with it.
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.
getResponse() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getResponse() - Method in interface org.apache.velocity.tools.view.ViewContext
 
getResponse() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
getRestrictTo() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getReturns() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
 
getRole() - Method in class org.apache.velocity.tools.examples.showcase.sample.Person
 
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
 
getScope() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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
 
getServletApi(String) - Method in class org.apache.velocity.tools.view.jsp.JspToolContext
 
getServletApi(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current matching servlet request, response, session, or servlet context instance, or null if the key matches none of those keys.
getServletConfig() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getServletContext() - Method in interface org.apache.velocity.tools.view.JeeConfig
Returns the servlet context.
getServletContext() - Method in class org.apache.velocity.tools.view.JeeContextConfig
Returns the servlet context.
getServletContext() - Method in class org.apache.velocity.tools.view.JeeFilterConfig
Returns the servlet context.
getServletContext() - Method in class org.apache.velocity.tools.view.JeeServletConfig
Returns the servlet context.
getServletContext() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getServletContext() - Method in interface org.apache.velocity.tools.view.ViewContext
 
getServletContext() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
getSession() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getSession() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
getSessionToolbox() - Method in class org.apache.velocity.tools.view.ViewToolManager
 
getSessionToolbox(HttpSession) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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
 
getSlip() - Method in class org.apache.velocity.tools.view.PagerTool
Returns a Sliding List of Indices for Pages of items.
getSlipSize() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the number of result page indices PagerTool.getSlip() will return per request (if available).
getSlipSizeKey() - Method in class org.apache.velocity.tools.view.PagerTool
 
getSource() - Method in exception org.apache.velocity.tools.config.ConfigurationException
 
getSource() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
Returns the original source of this particular instance.
getSource(boolean) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getSource() - Method in class org.apache.velocity.tools.generic.ValueParser
 
getSource() - Method in class org.apache.velocity.tools.view.ParameterTool
Overrides ValueParser.getSource() to return the result of getRequest().getParameterMap() and expand singleton arrays within it first.
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.
getStatus() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
 
getStoredItems() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
 
getStoredItems() - Method in class org.apache.velocity.tools.view.PagerTool
Retrieves stored search items (if any) from the user's session attributes.
getStoredResults() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Retrieves stored search results (if any) from the user's session attributes.
getString(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getString(String, String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getString() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
getString() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
Retrieves the buffered output, using the containing tag's 'charEncoding' attribute, or the tag's default encoding, if necessary.
getStrings(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getStringsDelimiter() - Method in class org.apache.velocity.tools.generic.CollectionTool
Gets the configured strings delimiter
getStringsDelimiter() - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
Gets the delimiter used for separating values in a single String value.
getStringsTrim() - Method in class org.apache.velocity.tools.generic.CollectionTool
Gets whether to trim strings
getStringsTrim() - Method in class org.apache.velocity.tools.generic.ConversionTool
getSubkey(String) - Method in class org.apache.velocity.tools.generic.ValueParser
subkey getter that returns a map subkey#2 -> value for every "subkey.subkey2" found entry
getSubkeys() - Method in class org.apache.velocity.tools.generic.ValueParser
returns the set of all possible first-level subkeys, including complete keys without dots (or returns keySet() if allowSubKeys is false)
getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
 
getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.FieldSub
 
getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
 
getSubType() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
getSuper() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns a new ClassTool instance that is inspecting the superclass of the Class being inspected by this instance.
getSurname() - Method in class org.apache.velocity.tools.examples.showcase.sample.Person
 
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
 
getTemplate() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getTemplate(HttpServletRequest) - Method in class org.apache.velocity.tools.view.VelocityView
Gets the requested template.
getTemplate(String) - Method in class org.apache.velocity.tools.view.VelocityView
Retrieves the requested template.
getTemplate(String, String) - Method in class org.apache.velocity.tools.view.VelocityView
Retrieves the requested template with the specified character encoding.
getTemplate(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Get a template by client request and response
getTemplate(String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Get a template by name
getText(String, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Retrieves the specified text resource.
getText() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns the concatenated text content of all the internally held nodes.
getThis() - Method in class org.apache.velocity.tools.generic.ContextTool
Returns the context being analyzed by this tool.
getThis() - Method in class org.apache.velocity.tools.generic.LoopTool
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(String) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
getToolbox() - Method in class org.apache.velocity.tools.generic.ContextTool
Returns a read-only view of the toolbox Map for this context.
getToolbox() - Method in class org.apache.velocity.tools.ToolContext
Returns a Map of all tools available to this context.
getToolboxes() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
getToolboxes() - Method in class org.apache.velocity.tools.ToolContext
 
getToolboxes() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
getToolboxFactory() - Method in class org.apache.velocity.tools.ToolManager
Returns the underlying ToolboxFactory being used.
getToolboxKey() - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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
 
getToolVar(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Finds the automatically provided values, either configured tools or servlet API objects (request, response, etc).
getTotal(Collection, String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values from a list
getTotal(Object[], String) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values from a list
getTotal(Collection) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal(double...) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal(long...) - Method in class org.apache.velocity.tools.generic.MathTool
Get the sum of the values
getTotal() - Method in class org.apache.velocity.tools.view.PagerTool
Returns the total number of items available.
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.
getUrl() - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
Destination URL getter
getURL(String, ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
getUser() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the URI.getUserInfo() value for this instance.
getUserAgent() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getUserAgentString() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getUserAgentString() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
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
getUserVar(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
Finds "user" set values, either in the local context or in the scoped attributes if none is in the local context.
getValidScopes() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getValue() - Method in class org.apache.velocity.tools.config.Data
 
getValue(Object) - Method in class org.apache.velocity.tools.generic.DateTool
 
getValue(Object, Object) - Method in class org.apache.velocity.tools.generic.DateTool
 
getValue(int, Object) - Method in class org.apache.velocity.tools.generic.DateTool
 
getValue() - Method in class org.apache.velocity.tools.generic.FieldTool.MutableField
 
getValue(String) - Method in class org.apache.velocity.tools.generic.ValueParser
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
 
getValue(String) - Method in class org.apache.velocity.tools.view.ParameterTool
Overrides ValueParser.getValue(String key) to retrieve the value from the ServletRequest instead of an arbitrary Map.
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.
getValues(String) - Method in class org.apache.velocity.tools.view.ParameterTool
Overrides ValueParser.getValues(String key) to retrieve Strings from the ServletRequest instead of an arbitrary Map.
getVar() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getVariableResolver() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getVelocityContext() - Method in interface org.apache.velocity.tools.view.ViewContext
 
getVelocityContext() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
getVelocityEngine() - Method in class org.apache.velocity.tools.ToolManager
Get the underlying VelocityEngine being used.
getVelocityEngine() - Method in interface org.apache.velocity.tools.view.ViewContext
 
getVelocityEngine() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
getVelocityProperty(String, String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
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".
getVelocityView() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getVelocityView(ServletConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
Returns the shared VelocityView for the specified ServletConfig's context.
getVelocityView(FilterConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
Returns the shared VelocityView for the specified FilterConfig's context.
getVelocityView(JeeConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
Returns the shared VelocityView for the specified JeeConfig's context.
getVelocityView(ServletContext) - Static method in class org.apache.velocity.tools.view.ServletUtils
Returns the shared VelocityView for the specified ServletContext.
getVelocityView(ServletContext, boolean) - Static method in class org.apache.velocity.tools.view.ServletUtils
Returns the shared VelocityView for the specified ServletContext.
getVelocityView() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
 
getVelocityView() - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
getVersion() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getViewToolContext() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getVista() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
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
 
getWin16() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWin2k() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWin31() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWin32() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWin3x() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWin95() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWin98() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWinme() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWinnt() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWinxp() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
getWriter() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.ExternalWriterHttpServletResponse
getWriter() - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
 
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.
Group(String) - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.Group
 
GroupRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.GroupRule
 
GROUPS_KEY_SPACE - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
 

H

handlePageException(Exception) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
handlePageException(Throwable) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
handleParamsBoolean(boolean) - Method in class org.apache.velocity.tools.generic.LinkTool
In this class, this method ignores true values.
handleRequest(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
This was a common extension point, but now it is usually simpler to override VelocityViewServlet.fillContext(org.apache.velocity.context.Context, javax.servlet.http.HttpServletRequest) to add custom things to the Context or override a VelocityViewServlet.getTemplate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method to change how Templates are retrieved.
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
hasContent() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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().
hasItems() - Method in class org.apache.velocity.tools.view.PagerTool
Checks whether or not the result list is empty.
hasNext() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
hasNext() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator
 
hasPermission(ToolInfo, String) - Method in class org.apache.velocity.tools.Toolbox
 
hasPermission(String) - Method in class org.apache.velocity.tools.ToolInfo
 
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
hasSessionTools() - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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.
ImportResponseWrapper(HttpServletResponse) - Constructor for class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
Constructs a new ImportResponseWrapper.
ImportSupport - Class in org.apache.velocity.tools.generic
Provides methods to import arbitrary local or remote resources as strings, generic version.
ImportSupport() - Constructor for class org.apache.velocity.tools.generic.ImportSupport
 
importSupport - Variable in class org.apache.velocity.tools.generic.ImportTool
ImportSupport utility which provides underlying i/o
importSupport - Variable in class org.apache.velocity.tools.generic.JsonTool
ImportSupport utility which provides underlying i/o
importSupport - Variable in class org.apache.velocity.tools.generic.XmlTool
ImportSupport utility which provides underlying i/o
ImportSupport.SafeClosingHttpURLConnectionReader - Class in org.apache.velocity.tools.generic
 
ImportTool - Class in org.apache.velocity.tools.generic
General-purpose text-importing tool for templates.
ImportTool() - Constructor for class org.apache.velocity.tools.generic.ImportTool
 
ImportTool - Class in org.apache.velocity.tools.view
General-purpose text-importing view tool for templates.
ImportTool() - Constructor for class org.apache.velocity.tools.view.ImportTool
 
in(String) - Method in class org.apache.velocity.tools.generic.FieldTool
Returns a FieldTool.FieldToolSub holding a Map of all the public static field names to values (or a placeholder if the value is not final) for the specified class(name).
in(Object) - Method in class org.apache.velocity.tools.generic.FieldTool
Returns a FieldTool.FieldToolSub holding a Map of all the public static field names to values (or a placeholder if the value is not final) for the Class of the specified Object.
in(Class) - Method in class org.apache.velocity.tools.generic.FieldTool
Returns a FieldTool.FieldToolSub holding a Map of all the public static field names to values (or a placeholder if the value is not final) for the specified Class.
include(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
include(String, boolean) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
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.
INCLUDE_REQUEST_PARAMS_KEY - Static variable in class org.apache.velocity.tools.view.LinkTool
 
includeRequestParams - Variable in class org.apache.velocity.tools.view.LinkTool
 
IncludeTool - Class in org.apache.velocity.tools.view
Allows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews.
IncludeTool() - Constructor for class org.apache.velocity.tools.view.IncludeTool
 
info(String) - Method in class org.apache.velocity.tools.generic.LogTool
 
init(ServletConfig) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
Initializes Velocity, the view servlet and checks for changes to the initial layout configuration.
init(JeeConfig) - Method in class org.apache.velocity.tools.view.VelocityView
Initializes ToolboxFactory, VelocityEngine, and sets default encoding for processing requests.
init(JeeConfig, VelocityEngine) - Method in class org.apache.velocity.tools.view.VelocityView
Initializes the Velocity runtime, first calling loadConfiguration(JeeConfig) to get a java.util.Properties of configuration information and then calling velocityEngine.init().
init(FilterConfig) - Method in class org.apache.velocity.tools.view.VelocityViewFilter
Initializes VelocityView used to process requests.
init(ServletConfig) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Initializes servlet and VelocityView used to process requests.
init(ExtProperties) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
This is abstract in the base class, so we need it.
init() - Method in class org.apache.velocity.tools.view.WebappUberspector
init method
initialize(Servlet, ServletRequest, ServletResponse, String, boolean, int, boolean) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
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
initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.view.ImportTool
 
initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.view.JsonTool
Importsupport initialization
initializeImportSupport(ValueParser) - Method in class org.apache.velocity.tools.view.XmlTool
ImportSupport initialization.
initializeView() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
initJSON(String) - Method in class org.apache.velocity.tools.generic.JsonTool
Initialize JSON content from a string.
initJSON(Reader) - Method in class org.apache.velocity.tools.generic.JsonTool
Initialize JSON content from a reader.
initLog() - Method in class org.apache.velocity.tools.ToolManager
init logger
initLogger(ValueParser) - Method in class org.apache.velocity.tools.generic.SafeConfig
Initialize logger.
initRequest(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Request and response initialization.
insecure() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns a new instance with the scheme set to "http".
insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
insert(Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
insert(List) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
insert(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
insert(Object, Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
inspect(String) - Method in class org.apache.velocity.tools.generic.ClassTool
Returns a new ClassTool instance that is inspecting the Class with the specified name.
inspect(Object) - Method in class org.apache.velocity.tools.generic.ClassTool
Returns a new ClassTool instance that is inspecting the Class of the specified Object.
inspect(Class) - Method in class org.apache.velocity.tools.generic.ClassTool
Returns a new ClassTool instance that is inspecting the the specified Class.
inspect(Class) - Method in class org.apache.velocity.tools.generic.FieldTool
Looks for all public, static fields in the specified class and stores their value (if final) or else a FieldTool.MutableField for in a Map under the fields' names.
INSPECT_KEY - Static variable in class org.apache.velocity.tools.generic.ClassTool
 
INSTANCE - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
 
INSTANCE - Static variable in class org.apache.velocity.tools.ConversionUtils
 
INSTANCE - Static variable in class org.apache.velocity.tools.view.ServletUtils
 
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
invoke(Writer) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityJspFragment
 
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
 
isAix() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isAix1() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isAix2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isAix3() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isAix4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isAmiga() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isAndroid() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
 
isBlackberry() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isBlink() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isBSD() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isBsd() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isCached() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
isChrome() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isChrome() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
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
 
isDec() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isDeprecated(AnnotatedElement) - Static method in class org.apache.velocity.tools.generic.ClassTool
Check if an annotation deprecates its class
isDeprecated() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns true if the inspected Class has been deprecated.
isDeprecated() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
Inspected object deprecation status
isDesktop() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isEdgeHTML() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isEmacs() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
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
 
isFirefox() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isFirefox() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isFirst() - Method in class org.apache.velocity.tools.generic.LoopTool
 
isFirst(String) - Method in class org.apache.velocity.tools.generic.LoopTool
 
isFirst() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
isFreebsd() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isGecko() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isGecko() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isHpux() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isHpux10() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isHpux9() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
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
 
isIOS() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isIrix() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isIrix5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isIrix6() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isJsonContentType(String) - Static method in class org.apache.velocity.tools.view.JsonTool
Check if a given content type is of JSON type
isJsonMimeType(String) - Static method in class org.apache.velocity.tools.view.JsonTool
Check if a given mime type is of JSON type
isKHTML() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isKonqueror() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isKonqueror() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isLast() - Method in class org.apache.velocity.tools.generic.LoopTool
 
isLast(String) - Method in class org.apache.velocity.tools.generic.LoopTool
 
isLast() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
isLinks() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isLinks() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isLinux() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isLinux() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isList() - Method in enum org.apache.velocity.tools.config.Data.Type
 
isMac() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isMac68k() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isMacppc() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isMobile() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isMozilla() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isMozilla() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isMpras() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isMSIE() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isMSIE() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isNative() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isNetscape() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isNetscape() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
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.
isOpera() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isOpera() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isOrphan() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
isOs2() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isOSX() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isOSX() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isPathChanged() - Method in class org.apache.velocity.tools.view.LinkTool
 
isPresto() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
isReliant() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isRemoteURL(String) - Static method in class org.apache.velocity.tools.generic.ImportSupport
Returns whether an URL is remote or local
isRobot() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isSafari() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isSafari() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isSafeMode() - Method in class org.apache.velocity.tools.generic.SafeConfig
Returns true if this tool is in "safe mode".
isSco() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isSecure() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns true if this instance's scheme is "https".
isSinix() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isSkipSetters() - Method in class org.apache.velocity.tools.ToolInfo
Get whether setters are to be skipped
isSourceModified(Resource) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
Checks to see if a resource has been deleted, moved or modified.
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
 
isSun() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isSun4() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isSun5() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isSuni86() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isSymbian() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isSyncedWith(String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
isSynchronized() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isTablet() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isTransient() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isTrident() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isTV() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isUnix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isUnixware() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
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.
isVMS() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
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
 
isWebappResource(String) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
isWebKit() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isWindows() - Method in class org.apache.velocity.tools.view.BrowserTool
 
isWindows() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
isX11() - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
isXHTML() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns true if the query delimiter used by this instance is using &amp; 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.
iterator() - Method in class org.apache.velocity.tools.view.BreadcrumbTool
Navigation elements iteration

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.
JeeConfig - Interface in org.apache.velocity.tools.view
Because sometimes you don't care about the difference between a servlet and a filter.
JeeContextConfig - Class in org.apache.velocity.tools.view
Implements JeeConfig with only a ServletContext.
JeeContextConfig(ServletContext) - Constructor for class org.apache.velocity.tools.view.JeeContextConfig
 
JeeFilterConfig - Class in org.apache.velocity.tools.view
Implements JeeConfig with a FilterConfig.
JeeFilterConfig(FilterConfig) - Constructor for class org.apache.velocity.tools.view.JeeFilterConfig
 
JeeServletConfig - Class in org.apache.velocity.tools.view
Implements JeeConfig with a ServletConfig.
JeeServletConfig(ServletConfig) - Constructor for class org.apache.velocity.tools.view.JeeServletConfig
 
JsonContent - Class in org.apache.velocity.tools.generic
Container for *either* an array *or* an object
JsonContent(JsonObject) - Constructor for class org.apache.velocity.tools.generic.JsonContent
wraps an object
JsonContent(JsonArray) - Constructor for class org.apache.velocity.tools.generic.JsonContent
wraps an array
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
 
JsonTool - Class in org.apache.velocity.tools.view
View version of JsonTool.
JsonTool() - Constructor for class org.apache.velocity.tools.view.JsonTool
 
JspToolContext - Class in org.apache.velocity.tools.view.jsp
Velocity context implementation specific to the JSP environment.
JspToolContext(VelocityEngine, PageContext) - Constructor for class org.apache.velocity.tools.view.jsp.JspToolContext
 
JspUtils - Class in org.apache.velocity.tools.view.jsp.jspimpl
Some utilities to work with JSP.
JspUtils() - Constructor for class org.apache.velocity.tools.view.jsp.jspimpl.JspUtils
 
JspWriterImpl - Class in org.apache.velocity.tools.view.jsp.jspimpl
Copied and modified from Tomcat 6.0.x source.
JspWriterImpl(Writer) - Constructor for class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Create a buffered character-output stream that uses a default-sized output buffer.

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_ERROR_CAUSE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The context key that holds the Throwable that broke the rendering of the requested screen.
KEY_ERROR_INVOCATION_EXCEPTION - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The context key that holds the MethodInvocationException that broke the rendering of the requested screen.
KEY_ERROR_STACKTRACE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The context key that holds the stack trace of the error that broke the rendering of the requested screen.
KEY_FORCE_THREAD_SAFE - Static variable in class org.apache.velocity.tools.generic.RenderTool
 
KEY_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The context/parameter key used to specify an alternate layout to be used for a request instead of the default layout.
KEY_PARSE_DEPTH - Static variable in class org.apache.velocity.tools.generic.RenderTool
Deprecated.
KEY_SCREEN_CONTENT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The context key that will hold the content of the screen.
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

layout(Object) - Method in class org.apache.velocity.tools.examples.showcase.tool.LayoutLinkTool
 
layout(String) - Method in class org.apache.velocity.tools.examples.showcase.tool.LayoutLinkTool
 
layoutDir - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
 
LayoutLinkTool - Class in org.apache.velocity.tools.examples.showcase.tool
This is meant to demonstrate how to extend the LinkTool to avoid the manual use of "magic" or common query parameters.
LayoutLinkTool() - Constructor for class org.apache.velocity.tools.examples.showcase.tool.LayoutLinkTool
 
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.
LinkTool - Class in org.apache.velocity.tools.view
The LinkTool provides many methods to work with URIs and can help you: construct full URIs (absolute or relative) encode session ID into a URI retrieve server, port and path info for the current request reconstruct or alter the current request URI and more..
LinkTool() - Constructor for class org.apache.velocity.tools.view.LinkTool
 
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_DELIM_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
LIST_FINAL_DELIM_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
load(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns a FactoryConfiguration loaded from a configuration file at the specified path.
LOAD_DEFAULTS_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Controls loading of available default tool configurations provided by VelocityTools.
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(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
locale(Object) - Method in class org.apache.velocity.tools.generic.ResourceTool
 
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 - Static variable in class org.apache.velocity.tools.view.CookieTool
 
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(Object...) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated.
Make an automatic Alternator from the specifed objects.
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.
makeGroup(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
NOTE: This method may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
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
 
manageResourceNotFound(HttpServletRequest, HttpServletResponse, ResourceNotFoundException) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Manages the ResourceNotFoundException to send an HTTP 404 result when needed.
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
 
mark(int) - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
 
markSupported() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
 
markSupported() - Method in class org.apache.velocity.tools.view.ViewImportSupport.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(Number, double) - Method in class org.apache.velocity.tools.generic.MathTool
 
matchType(Number, Number, double) - Method in class org.apache.velocity.tools.generic.MathTool
 
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).
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, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
max(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
 
maxAge(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
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
 
merge(Template, Context, Writer) - Method in class org.apache.velocity.tools.view.VelocityView
Merges the template with the context.
mergeQueryStrings(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport
Merge original parameters into the query string
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityLayoutServlet
Overrides VelocityViewServlet.mergeTemplate to do a two-pass render for handling layouts
mergeTemplate(Template, Context, HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Merge template
mergeTemplate(Template, Context, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
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, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
min(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, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
mul(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
 
MutableField(Field, Class) - Constructor for class org.apache.velocity.tools.generic.FieldTool.MutableField
 
MySearchTool - Class in org.apache.velocity.tools.examples.showcase.tool
This is meant to demonstrate how to extend the AbstractSearchTool.
MySearchTool() - Constructor for class org.apache.velocity.tools.examples.showcase.tool.MySearchTool
 

N

name(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
NavigationElement(String, String) - Constructor for class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
Constructor
navigationElements - Variable in class org.apache.velocity.tools.view.BreadcrumbTool
Navigation elements for the current URI
NeedsRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.NeedsRule
 
newInstance() - Method in class org.apache.velocity.tools.ToolInfo
Creates a new instance for this tool.
newLine() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Write a line separator.
newLine() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
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(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
number(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("number", $foo).
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

on(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Adds all the files required for the specified group, then returns this instance.
on(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Adds the specified file to this instance's list of dependencies of the specified type, then returns this instance.
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.examples.showcase - package org.apache.velocity.tools.examples.showcase
 
org.apache.velocity.tools.examples.showcase.sample - package org.apache.velocity.tools.examples.showcase.sample
 
org.apache.velocity.tools.examples.showcase.tool - package org.apache.velocity.tools.examples.showcase.tool
 
org.apache.velocity.tools.examples.simple.tool - package org.apache.velocity.tools.examples.simple.tool
 
org.apache.velocity.tools.generic - package org.apache.velocity.tools.generic
Contains a collection of reusable, general-purpose "tools" for Velocity.
org.apache.velocity.tools.view - package org.apache.velocity.tools.view
Contains tools and supporting infrastructure for using those tools in a servlet environment as well as general use classes to support use of Velocity as (or in) the view layer of web applications.
org.apache.velocity.tools.view.jsp - package org.apache.velocity.tools.view.jsp
JSP support of Velocity (and vice-versa).
org.apache.velocity.tools.view.jsp.jspimpl - package org.apache.velocity.tools.view.jsp.jspimpl
Contains JSP-simulating classes that allows the use of a Velocity environment under JSP specific classes, like tags.
orphan() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
OUTPUT_ENCODING_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
The HTTP output encoding.

P

PAGE_CONTEXT_KEY - Static variable in class org.apache.velocity.tools.view.jsp.JspToolContext
 
PagerTool - Class in org.apache.velocity.tools.view
View tool for doing request-based pagination of items in an a list.
PagerTool() - Constructor for class org.apache.velocity.tools.view.PagerTool
 
param(Object, Object) - Method in class org.apache.velocity.tools.generic.LinkTool
Adds a key=value pair to the query data.
ParameterTool - Class in org.apache.velocity.tools.view
Utility class for easy parsing of ServletRequest parameters.
ParameterTool() - Constructor for class org.apache.velocity.tools.view.ParameterTool
Constructs a new instance
ParameterTool(ServletRequest) - Constructor for class org.apache.velocity.tools.view.ParameterTool
Constructs a new instance using the specified request.
params(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
This method can do two different things.
parent(MarkupTool.Tag) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
parent() - 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(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(Reader) - Static method in class org.apache.velocity.tools.XmlUtils
Attempts to parse the input xml into a single element.
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.
parseDate(String, String) - Method in class org.apache.velocity.tools.generic.ConversionTool
parseDate(String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
parseDate(String, String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
parseDate(String, String, Object, TimeZone) - Method in class org.apache.velocity.tools.generic.ConversionTool
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
parseNumber(String, String) - Method in class org.apache.velocity.tools.generic.ConversionTool
parseNumber(String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
parseNumber(String, String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
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
 
parseUserAgent(String, Logger) - Static method in class org.apache.velocity.tools.view.UAParser
 
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(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
PATH_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
 
PATH_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
paths - Variable in class org.apache.velocity.tools.view.WebappResourceLoader
The root paths for templates (relative to webapp's root).
percent(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("percent", $foo).
performMerge(Template, Context, Writer) - Method in class org.apache.velocity.tools.view.VelocityView
This is here so developers may override it and gain access to the Writer which the template will be merged into.
Person - Class in org.apache.velocity.tools.examples.showcase.sample
 
Person(String, String, String) - Constructor for class org.apache.velocity.tools.examples.showcase.sample.Person
 
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
prepareContext(ViewToolContext, HttpServletRequest) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
prepend(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
print(boolean) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a boolean value.
print(char) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a character.
print(int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print an integer.
print(long) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a long integer.
print(float) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a floating-point number.
print(double) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a double-precision floating-point number.
print(char[]) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print an array of characters.
print(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a string.
print(Object) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print an object.
print(boolean) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(char) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(long) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(float) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(double) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(char[]) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print(Object) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
print() - Method in class org.apache.velocity.tools.view.UiDependencyTool
Formats and prints all the current dependencies of this tool, using a new line in between the printed/formatted files.
print(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
If the parameter value is a known type, then this will format and print all of this instance's current dependencies of the specified type, using a new line in between the printed/formatted files.
print(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Formats and prints all of this instance's current dependencies of the specified type, using the specified delimiter in between the printed/formatted files.
printAll(String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Formats and prints all the current dependencies of this tool, using the specified delimiter in between the printed/formatted files.
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.
println() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Terminate the current line by writing the line separator string.
println(boolean) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a boolean value and then terminate the line.
println(char) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a character and then terminate the line.
println(int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print an integer and then terminate the line.
println(long) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a long integer and then terminate the line.
println(float) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a floating-point number and then terminate the line.
println(double) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a double-precision floating-point number and then terminate the line.
println(char[]) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print an array of characters and then terminate the line.
println(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print a String and then terminate the line.
println(Object) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Print an Object and then terminate the line.
println() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(boolean) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(char) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(long) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(float) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(double) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(char[]) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
println(Object) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
PROPERTIES_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
This is the string that is looked for when getInitParameter is called ("org.apache.velocity.properties").
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
 
PROPERTY_DEFAULT_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The velocity.properties key for specifying the servlet's default layout template's filename.
PROPERTY_DYNAMIC_LAYOUT - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The velocity.properties key for specifying whether dynamic layout change is allowed
PROPERTY_ERROR_TEMPLATE - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The velocity.properties key for specifying the servlet's error template.
PROPERTY_LAYOUT_DIR - Static variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
The velocity.properties key for specifying the relative directory holding layout templates.
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.
PUBLISH_TOOLBOXES_PROPERTY - Static variable in class org.apache.velocity.tools.view.ViewToolManager
 
publishApplicationTools() - Method in class org.apache.velocity.tools.view.ViewToolManager
Publish Scope.APPLICATION Toolbox.
publishToolboxes(ServletRequest) - Method in class org.apache.velocity.tools.view.ViewToolManager
Places the Scope.REQUEST Toolbox (if any) into the ServletRequest attributes using Toolbox.KEY as the key.
publishToolboxes(HttpServletRequest) - Method in class org.apache.velocity.tools.view.ViewToolManager
Places the Scope.REQUEST Toolbox (if any) into the HttpServletRequest attributes using Toolbox.KEY as the key, places the Scope.SESSION Toolbox (if any) into the attributes of the HttpSession (if any) then ensures that the Scope.APPLICATION Toolbox (if any) has been placed in the ServletContext attributes.
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<? extends String, ? extends Object>) - Method in class org.apache.velocity.tools.generic.ValueParser
 
putAll(Map) - Method in class org.apache.velocity.tools.ToolContext
 
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
 
putToolProperties() - Method in class org.apache.velocity.tools.view.jsp.JspToolContext
 
putToolProperties() - Method in class org.apache.velocity.tools.view.ViewToolContext
 
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(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(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(URL) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
 
read(String, boolean) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
 
read(URL, 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, boolean, Logger) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
 
read(ExtProperties) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
 
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.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(Object) - Method in class org.apache.velocity.tools.view.ImportTool
Returns the supplied URL rendered as a String.
read(String, boolean) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Reads group info out of the specified file and into this instance.
read() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
 
read(char[]) - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
 
read(char[], int, int) - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
 
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
 
ready() - Method in class org.apache.velocity.tools.view.ViewImportSupport.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
 
release() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
release() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
Release any per-instance resources, releasing any resources or state before this tag instance is disposed.
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() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
This operation is unsupported.
remove(Object) - Method in class org.apache.velocity.tools.generic.ValueParser
 
remove() - Method in class org.apache.velocity.tools.generic.XmlTool.NodeIterator
 
remove(String) - Method in class org.apache.velocity.tools.ToolContext
 
removeAttribute(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
removeAttribute(String, int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
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(Property) - Method in class org.apache.velocity.tools.config.Configuration
 
removeProperty(String) - 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(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
Render tag
render(Object, Object[]) - Method in class org.apache.velocity.tools.generic.ResourceTool
Renders the specified resource value and arguments as a String.
render(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityView
 
render(HttpServletRequest, Writer) - Method in class org.apache.velocity.tools.view.VelocityView
 
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
renderBody(Writer) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
renderContent(Writer) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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
 
repository - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
REQUEST - Static variable in class org.apache.velocity.tools.Scope
 
request - Variable in class org.apache.velocity.tools.view.BreadcrumbTool
Current request
request - Variable in class org.apache.velocity.tools.view.CookieTool
 
request - Variable in class org.apache.velocity.tools.view.LinkTool
 
REQUEST - Static variable in interface org.apache.velocity.tools.view.ViewContext
Key used for the HTTP request object.
request - Variable in class org.apache.velocity.tools.view.ViewContextTool
 
request - Variable in class org.apache.velocity.tools.view.ViewImportSupport
 
requestCleanup(HttpServletRequest, HttpServletResponse, Context) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Cleanup routine called at the end of the request processing sequence allows a derived class to do resource cleanup or other end of process cycle tasks.
reset() - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
 
reset() - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Sets the criteria and results to null, page index to zero, and items per page to the default.
reset() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
Release any per-invocation resources, resetting any resources or state that should be cleared between successive invocations of Tag.doEndTag() and Tag.doStartTag().
reset() - Method in class org.apache.velocity.tools.view.PagerTool
Sets the item list to null, page index to zero, and items per page to the default.
reset() - Method in class org.apache.velocity.tools.view.ViewImportSupport.SafeClosingHttpURLConnectionReader
 
resolve(UiDependencyTool) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
 
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.
response - Variable in class org.apache.velocity.tools.view.CookieTool
 
response - Variable in class org.apache.velocity.tools.view.LinkTool
 
RESPONSE - Static variable in interface org.apache.velocity.tools.view.ViewContext
Key used for the HTTP response object.
response - Variable in class org.apache.velocity.tools.view.ViewImportSupport
 
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
 
SampleListInitializer - Class in org.apache.velocity.tools.examples.showcase.sample
 
SampleListInitializer() - Constructor for class org.apache.velocity.tools.examples.showcase.sample.SampleListInitializer
 
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.
scope - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
SECURE_SCHEME - Static variable in class org.apache.velocity.tools.generic.LinkTool
 
self - Variable in class org.apache.velocity.tools.generic.LinkTool
 
servlet - Variable in class org.apache.velocity.tools.view.JeeServletConfig
 
SERVLET_CONTEXT_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Key used to access the ServletContext in the Velocity application attributes.
SERVLET_CONTEXT_KEY - Static variable in interface org.apache.velocity.tools.view.ViewContext
Key used for the servlet context object in tool properties.
servletContext - Variable in class org.apache.velocity.tools.view.ViewToolManager
 
servletContext - Variable in class org.apache.velocity.tools.view.WebappResourceLoader
 
ServletUtils - Class in org.apache.velocity.tools.view
A set of utility methods for supporting and using VelocityTools in the servlet environment.
ServletUtils() - Constructor for class org.apache.velocity.tools.view.ServletUtils
 
SESSION - Static variable in class org.apache.velocity.tools.Scope
 
session - Variable in class org.apache.velocity.tools.view.PagerTool
 
SESSION - Static variable in interface org.apache.velocity.tools.view.ViewContext
Key used for the HTTP session object.
session - Variable in class org.apache.velocity.tools.view.ViewContextTool
 
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.
setAcceptLanguage(String) - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
setAttribute(String, Object) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
setAttribute(String, Object, int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
SetAttributeExecutor(Logger, Introspector, Class, Object, String) - Constructor for class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
 
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.
setBodyContentKey(String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setBrowser(String, String, String) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
setCache(String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setCatchExceptions(boolean) - Method in class org.apache.velocity.tools.generic.RenderTool
Sets whether or not the render() and eval() methods should catch exceptions during their execution or not.
setCellLength(int) - Method in class org.apache.velocity.tools.generic.DisplayTool
 
setCellSuffix(String) - Method in class org.apache.velocity.tools.generic.DisplayTool
 
setCharacterEncoding(String) - Method in class org.apache.velocity.tools.generic.LinkTool
 
setChildren(Collection<C>) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
setClass(String) - Method in class org.apache.velocity.tools.config.Data
This doesn't take a Class parameter because this class was not created for all-java configuration.
setClass(Class) - Method in class org.apache.velocity.tools.config.ToolConfiguration
Deprecated.
setClass(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
setClass(Class) - Method in class org.apache.velocity.tools.ToolInfo
Set the tool class
setClassname(String) - Method in class org.apache.velocity.tools.config.Data
 
setClassname(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
setContentType(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Sets the content type of the response.
setContentType(String) - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
Has no effect.
setConverter(Class) - Method in class org.apache.velocity.tools.config.Data
 
setConverter(String) - Method in class org.apache.velocity.tools.config.Data
 
setCreateSession(boolean) - Method in class org.apache.velocity.tools.view.PagerTool
 
setCreateSession(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager
Sets whether or not a new HttpSession should be created when there are session scoped tools to be stored in the session, but no session has been created yet.
setCriteria(Object) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Sets the criteria for this search.
setCriteriaKey(String) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
 
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
 
setDefaultContentType(String) - Method in class org.apache.velocity.tools.view.VelocityView
Sets the configured default Content-Type.
setDeviceType(UAParser.DeviceType) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
setEncoding(JeeConfig) - Method in class org.apache.velocity.tools.view.VelocityView
 
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.
setFormat(String, String) - Method in class org.apache.velocity.tools.view.UiDependencyTool
Sets the format string for the specified file type.
setFragment(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
Sets the anchor for this instance and treats empty strings like null.
setFromRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.LinkTool
 
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
setId(String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setIncludeRequestParams(boolean) - Method in class org.apache.velocity.tools.view.LinkTool
Controls whether or not this tool starts off with all parameters from the last request automatically.
setIndex(int) - Method in class org.apache.velocity.tools.view.PagerTool
Sets the index of the first result in the current page
setIndexKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
 
setItems(List) - Method in class org.apache.velocity.tools.view.PagerTool
Sets the List to page through.
setItemsPerPage(int) - Method in class org.apache.velocity.tools.view.PagerTool
Sets the number of items returned in a page of items
setItemsPerPageKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
 
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
setLanguagesFilter(String) - Method in class org.apache.velocity.tools.view.BrowserTool
 
setLatestTag(Context, JspTag) - Static method in class org.apache.velocity.tools.view.jsp.jspimpl.JspUtils
Sets the latest tag encountered.
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.
setLocale(Locale) - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
Has no effect.
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
 
setMessage(String) - Method in class org.apache.velocity.tools.examples.simple.tool.ToyTool
 
setName(String) - Method in class org.apache.velocity.tools.config.Property
 
setName(String) - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
Displayed name setter
setNewItemsKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
 
setNumberFormat(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
use NumberTool format
setOperatingSystem(String, String, String) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
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(String, Object) - Method in class org.apache.velocity.tools.config.Configuration
 
setProperty(Object, String, Object) - Method in class org.apache.velocity.tools.ToolInfo
Set a property on a tool instance
setPropertyClass(Class) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
 
setPropertyMap(Map<String, Object>) - Method in class org.apache.velocity.tools.config.Configuration
 
setPublishToolboxes(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager
Sets whether or not the creation of a new ViewToolContext should make the various scoped Toolbox instances available publically via the HttpServletRequest/HttpSession/ServletContext attributes or simply add the Toolbox instances directly to the context.
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
setRenderingEngine(String, String, String) - Method in class org.apache.velocity.tools.view.UAParser.UserAgent
 
setRepository(StringResourceRepository) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.BreadcrumbTool
Current request setter
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.BrowserTool
Retrieves the User-Agent header from the request (if any).
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.CookieTool
Sets the current HttpServletRequest.
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.PagerTool
Initializes this tool with the specified HttpServletRequest.
setRequest(ServletRequest) - Method in class org.apache.velocity.tools.view.ParameterTool
Sets the current ServletRequest
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.view.ViewImportSupport
Sets the current HttpServletRequest.
setResponse(HttpServletResponse) - Method in class org.apache.velocity.tools.view.CookieTool
Sets the current HttpServletResponse.
setResponse(HttpServletResponse) - Method in class org.apache.velocity.tools.view.ViewImportSupport
Sets the current HttpServletResponse.
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
 
setScope(String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setServletContext(ServletContext) - Method in class org.apache.velocity.tools.view.ViewImportSupport
Sets the ServletContext.
setSkipSetters(Boolean) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
setSkipSetters(boolean) - Method in class org.apache.velocity.tools.ToolInfo
Set whether or not to skip setters.
setSlipSize(int) - Method in class org.apache.velocity.tools.view.PagerTool
Sets the number of result page indices for PagerTool.getSlip() to list.
setSlipSizeKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
 
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
 
setSource(Map) - Method in class org.apache.velocity.tools.view.ParameterTool
Overrides ValueParser.setSource(Map source) to throw an UnsupportedOperationException, because this class uses a servlet request as its source, not a Map.
setStatus(int) - Method in class org.apache.velocity.tools.view.ViewImportSupport.ImportResponseWrapper
Sets the status of the response
setStoredItems(List) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
 
setStoredItems(List) - Method in class org.apache.velocity.tools.view.PagerTool
Stores current search items in the user's session attributes (if one currently exists) in order to do efficient result pagination.
setStoredResults(AbstractSearchTool.StoredResults) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Stores current search results in the user's session attributes (if one currently exists) in order to do efficient result pagination.
setStringsDelimiter(String) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sets the delimiter used for separating values in a single String value.
setStringsDelimiter(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
setStringsDelimiter(String) - Method in class org.apache.velocity.tools.generic.ValueParser
Sets the delimiter used for separating values in a single String value.
setStringsTrim(boolean) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sets whether strings should be trimmed when separated from a delimited string value.
setStringsTrim(boolean) - Method in class org.apache.velocity.tools.generic.ConversionTool
setTab(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
Configuration
setTargetClass(Class) - Method in class org.apache.velocity.tools.config.Data
 
setTemplate(String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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.
setToolboxKey(String) - Method in class org.apache.velocity.tools.view.ViewToolContext
 
setToolboxKey(String) - Method in class org.apache.velocity.tools.view.ViewToolManager
Sets a new attribute key to be used for publishing each Toolbox.
setToolConfigurationClass(Class) - Method in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
 
setTools(Collection<ToolConfiguration>) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
setTruncateAtWord(boolean) - Method in class org.apache.velocity.tools.generic.DisplayTool
 
setTruncateLength(int) - Method in class org.apache.velocity.tools.generic.DisplayTool
 
setTruncateSuffix(String) - Method in class org.apache.velocity.tools.generic.DisplayTool
 
setType(Data.Type) - Method in class org.apache.velocity.tools.config.Data
 
setType(String) - Method in class org.apache.velocity.tools.config.Data
 
setType(Class) - Method in class org.apache.velocity.tools.generic.ClassTool
Set the class to inspect
setup(HttpServletRequest) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Sets the criteria *if* it is set in the request parameters.
setup(HttpServletRequest) - Method in class org.apache.velocity.tools.view.PagerTool
Sets the index, itemsPerPage, and/or slipSize *if* they are set in the request parameters.
setUrl(String) - Method in class org.apache.velocity.tools.view.BreadcrumbTool.NavigationElement
Destination URL setter
setUserAgentString(String) - Method in class org.apache.velocity.tools.view.BrowserTool
Sets the User-Agent string to be parsed for info.
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
 
setVar(String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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.
setVelocityEngine(VelocityEngine) - Method in class org.apache.velocity.tools.view.VelocityView
Overrides super class to ensure engine is not set to null.
setVelocityView(VelocityView) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setVelocityView(VelocityView) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
setViewToolContext(ViewToolContext) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setXHTML(boolean) - Method in class org.apache.velocity.tools.generic.LinkTool
Controls the delimiter used for separating query data pairs.
SHARED_CONFIG_PARAM - Static variable in class org.apache.velocity.tools.view.ServletUtils
 
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
 
ShowcaseLayoutServlet - Class in org.apache.velocity.tools.examples.showcase
 
ShowcaseLayoutServlet() - Constructor for class org.apache.velocity.tools.examples.showcase.ShowcaseLayoutServlet
 
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(long) - Method in class org.apache.velocity.tools.generic.ImportSupport.SafeClosingHttpURLConnectionReader
 
skip(int) - Method in class org.apache.velocity.tools.generic.LoopTool
Skips ahead the specified number of iterations (if possible).
skip(int, String) - Method in class org.apache.velocity.tools.generic.LoopTool
This tells the specified loop to skip ahead the specified number of iterations.
skip(long) - Method in class org.apache.velocity.tools.view.ViewImportSupport.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(Collection<T>, Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts a Collection using a Comparator.
sort(T[], Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts an array using a Comparator.
sort(Map<?, T>, Comparator<T>) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts a Map's values using a Comparator.
sort(Object, Comparator<?>) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts a Collection (or array, or Map's values) using a Comparator.
sort(Collection) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sort a collection
sort(Object[]) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sort an array
sort(Map) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sort map values
sort(Object) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sort a collection, array or map
sort(Object, String) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts the collection on a single property.
sort(Collection, List) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts the collection on several properties.
sort(Map, List) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts map values on several properties.
sort(Object[], List) - Method in class org.apache.velocity.tools.generic.CollectionTool
Sorts array on several properties.
SortTool - Class in org.apache.velocity.tools.generic
Deprecated.
use CollectionTool sort methods
SortTool() - Constructor for class org.apache.velocity.tools.generic.SortTool
Deprecated.
 
SOURCE_FILE_KEY - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
 
space(int) - Method in class org.apache.velocity.tools.generic.DisplayTool
Returns a string of spaces of the specified length.
split(String) - Method in class org.apache.velocity.tools.generic.CollectionTool
 
split(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
 
sql(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Escapes the characters in a String to be suitable to pass to an SQL query.
stop() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Stops this iterator from doing any further iteration.
stop(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Directs this instance to stop iterating immediately prior to any element equal to the specified Object.
stop() - Method in class org.apache.velocity.tools.generic.LoopTool
This tells the current loop to stop after the current iteration.
stop(String) - Method in class org.apache.velocity.tools.generic.LoopTool
This is just like LoopTool.stop() except that the stop command is issued only to the loop/iterator with the specified name.
stopAll() - Method in class org.apache.velocity.tools.generic.LoopTool
This is just like LoopTool.stop() except that the stop command is issued all the loops being watched by this tool.
stopTo(String) - Method in class org.apache.velocity.tools.generic.LoopTool
This is just like LoopTool.stop(String) except that the stop command is issued both to the loop/iterator with the specified name and all loops nested within it.
storage - Variable in class org.apache.velocity.tools.generic.FieldTool
 
store(Object) - Method in class org.apache.velocity.tools.examples.showcase.tool.MySearchTool
Adds the specified item to our static "database".
store(Map) - Method in class org.apache.velocity.tools.examples.showcase.tool.MySearchTool
Adds the entries of the specified map to our static "database".
store(Collection) - Method in class org.apache.velocity.tools.examples.showcase.tool.MySearchTool
Adds the specified items to our static "database".
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.
STORED_ITEMS_KEY - Static variable in class org.apache.velocity.tools.view.PagerTool
the key under which items are stored in session
STORED_RESULTS_KEY - Static variable in class org.apache.velocity.tools.view.AbstractSearchTool
the key under which StoredResults are kept in session
StoredResults(Object, List) - Constructor for class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
Creates a new instance.
storeDynamicLookups - Variable in class org.apache.velocity.tools.generic.FieldTool
 
string(String, Object) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
STRINGS_DELIMITER_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.CollectionTool
 
STRINGS_DELIMITER_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
STRINGS_DELIMITER_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ValueParser
 
STRINGS_TRIM_KEY - Static variable in class org.apache.velocity.tools.generic.CollectionTool
 
stripSession(String) - Static method in class org.apache.velocity.tools.view.ViewImportSupport
Strips a servlet session ID from url.
stripTags(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Removes HTML tags from the string value of the specified object and returns the resulting string.
stripTags(Object, String...) - Method in class org.apache.velocity.tools.generic.DisplayTool
Removes all not allowed HTML tags from the string value of the specified object and returns the resulting string.
Sub() - Constructor for class org.apache.velocity.tools.generic.ClassTool.Sub
 
sub(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
sub(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
 
SugarCookie(Cookie) - Constructor for class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
SugarCookie(String, String) - Constructor for class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
supportsNewInstance() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns true if a call to newInstance() on the Class being inspected is successful; otherwise returns false.
sync(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Adds another iterator to be kept in sync with the one being managed by this instance.
sync(Object, String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Adds another iterator to be kept in sync with the one being managed by this instance.
sync(Object, Object) - Method in class org.apache.velocity.tools.generic.LoopTool
 
SyncedIterator(Iterator) - Constructor for class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
 
SYSTEM_PROPERTY_KEY - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
 

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
 
template - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
templatePaths - Variable in class org.apache.velocity.tools.view.WebappResourceLoader
 
test(Object) - Method in interface org.apache.velocity.tools.generic.LoopTool.Condition
 
test(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.Equals
 
test(String) - Method in class org.apache.velocity.tools.view.BrowserTool
 
test(String) - Method in class org.apache.velocity.tools.view.BrowserToolDeprecatedMethods
Deprecated.
 
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.
 
toBooleans(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toBooleans(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toCalendar(Date, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
 
toCalendar(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
toCalendar(Object) - Method in class org.apache.velocity.tools.generic.DateTool
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.
toCalendars(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toCalendars(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toDate(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
Attempts to convert an unidentified Object into a Date, just short of turning it into a string and parsing it.
toDate(Object, String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts an object to an instance of Date using the specified format, Locale, and TimeZone if the object is not already an instance of Date, Calendar, or Long.
toDate(String, String, Locale, TimeZone) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts an object to an instance of Date using the specified format, Locale, and TimeZone if the object is not already an instance of Date, Calendar, or Long.
toDate(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
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, 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.
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.
toIntegers(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toInts(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toList(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
Convert a singleton or an array as List
toLocale(String) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts a string to a Locale
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
 
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.
toMinutes(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Minutes in the specified number of milliseconds.
toMonths(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Months in the specified number of milliseconds.
toNumber(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
Attempts to convert an unidentified Object into a Number, just short of turning it into a string and parsing it.
toNumber(Object, boolean) - Static method in class org.apache.velocity.tools.ConversionUtils
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(String, String, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts a string to an instance of Number using the specified format and Locale to parse it.
toNumber(Object, String, Locale) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts an object to an instance of Number using the specified format and Locale to parse it, if necessary.
toNumber(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toNumber(Object) - Method in class org.apache.velocity.tools.generic.MathTool
toNumber(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
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(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 Localeif the object is not already an instance of Number.
toNumbers(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
toNumbers(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
 
tool(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
tool(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
tool(String, Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
tool(String, String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
tool(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
tool(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
tool(String, String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
tool(String, Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
toolbox(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
toolbox - Variable in class org.apache.velocity.tools.generic.ContextTool
 
Toolbox - Class in org.apache.velocity.tools
Instances of this class are typically created by a ToolboxFactory on a one-per-scope basis.
Toolbox(Map<String, ToolInfo>) - Constructor for class org.apache.velocity.tools.Toolbox
 
Toolbox(Map<String, ToolInfo>, Map<String, Object>) - Constructor for class org.apache.velocity.tools.Toolbox
 
ToolboxConfiguration - Class in org.apache.velocity.tools.config
This class handles configuration info for the Toolbox instances that will eventually be produced by ToolboxFactory.
ToolboxConfiguration() - Constructor for class org.apache.velocity.tools.config.ToolboxConfiguration
 
toolboxConfigurationClass - Variable in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
 
ToolboxFactory - Class in org.apache.velocity.tools
This class is the central point of action for VelocityTools.
ToolboxFactory() - Constructor for class org.apache.velocity.tools.ToolboxFactory
 
ToolConfiguration - Class in org.apache.velocity.tools.config
This class handles configuration info for tools, including their key, classname, path restriction, and properties.
ToolConfiguration() - Constructor for class org.apache.velocity.tools.config.ToolConfiguration
 
toolConfigurationClass - Variable in class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet
 
ToolContext - Class in org.apache.velocity.tools
Context implementation that keeps a list of 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(VelocityEngine) - Constructor for class org.apache.velocity.tools.ToolContext
Creates an instance that automatically has the specified VelocityEngine and related tool properties set.
ToolContext(Map<String, Object>) - Constructor for class org.apache.velocity.tools.ToolContext
Creates an instance starting with the specified tool properties.
ToolInfo - Class in org.apache.velocity.tools
Manages data needed to create instances of a tool.
ToolInfo(String, Class) - Constructor for class org.apache.velocity.tools.ToolInfo
Creates a new instance using the minimum required info necessary for a tool.
ToolInfo(String, Class, Class) - Constructor for class org.apache.velocity.tools.ToolInfo
Creates a new instance using the minimum required info necessary for a tool.
TOOLKEY_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
ToolManager - Class in org.apache.velocity.tools
Manages tools for non-web applications.
ToolManager() - Constructor for class org.apache.velocity.tools.ToolManager
Constructs an instance already configured to use the default tools and any configuration specified via a "org.apache.velocity.tools" system property.
ToolManager(boolean) - Constructor for class org.apache.velocity.tools.ToolManager
Constructs an instance that may or not include default tools, and already configured with any configuration specified via a "org.apache.velocity.tools" system property.
ToolManager(boolean, boolean) - Constructor for class org.apache.velocity.tools.ToolManager
Constructs an instance that may or not include default tools, and which may or not be already configured with any configuration specified via a "org.apache.velocity.tools" system property.
TOOLS_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Key used to access the toolbox configuration file path from the Servlet or webapp init parameters ("org.apache.velocity.tools") or to access a live FactoryConfiguration previously placed in the ServletContext attributes.
toQuery(Map) - Method in class org.apache.velocity.tools.generic.LinkTool
Converts the map of keys to values into a query string.
toQuery(Object, Object) - Method in class org.apache.velocity.tools.generic.LinkTool
Turns the specified key and value into a properly encoded query pair string.
toScopeInt(String) - Static method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
toSeconds(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Seconds in the specified number of milliseconds.
toString() - Method in class org.apache.velocity.tools.config.Data
 
toString() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
toString(boolean) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
toString() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
toString() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
toString(Object) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts objects to String in a more Tools-ish way than String.valueOf(Object), especially with nulls, Arrays and Collections.
toString(Collection) - Static method in class org.apache.velocity.tools.ConversionUtils
Returns the first value as a String, if any; otherwise returns null.
toString() - Method in class org.apache.velocity.tools.generic.Alternator
Returns a string representation of the current item or null if the current item is null.
toString() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
toString() - Method in class org.apache.velocity.tools.generic.ClassTool
 
toString(long, int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Converts the specified positive duration of milliseconds into larger units up to the specified number of positive units, beginning with the largest positive unit.
toString() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Renders this comparison to a String.
toString(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Deprecated.
Converts objects to String in a more Tools-ish way than String.valueOf(Object), especially with nulls, Arrays and Collections.
toString() - Method in class org.apache.velocity.tools.generic.DateTool
 
toString() - Method in class org.apache.velocity.tools.generic.DisplayTool.Measurements
 
toString() - Method in class org.apache.velocity.tools.generic.FieldTool.FieldToolSub
Return the toString() value of the internal results Map for this sub.
toString() - Method in class org.apache.velocity.tools.generic.JsonContent
Convert JSON object or array into string
toString() - Method in class org.apache.velocity.tools.generic.JsonTool
Convert JSON object or array into string
toString() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the full URI reference that's been built with this tool, including the query string and anchor, e.g.
toString() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
toString() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
toString() - Method in class org.apache.velocity.tools.generic.ResourceTool.Key
 
toString() - Method in class org.apache.velocity.tools.generic.ValueParser
 
toString() - Method in class org.apache.velocity.tools.generic.XmlTool
If this instance has no XML Nodes, then this returns the result of super.toString().
toString() - Method in class org.apache.velocity.tools.view.BreadcrumbTool
Default concatenation of navigation elements, separated by '>'
toString() - Method in class org.apache.velocity.tools.view.BrowserTool
 
toString() - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
toString() - Method in class org.apache.velocity.tools.view.CookieTool
 
toString() - Method in class org.apache.velocity.tools.view.LinkTool
Overrides to use response.encodeURL to get session id into URL if sessions are used but cookies are not supported.
toString() - Method in class org.apache.velocity.tools.view.UiDependencyTool
Returns an empty String to avoid polluting the template output after a successful call to UiDependencyTool.on(String) or UiDependencyTool.on(String,String).
toStrings(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
toURI(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
Turns the specified object into a string and thereby a URI.
toURL(String) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts a string to a URL.
toURL(String, Object) - Static method in class org.apache.velocity.tools.ConversionUtils
Converts a string to a URL.
toWeeks(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Weeks in the specified number of milliseconds.
toYears(long) - Static method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns the number of whole Years in the specified number of milliseconds.
ToyTool - Class in org.apache.velocity.tools.examples.simple.tool
 
ToyTool() - Constructor for class org.apache.velocity.tools.examples.simple.tool.ToyTool
 
trace(String) - Method in class org.apache.velocity.tools.generic.LogTool
 
truncate(Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Limits the string value of 'truncateMe' to the configured max length in characters (default is 30 characters).
truncate(Object, int) - Method in class org.apache.velocity.tools.generic.DisplayTool
Limits the string value of 'truncateMe' to 'maxLength' characters.
truncate(Object, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
Limits the string value of 'truncateMe' to the configured max length in characters (default is 30 characters).
truncate(Object, int, String) - Method in class org.apache.velocity.tools.generic.DisplayTool
Limits the string value of 'truncateMe' to the specified max length in characters.
truncate(Object, int, String, boolean) - Method in class org.apache.velocity.tools.generic.DisplayTool
Limits the string value of 'truncateMe' to the latest complete word within the specified maxLength.
TRUNCATE_AT_WORD_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
TRUNCATE_LENGTH_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
TRUNCATE_SUFFIX_KEY - Static variable in class org.apache.velocity.tools.generic.DisplayTool
 
type(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
type(Data.Type) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
type - Variable in class org.apache.velocity.tools.generic.ClassTool
 
TYPE_ASCENDING_SHORT - Static variable in class org.apache.velocity.tools.generic.CollectionTool.PropertiesComparator
 
TYPE_DESCENDING_SHORT - Static variable in class org.apache.velocity.tools.generic.CollectionTool.PropertiesComparator
 
TypeRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.TypeRule
 
TYPES_KEY_SPACE - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
 

U

UAEntity(String, String, String) - Constructor for class org.apache.velocity.tools.view.UAParser.UAEntity
 
UAEntity(String, String, String, boolean) - Constructor for class org.apache.velocity.tools.view.UAParser.UAEntity
 
UAParser - Class in org.apache.velocity.tools.view
 
UAParser() - Constructor for class org.apache.velocity.tools.view.UAParser
 
UAParser.DeviceType - Enum in org.apache.velocity.tools.view
 
UAParser.UAEntity - Class in org.apache.velocity.tools.view
 
UAParser.UserAgent - Class in org.apache.velocity.tools.view
 
UiDependencyTool - Class in org.apache.velocity.tools.view
NOTE: This tool is considered "beta" quality due to lack of public testing and is not automatically provided via the default tools.xml file.
UiDependencyTool() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool
 
UiDependencyTool.FileRule - Class in org.apache.velocity.tools.view
NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.Group - Class in org.apache.velocity.tools.view
NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.GroupRule - Class in org.apache.velocity.tools.view
NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.NeedsRule - Class in org.apache.velocity.tools.view
NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
UiDependencyTool.TypeRule - Class in org.apache.velocity.tools.view
NOTE: This class may change or disappear w/o warning; don't depend on it unless you're willing to update your code whenever this changes.
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
 
unpublishApplicationTools() - Method in class org.apache.velocity.tools.view.ViewToolManager
Removes any published Scope.APPLICATION Toolbox.
unurl(Object) - Method in class org.apache.velocity.tools.generic.EscapeTool
Unscape the characters in a String encoded as an HTTP parameter value.
updateGlobalProperties() - Method in class org.apache.velocity.tools.view.ViewToolManager
Checks the internal ToolboxFactory for any changes to the createSession or publishToolboxes settings.
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
 
USER_OVERWRITE_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Controls whether or not templates can overwrite tool and servlet API variables in the local context.
USER_PROPERTIES_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
Default velocity properties file path.
USER_TOOLS_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
Default toolbox configuration file path.
UserAgent() - Constructor for class org.apache.velocity.tools.view.UAParser.UserAgent
 

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(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
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.
valueOf(String) - Static method in enum org.apache.velocity.tools.view.UAParser.DeviceType
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
 
values() - Static method in enum org.apache.velocity.tools.view.UAParser.DeviceType
Returns an array containing the constants of this enum type, in the order they are declared.
var - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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}'.
velocity - Variable in class org.apache.velocity.tools.ToolManager
 
VELOCITY_VIEW_KEY - Static variable in class org.apache.velocity.tools.view.ServletUtils
 
VelocityBodyContent - Class in org.apache.velocity.tools.view.jsp.jspimpl
Publishes a block inside a Velocity directive as a BodyContent.
VelocityBodyContent(JspWriter, ASTBlock, InternalContextAdapter) - Constructor for class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
Constructor.
VelocityJspFragment - Class in org.apache.velocity.tools.view.jsp.jspimpl
Exposes a directive body block as a JspFragment, i.e.
VelocityJspFragment(PageContext, ASTBlock, InternalContextAdapter) - Constructor for class org.apache.velocity.tools.view.jsp.jspimpl.VelocityJspFragment
Constructor.
VelocityLayoutServlet - Class in org.apache.velocity.tools.view
Extension of the VelocityViewServlet to perform "two-pass" layout rendering and allow for a customized error screen.
VelocityLayoutServlet() - Constructor for class org.apache.velocity.tools.view.VelocityLayoutServlet
 
VelocityPageContext - Class in org.apache.velocity.tools.view.jsp.jspimpl
Exposes a Velocity Context, a request and a response as a PageContext.
VelocityPageContext(Context, Writer, ViewContext) - Constructor for class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
Constructor.
VelocityToolsJspException - Exception in org.apache.velocity.tools.view.jsp.jspimpl
An exception thrown when something bad happens in JSP support for Velocity.
VelocityToolsJspException() - Constructor for exception org.apache.velocity.tools.view.jsp.jspimpl.VelocityToolsJspException
Constructor.
VelocityToolsJspException(String) - Constructor for exception org.apache.velocity.tools.view.jsp.jspimpl.VelocityToolsJspException
Constructor.
VelocityToolsJspException(Throwable) - Constructor for exception org.apache.velocity.tools.view.jsp.jspimpl.VelocityToolsJspException
Constructor.
VelocityToolsJspException(String, Throwable) - Constructor for exception org.apache.velocity.tools.view.jsp.jspimpl.VelocityToolsJspException
Constructor.
VelocityView - Class in org.apache.velocity.tools.view
The class provides the following features:
VelocityView(ServletConfig) - Constructor for class org.apache.velocity.tools.view.VelocityView
 
VelocityView(FilterConfig) - Constructor for class org.apache.velocity.tools.view.VelocityView
 
VelocityView(ServletContext) - Constructor for class org.apache.velocity.tools.view.VelocityView
 
VelocityView(JeeConfig) - Constructor for class org.apache.velocity.tools.view.VelocityView
 
VelocityViewFilter - Class in org.apache.velocity.tools.view
A filter to ensure VelocityTools Toolboxes are available in the request/session/application scopes.
VelocityViewFilter() - Constructor for class org.apache.velocity.tools.view.VelocityViewFilter
 
VelocityViewServlet - Class in org.apache.velocity.tools.view
A servlet to process Velocity templates.
VelocityViewServlet() - Constructor for class org.apache.velocity.tools.view.VelocityViewServlet
 
VelocityViewTag - Class in org.apache.velocity.tools.view.jsp
This tag enables use of Velocity and VelocityTools within JSP files and tags.
VelocityViewTag() - Constructor for class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
version(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
view - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
VIEW_DEFAULTS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
 
ViewContext - Interface in org.apache.velocity.tools.view
This interface provides view tools in a servlet environment access to relevant context information, like servlet request, servlet context and the velocity context.
ViewContextTool - Class in org.apache.velocity.tools.view
Extension of ContextTool that includes keys and values from the HttpServletRequest, HttpSession and ServletContext.
ViewContextTool() - Constructor for class org.apache.velocity.tools.view.ViewContextTool
 
ViewImportSupport - Class in org.apache.velocity.tools.view
Provides methods to import arbitrary local or remote resources as strings.
ViewImportSupport() - Constructor for class org.apache.velocity.tools.view.ViewImportSupport
 
ViewImportSupport.ImportResponseWrapper - Class in org.apache.velocity.tools.view
Wraps responses to allow us to retrieve results as Strings.
ViewImportSupport.SafeClosingHttpURLConnectionReader - Class in org.apache.velocity.tools.view
 
ViewToolContext - Class in org.apache.velocity.tools.view
ToolContext implementation specific to the servlet environment.
ViewToolContext(VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.ViewToolContext
 
ViewToolManager - Class in org.apache.velocity.tools.view
Manages tools for web applications.
ViewToolManager(ServletContext) - Constructor for class org.apache.velocity.tools.view.ViewToolManager
Constructs an instance already configured to use any configuration specified via a "org.apache.velocity.tools" system property.
ViewToolManager(ServletContext, boolean) - Constructor for class org.apache.velocity.tools.view.ViewToolManager
 
ViewToolManager(ServletContext, boolean, boolean) - Constructor for class org.apache.velocity.tools.view.ViewToolManager
 

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.
WebappResourceLoader - Class in org.apache.velocity.tools.view
Resource loader that uses the ServletContext of a webapp to load Velocity templates.
WebappResourceLoader() - Constructor for class org.apache.velocity.tools.view.WebappResourceLoader
 
WebappUberspector - Class in org.apache.velocity.tools.view
This custom uberspector allows getAttribute() and setAttribute() as standard getters and setters for the "request","session" and "application" keys.
WebappUberspector() - Constructor for class org.apache.velocity.tools.view.WebappUberspector
 
WebappUberspector.GetAttributeExecutor - Class in org.apache.velocity.tools.view
Executor for getAttribute(name) method.
WebappUberspector.SetAttributeExecutor - Class in org.apache.velocity.tools.view
Executor for setAttribute(name,value) method
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.
whine() - Method in class org.apache.velocity.tools.examples.simple.tool.ToyTool
To test exception handling in templates.
wrap(String) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
wrapTag(JspTag) - Static method in class org.apache.velocity.tools.view.jsp.jspimpl.JspUtils
If necessary, wraps a SimpleTag into a Tag.
write(int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Write a single character.
write(char[], int, int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Write a portion of an array of characters.
write(char[]) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Write an array of characters.
write(String, int, int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Write a portion of a String.
write(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.JspWriterImpl
Write a string.
write(char[], int, int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
writeOut(Writer) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 

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 ('&amp;')
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(Node) - Constructor for class org.apache.velocity.tools.generic.XmlTool
Builds an XmlTool around a node.
XmlTool(List<Node>) - Constructor for class org.apache.velocity.tools.generic.XmlTool
Builds an XmlTool around a nodes list.
XmlTool - Class in org.apache.velocity.tools.view
View version of XmlTool.
XmlTool() - Constructor for class org.apache.velocity.tools.view.XmlTool
 
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 

Copyright © 2002–2021 The Apache Software Foundation. All rights reserved.