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.
AbstractLockConfig - Class in org.apache.velocity.tools.generic
Deprecated. Use SafeConfig instead
AbstractLockConfig() - Constructor for class org.apache.velocity.tools.generic.AbstractLockConfig
Deprecated.  
AbstractPagerTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
AbstractPagerTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractPagerTool
Deprecated.  
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 - Class in org.apache.velocity.tools.view.tools
Deprecated. 
AbstractSearchTool() - Constructor for class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated.  
AbstractSearchTool.StoredResults - Class in org.apache.velocity.tools.view
Simple utility class to hold a criterion and its result list.
AbstractSearchTool.StoredResults(Object, List) - Constructor for class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
Creates a new instance.
acquireReader(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
acquireString(String) - Method in class org.apache.velocity.tools.view.ImportSupport
 
action - Variable in class org.apache.velocity.tools.generic.LoopTool.ActionCondition
 
ActionMessagesTool - Class in org.apache.velocity.tools.struts
This tool deals with Struts action messages.
ActionMessagesTool() - Constructor for class org.apache.velocity.tools.struts.ActionMessagesTool
 
actionMsgs - Variable in class org.apache.velocity.tools.struts.ActionMessagesTool
A reference to the queued action messages.
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.
addAllParameters() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.addRequestParams(String...) or LinkTool.addRequestParamsExcept(String...) or LinkTool.addMissingRequestParams(String...)
addAttribute(Attribute) - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Adds an attribute to the supported attributes.
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
 
addData(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. Overrides XMLToolboxManager to put data into appTools map
addData(ToolInfo) - Method in interface org.apache.velocity.tools.view.ToolboxManager
Deprecated. Adds a data object for the context.
addData(ToolInfo) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated.  
addDataRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. Add rules for digesting data elements.
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
 
addIgnore(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.addRequestParams(String...) or LinkTool.addRequestParamsExcept(String...) or LinkTool.addMissingRequestParams(String...)
addMissingRequestParams(String...) - 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
 
addQueryData(String, Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.append(Object,Object)
addQueryData(Map) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.params(Object)
addRequestParams(String...) - 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(String...) - 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.OldXmlFactoryConfigurationRuleSet
Deprecated.  
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).
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Deprecated. Overrides ToolboxRuleSet to add create-session rule.
addRuleInstances(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. 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
 
addTag(Tag) - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Adds a new tag to the contained tag.
addTool(ToolConfiguration) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
addTool(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. Overrides XMLToolboxManager to separate tools by scope.
addTool(ToolInfo) - Method in interface org.apache.velocity.tools.view.ToolboxManager
Deprecated. Adds a tool to be managed
addTool(ToolInfo) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated.  
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
 
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
 
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Deprecated. Overrides ToolboxRuleSet to add rule for scope element.
addToolRules(Digester) - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. Add rules for digesting tool elements.
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
 
allowsRequestPath(String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
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
Simple tool to provide easy in-template instantiation of Alternators from varying "list" types or individual arguments.
AlternatorTool() - Constructor for class org.apache.velocity.tools.generic.AlternatorTool
 
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.
app - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ServletContext
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 - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
application - Variable in class org.apache.velocity.tools.struts.SecureLinkTool
 
application - Variable in class org.apache.velocity.tools.struts.StrutsLinkTool
 
application - Variable in class org.apache.velocity.tools.view.ImportSupport
 
application - Variable in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
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
 
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.
Attribute - Class in org.apache.velocity.tools.plugin.taglib.model
It represents a tag attribute, in a tag library descriptor.
Attribute() - Constructor for class org.apache.velocity.tools.plugin.taglib.model.Attribute
 
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
Make an automatic Alternator from the specified objects.
auto(Collection) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
auto(Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
AUTO_ALTERNATE_DEFAULT_KEY - Static variable in class org.apache.velocity.tools.generic.AlternatorTool
 
AUTO_IGNORE_PARAMETERS_KEY - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
autoConfigure(boolean) - Method in class org.apache.velocity.tools.ToolManager
 
autoConfigure(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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.OldXmlFactoryConfigurationRuleSet.DeprecationRule
Deprecated.  
begin(String, String, Attributes) - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.ParameterRule
Deprecated.  
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.ToolboxRuleSet.ParameterRule
Deprecated.  
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
 
body(String, String, String) - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.BooleanConfigRule
Deprecated.  
body(String, String, String) - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.ScopeRule
Deprecated.  
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.servlet.ServletToolboxRuleSet.BooleanConfigRule
Deprecated.  
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.
BrowserSnifferTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
BrowserSnifferTool() - Constructor for class org.apache.velocity.tools.view.tools.BrowserSnifferTool
Deprecated.  
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
 
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(String) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified resource bundle set.
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
 
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
 
catchExceptions - Variable in class org.apache.velocity.tools.struts.TilesTool
Indicates if there is a MethodExceptionEventHandler present
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
 
ChainedContext - Class in org.apache.velocity.tools.view.context
Deprecated. Use ViewToolContext instead
ChainedContext(VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.context.ChainedContext
Deprecated.  
ChainedContext(Context, VelocityEngine, HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.apache.velocity.tools.view.context.ChainedContext
Deprecated.  
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.CallableSub() - Constructor for class org.apache.velocity.tools.generic.ClassTool.CallableSub
 
ClassTool.ConstructorSub - Class in org.apache.velocity.tools.generic
A simplified wrapping interface for inspecting features of a Constructor in an inspected Class.
ClassTool.ConstructorSub(Constructor) - Constructor for class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
 
ClassTool.FieldSub - Class in org.apache.velocity.tools.generic
A simplified wrapping interface for inspecting features of a Field in an inspected Class.
ClassTool.FieldSub(Field) - Constructor for class org.apache.velocity.tools.generic.ClassTool.FieldSub
 
ClassTool.MethodSub - Class in org.apache.velocity.tools.generic
A simplified wrapping interface for inspecting features of a Method in an inspected Class.
ClassTool.MethodSub(Method) - Constructor for class org.apache.velocity.tools.generic.ClassTool.MethodSub
 
ClassTool.Sub<T extends ClassTool.Sub> - Class in org.apache.velocity.tools.generic
 
ClassTool.Sub() - Constructor for class org.apache.velocity.tools.generic.ClassTool.Sub
 
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
 
clearArgs() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
This will return a new TextKey that has no arguments to be inserted into the text output.
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.view.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
 
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
 
combinePath(String, String) - Method in class org.apache.velocity.tools.generic.LinkTool
If end is null, this will return start and vice versa.
combineQuery(String, String) - Method in class org.apache.velocity.tools.generic.LinkTool
If the second param is null or empty, this will simply return the first and vice versa.
comment(Object) - Method in class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
compare(Object, Object, int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
 
compare - Variable in class org.apache.velocity.tools.generic.LoopTool.Comparison
 
compare(Object, Object) - Method in class org.apache.velocity.tools.generic.SortTool.PropertiesComparator
 
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
 
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
 
ComparisonDateTool.Comparison(long, int, int, boolean, Locale) - Constructor for class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
 
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
 
computeURL(HttpServletRequest, ServletContext, String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Compute a hyperlink URL based on the specified action link.
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(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
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(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
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.LinkTool
 
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) - 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
Looks for the "file" parameter and automatically uses XmlTool.read(String) to parse the file and set the resulting Document as the root node for this instance.
configure(Object, Map<String, Object>) - Method in class org.apache.velocity.tools.OldToolInfo
 
configure(Map) - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Initializes this tool.
configure(ValueParser) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
 
configure(Map) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Initializes this tool.
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(String) - Method in class org.apache.velocity.tools.ToolManager
 
configure(Map) - 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.LinkTool
 
configure(ValueParser) - Method in class org.apache.velocity.tools.view.ParameterTool
 
configure(Map) - Method in class org.apache.velocity.tools.view.tools.ContextTool
Deprecated.  
configure(ValueParser) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated.  
configure(Map) - 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 deprecationSupportMode is true: Config file optionally specified by org.apache.velocity.toolbox init-param (servlet or servletContext) If none, config file optionally at /WEB-INF/toolbox.xml (deprecated conventional location) If no old toolbox or loadDefaults is true, ConfigurationUtils.getDefaultTools() ConfigurationUtils.getAutoLoaded()(false) Config file optionally specified by servletContext org.apache.velocity.tools init-param Config file optionally at /WEB-INF/tools.xml (new 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(FactoryConfiguration) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
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
 
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).
contains(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Checks if a List/array contains a certain element.
containsKey(Object) - Method in class org.apache.velocity.tools.generic.ValueParser
 
containsKey(Object) - 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.struts.ValidatorTool
A reference to the ViewContext
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
 
contextStack - Variable in class org.apache.velocity.tools.struts.TilesTool
A stack to hold ComponentContexts while nested tile-definitions are rendered.
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
 
ContextTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
ContextTool() - Constructor for class org.apache.velocity.tools.view.tools.ContextTool
Deprecated.  
ConversionTool - Class in org.apache.velocity.tools.generic
Utility class for easy conversion of String values to richer types.
ConversionTool() - Constructor for class org.apache.velocity.tools.generic.ConversionTool
 
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 - Class in org.apache.velocity.tools.view.tools
Deprecated. 
CookieTool() - Constructor for class org.apache.velocity.tools.view.tools.CookieTool
Deprecated.  
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.
CookieTool.SugarCookie(Cookie) - Constructor for class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
CookieTool.SugarCookie(String, String) - Constructor for class org.apache.velocity.tools.view.CookieTool.SugarCookie
 
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
 
createActionList(ValidatorResources, Form) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Get List of actions for the given Form.
createContext() - Method in class org.apache.velocity.tools.ToolManager
 
createContext(Map<String, Object>) - Method in class org.apache.velocity.tools.ToolManager
 
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
 
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.
createFactory() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns a new, standard ToolboxFactory configured with the results of both ConfigurationUtils.getAutoLoaded() and ConfigurationUtils.findFromSystemProperty().
createFactory() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
createInfo() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
createMethods(List) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Creates the JavaScript methods list from the given actions.
createToolbox(String) - Method in class org.apache.velocity.tools.ToolboxFactory
 
createToolbox(String) - Method in class org.apache.velocity.tools.ToolManager
 
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
 

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.AutoConverter() - Constructor for class org.apache.velocity.tools.config.Data.AutoConverter
 
Data.FieldConverter - Class in org.apache.velocity.tools.config
 
Data.FieldConverter() - Constructor for class org.apache.velocity.tools.config.Data.FieldConverter
 
Data.NumberConverter - Class in org.apache.velocity.tools.config
 
Data.NumberConverter() - Constructor for class org.apache.velocity.tools.config.Data.NumberConverter
 
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
 
DataInfo - Class in org.apache.velocity.tools.view
Deprecated. Use Data
DataInfo() - Constructor for class org.apache.velocity.tools.view.DataInfo
Deprecated.  
DATE_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.ConversionTool
 
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.config.LogSupport
 
debug(String, Object...) - Method in class org.apache.velocity.tools.generic.LinkTool
 
debug(String, Throwable, Object...) - Method in class org.apache.velocity.tools.generic.LinkTool
 
debug(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "DEBUG" level.
debug(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "DEBUG" level.
debug(String, Object...) - Method in class org.apache.velocity.tools.ToolManager
 
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
 
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_ENCODING - Static variable in class org.apache.velocity.tools.view.ImportSupport
Default character encoding for response.
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_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
Deprecated. 
DEFAULT_FORMAT_KEY - Static variable in class org.apache.velocity.tools.generic.NumberTool
Deprecated. 
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_LOCALE_KEY - Static variable in class org.apache.velocity.tools.generic.DateTool
Deprecated. 
DEFAULT_LOCALE_KEY - Static variable in class org.apache.velocity.tools.generic.NumberTool
Deprecated. 
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
 
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.ConversionTool
 
DEFAULT_STRINGS_TRIM - Static variable in class org.apache.velocity.tools.generic.ConversionTool
 
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_TOOLBOX_PATH - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Deprecated. Default path is now managed by VelocityView
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.
DEPRECATED_TOOLS_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Deprecated. 
DEPRECATED_USER_TOOLS_PATH - Static variable in class org.apache.velocity.tools.view.VelocityView
Deprecated. 
DEPRECATION_SUPPORT_MODE_KEY - Static variable in class org.apache.velocity.tools.view.VelocityView
Controls support for deprecated tools and configuration.
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.
DisplayTool.Measurements(String) - Constructor for class org.apache.velocity.tools.generic.DisplayTool.Measurements
 
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()
doInsert(String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
Use this if there is no nested tile.
doInsert(Map, String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
Use this if there is a nested tile.
doInsert(ComponentContext, String, String, Controller) - Method in class org.apache.velocity.tools.struts.TilesTool
An extension of the other two doInsert functions
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

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.EasyData(Data, Configuration) - Constructor for class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
EasyFactoryConfiguration.EasyWrap<C extends Configuration> - Class in org.apache.velocity.tools.config
 
EasyFactoryConfiguration.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.
encodeURL(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.encode(Object)
end() - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.SetNextDataRule
Deprecated.  
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()
error(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
error(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
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.
errorMarkup(String, HttpServletRequest, HttpSession, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns a formatted error message.
errorMarkup(String, String, HttpServletRequest, HttpSession, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns a formatted error message.
ErrorsTool - Class in org.apache.velocity.tools.struts
This tool deals with Struts error messages.
ErrorsTool() - Constructor for class org.apache.velocity.tools.struts.ErrorsTool
 
errorTemplate - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
 
escapeJavascript(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Backslash-escapes the following characters from the input string: ", ', \, \r, \n.
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
 
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() - Method in class org.apache.velocity.tools.plugin.taglib.Taglib2Directive
 
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.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.
exist() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns true if there are action messages queued, otherwise false.
exist(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns true if there are action messages queued for the specified category of messages, otherwise false.
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.struts.MessageTool
Checks if a message string for a specified message key exists for the user's locale.
exists(String, String) - Method in class org.apache.velocity.tools.struts.MessageTool
Checks if a message string for a specified message key exists for the user's locale.
exists() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Checks for the existence of the key that we've built up.
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.
fatal(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
fatal(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "ERROR" level.
field - Variable in class org.apache.velocity.tools.generic.ClassTool.FieldSub
 
fields - Variable in class org.apache.velocity.tools.generic.ClassTool
 
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.FieldToolSub(Map<String, Object>) - Constructor for class org.apache.velocity.tools.generic.FieldTool.FieldToolSub
 
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.
FieldTool.MutableField(Field, Class, Log) - Constructor for class org.apache.velocity.tools.generic.FieldTool.MutableField
 
FILE_KEY - Static variable in class org.apache.velocity.tools.generic.XmlTool
 
FileFactoryConfiguration - Class in org.apache.velocity.tools.config
Provides support for reading a configuration file from a specified path, This frees the user from having to obtain an InputStream themselves.
FileFactoryConfiguration(Class, String) - Constructor for class org.apache.velocity.tools.config.FileFactoryConfiguration
 
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
 
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
 
findConfig(String) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
findDeclaredMethod(Class, String, Class[]) - Static method in class org.apache.velocity.tools.ClassUtils
 
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).
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.view.VelocityLayoutServlet
Searches for a non-default layout to be used for this request.
findLocalizedResource(String, Locale) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Deprecated. 
findLocalizedResource(String) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Deprecated. 
findLocalizedResource(String, String) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Deprecated. 
findMethod(Class, String, Class[]) - 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
 
FormTool - Class in org.apache.velocity.tools.struts
View tool to work with HTML forms in Struts.
FormTool() - Constructor for class org.apache.velocity.tools.struts.FormTool
 
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(Object, int) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Gets the specified element of a List/array.
get(String) - Method in class org.apache.velocity.tools.generic.LoopTool
This serves two purposes: Getting the current value of a sync'ed iterator Abbreviate syntax for properties of outer loops
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
Returns the parallel value from the specified sync'ed iterator.
get() - Method in class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
Returns the currently parallel value, if any.
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
 
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.struts.ActionMessagesTool
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued of the specified category or null if no messages are queued for the specified category.
get(String, String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as a java.util.List of strings for all action messages queued of the specified category or null if no action messages are queued for the specified category.
get(String) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String, Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, String, Object[], Locale) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String, List) - Method in class org.apache.velocity.tools.struts.MessageTool
Same as MessageTool.get(String key, Object[] args), but takes a java.util.List instead of an array.
get(String, String, List) - Method in class org.apache.velocity.tools.struts.MessageTool
Same as MessageTool.get(String key, Object[] args), but takes a java.util.List instead of an array.
get(String, String, List, Locale) - Method in class org.apache.velocity.tools.struts.MessageTool
Looks up and returns the localized message for the specified key.
get(String) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Appends a period and the new key to the current key and returns a new TextKey instance with the combined result as its key.
get(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
This exists to enable a simplified syntax for using this tool in a template.
get(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
A generic tiles insert function.
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
 
getActionForm(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the ActionForm bean associated with this request of null if none exists.
getActionFormName(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the ActionForm name associated with this request of null if none exists.
getActionMappingName(String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Return the form action converted into an action mapping path.
getActionMappingURL(ServletContext, HttpServletRequest, String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the form action converted into a server-relative URI reference.
getActionMessages() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
 
getActionMessages() - Method in class org.apache.velocity.tools.struts.ErrorsTool
 
getAix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix1() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAix4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAll() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued or null if no messages are queued.
getAll(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns a List of all queued action messages using the specified message resource bundle.
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
Returns the map of all parameters available for the current request.
getAllowedTags() - Method in class org.apache.velocity.tools.generic.DisplayTool
 
getAllowSubkeys() - Method in class org.apache.velocity.tools.generic.ValueParser
Are subkeys allowed ?
getAltavista() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAmaya() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAmiga() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
getAol() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAol6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAolTV() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
getApplicationClass(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Return the Class object for the specified fully qualified class name, from this web application's class loader.
getApplicationToolbox() - Method in class org.apache.velocity.tools.ToolManager
 
getAttribute(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Fetches a named attribute-value from the current tiles-context.
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.
getAttributeNamesInScope(int) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getAttributes() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Returns the contained attributes.
getAttributesScope(String) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getAudrey() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getAutoAlternateDefault() - Method in class org.apache.velocity.tools.generic.AlternatorTool
Returns true if the default for auto-alternating is true.
getAutoLoaded() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns a FactoryConfiguration including all ConfigurationUtils.getDefaultTools() as well as any tools that can be automatically loaded from "tools.xml" or "tools.properties" found at the root of the classpath or in the current directory.
getAutoLoaded(boolean) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns a FactoryConfiguration composed, in order of the following configurations: ConfigurationUtils.getDefaultTools() (only if includeDefaults is true) All "tools.xml" configurations found in the classpath root, in the order found All "tools.properties" configurations found in the classpath root, in the order found The "tools.xml" file in the current directory (if any) The "tools.properties" file in the current directory (if any) If the includeDefaults parameter is null and no such files described above can be found, then the configuration returned by this method will be empty, but it should never be null.
getAvantgo() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
getBean() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the form bean associated with this action mapping.
getBlackberry() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getBodyContent() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Returns the body content of the tag.
getBodyContentKey() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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
 
getBsd() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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().
getCancelName() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped.
getCatchExceptions() - Method in class org.apache.velocity.tools.generic.RenderTool
Returns true if this render() and eval() methods will catch exceptions thrown during rendering.
getCdata() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the cdata setting "true" or "false".
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
 
getChrome() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
 
getClassname() - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
getClassname() - Method in interface org.apache.velocity.tools.view.ToolInfo
Deprecated.  
getClassname() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
getComparable(Object, String) - Static method in class org.apache.velocity.tools.generic.SortTool
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, ServletContext, boolean) - 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
 
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.view.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
Returns the number of elements returned by LoopTool.ManagedIterator.next() so far.
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.BrowserTool
 
getCss1() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getCss2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getCurl() - 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.
getCurrentContext() - Method in class org.apache.velocity.tools.struts.TilesTool
Retrieve the current tiles component context.
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
 
getData(Data) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
getData() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
 
getData() - Method in class org.apache.velocity.tools.ToolboxFactory
 
getDataInfoClass() - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. Return the bean class to be created for data elements.
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
 
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.
getDateFormat(int, int, Locale, TimeZone) - Method in class org.apache.velocity.tools.generic.DateTool
Deprecated. 
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
Returns the day (of the month) value of the date returned by DateTool.getCalendar().
getDay(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the day (of the month) value for the specified date.
getDays() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of days between the dates being compared.
getDec() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
Returns the configured default Content-Type.
getDefaultKey() - Method in class org.apache.velocity.tools.config.ToolConfiguration
Returns the default key value for the set tool class.
getDefaultLocale() - Method in class org.apache.velocity.tools.generic.ResourceTool
Deprecated. 
getDefaultTools() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns the "default" FactoryConfiguration.
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
 
getDeprecatedConfig(JeeConfig) - Method in class org.apache.velocity.tools.view.VelocityView
Deprecated. 
getDepth() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the number of loops currently on the stack.
getDescription() - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Returns the description of the attribute.
getDescription() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Returns the description of the tag.
getDescription() - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Returns the description.
getDifference() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets this comparison to be rendered as a ComparisonDateTool.difference(java.lang.Object, java.lang.Object).
getDillo() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.BrowserTool
 
getDom1() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getDom2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getDotnet() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
 
getDynamicJavascript() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render just the dynamic JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists).
getDynamicJavascript(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render just the dynamic JavaScript to perform validations based on the supplied form name.
getDynamicJavascript(ValidatorResources, Locale, Form) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Generates the dynamic JavaScript for the form.
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
 
getEmacs() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getEnabledLevel() - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated. Returns the current minimum level at which messages will be printed.
getEpiphany() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getErrors(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the Struts errors for this request or null if none exist.
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
 
getExists() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Convenience method to allow $text.key.exists syntax.
getExpressionEvaluator() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
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
 
getFieldValue(Class, String) - Static method in class org.apache.velocity.tools.ClassUtils
 
getFile() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns the last section of the path, which is all that follows the final "/".
getFilterConfig() - Method in class org.apache.velocity.tools.view.VelocityViewFilter
 
getFirefox() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getFirst() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the result of LoopTool.isFirst().
getFirst() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Returns the result of LoopTool.ManagedIterator.isFirst().
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.
getForwardURL(HttpServletRequest, ServletContext, String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the action forward name converted into a server-relative URI reference.
getFreebsd() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getFromCache(String, String) - Method in class org.apache.velocity.tools.Toolbox
 
getFromClass(String) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
 
getFromClass(Class) - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
 
getFromInfo(String, String, Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
getFull() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
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.
getGaleon() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGecko() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGeckoMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGeckoMinorVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGeckoVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGenericTools() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns a FactoryConfiguration including all default "GenericTools" available and no others.
getGetright() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getGlobal() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
This a convenience method and the equivalent of $messages.get($messages.globalName).
getGlobalName() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the default "GLOBAL" category name that can be used for messages that are not associated with a particular property.
getGlobalProperty(String) - Method in class org.apache.velocity.tools.ToolboxFactory
 
getGoogle() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
Returns the result of LoopTool.ManagedIterator.hasNext().
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.
getHotjava() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHotjava3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHotjava3up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHours() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of hours between the dates being compared.
getHpux() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHpux10() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHpux9() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getHtmlComment() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets whether or not to delimit the JavaScript with html comments.
getHttpclient() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIcab() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIceweasel() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe4up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe55() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe55up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe5up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe6up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe7() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe7up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe8() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIe8up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
Returns the 0-based index of the current item.
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
 
getInfoseek() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getInit() - Method in class org.apache.velocity.tools.OldToolInfo
 
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() - Method in class org.apache.velocity.tools.ClassUtils
 
getInstance(String) - Static method in class org.apache.velocity.tools.ClassUtils
 
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.struts.StrutsUtils
 
getInstance(Object) - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated. Returns the data.
getInstance(ServletContext, String) - Static method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. ServletToolboxManager factory method.
getInstance() - Method in class org.apache.velocity.tools.view.ServletUtils
 
getInstance(Object) - Method in interface org.apache.velocity.tools.view.ToolInfo
Deprecated. Returns an instance of the tool.
getInstance(Object) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Returns a new instance of the tool.
getInt(String, int) - Method in class org.apache.velocity.tools.generic.ValueParser
 
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
 
getIopener() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIrix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIrix5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getIrix6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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) - Static 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.
getJava() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.struts.ValidatorTool
Render both dynamic and static JavaScript to perform validations based on the form name attribute of the action mapping associated with the current request (if such exists).
getJavascript(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render both dynamic and static JavaScript to perform validations based on the supplied form name.
getJavascript(String, boolean) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render both dynamic and static JavaScript to perform validations based on the supplied form name.
getJavascript() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getJavascriptBegin(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the opening script element and some initial javascript.
getJavascriptEnd() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Returns the closing script element.
getJavascriptStaticMethods(ValidatorResources) - Method in class org.apache.velocity.tools.struts.ValidatorTool
 
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
Accessors
getKey() - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated. Accessors
getKey() - Method in interface org.apache.velocity.tools.view.ToolInfo
Deprecated.  
getKey() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Accessors
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
 
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
 
getKmeleon() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getKonqueror() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLanguagesFilter() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLast() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns the result of LoopTool.isLast().
getLast() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Returns the result of LoopTool.ManagedIterator.isLast().
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.
getLinkexchange() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLinks() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLinux() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
 
getLobo() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
 
getLocale() - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Retrieves the Locale for this request.
getLocale(HttpServletRequest, HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the java.util.Locale for the user.
getLocales(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getLog() - Method in class org.apache.velocity.tools.config.LogSupport
 
getLog() - Method in class org.apache.velocity.tools.ToolManager
 
getLog() - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
getLogId() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getLotusnotes() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLwp() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLycos() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getLynx() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMac() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMac68k() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMacosx() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMacppc() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMajorVersion() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMessageResources(HttpServletRequest, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the message resources for this application or null if not found.
getMessageResources(HttpServletRequest, ServletContext, String) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the message resources with the specified bundle name for this application or null if not found.
getMessages(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the Struts messages for this request or null if none exist.
getMethod() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets the method name that will be used for the Javascript validation method name if it has a value.
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.BrowserTool
 
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
Returns the month value of the date returned by DateTool.getCalendar().
getMonth(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the month value of the specified date.
getMonths() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the approximate number of months between the dates being compared.
getMosaic() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMozilla() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMpras() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getMsgs() - Method in class org.apache.velocity.tools.struts.ErrorsTool
Renders the queued error messages as a list.
getMsgs(String) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Renders the queued error messages of a particual category as a list.
getMsgs(String, String) - Method in class org.apache.velocity.tools.struts.ErrorsTool
Renders the queued error messages of a particual category as a list.
getMutex(HttpSession) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. Returns a mutex (lock object) unique to the specified session to allow for reliable synchronization on the session.
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.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
Returns the name of this instance.
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.plugin.taglib.model.Attribute
Returns the name of the attribute.
getName() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Returns the name of the tag.
getName() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the form bean name associated with this action mapping.
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.
getNav2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav45() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav45up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav4up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNav6up() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNavgold() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNeoplanet() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNeoplanet2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getNetscape() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
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
 
getNumberFormat(String, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Returns a NumberFormat instance for the specified format and Locale.
getNumberFormat(int, Locale) - Method in class org.apache.velocity.tools.generic.NumberTool
Deprecated. 
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.
getOpera() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera3() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera6() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera7() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera8() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOpera9() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOs2() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getOut() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getOutputStream() - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
 
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.struts.ValidatorTool
Gets the current page number of a multi-part form.
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.
getPalm() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
 
getParameters() - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Get parameters for this tool.
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
 
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
 
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.
getQueryData() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.getQuery()
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?
getReflectedTagClass() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Returns the reflected tag class.
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.
getReliant() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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
 
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
Returns the instance of HttpServletRequest for this request.
getRequest() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current servlet request.
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.
getRequestPath() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
getRequestToolbox() - Method in class org.apache.velocity.tools.ToolManager
 
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.
getResources(String, Object) - Static method in class org.apache.velocity.tools.ClassUtils
Load all resources with the specified name.
getResources(String) - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Retrieves the specified MessageResources bundle, or the application's default MessageResources if no bundle is specified.
getResourceStream(String) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
Get an InputStream so that the Runtime can build a template with it.
getResponse() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getResponse() - Method in interface org.apache.velocity.tools.view.ViewContext
Returns the instance of HttpServletResponse for this request.
getResponse() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current servlet response.
getRestrictTo() - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated. Use PagerTool.getItems().
getReturns() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
 
getRobot() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
getRuleSet() - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
getRuleSet() - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated. 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 (').
getSafari() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getScheme() - Method in class org.apache.velocity.tools.generic.LinkTool
Return the scheme value for this instance.
getSco() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getScooter() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getScope() - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
getScope() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getScope() - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
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
Returns the instance of ServletContext for this request.
getServletContext() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the servlet context.
getSession() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
getSession() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns the current session, if any.
getSessionToolbox() - Method in class org.apache.velocity.tools.view.ViewToolManager
 
getSetterName() - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Returns the name of the setter method.
getShortName() - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Returns the short name of the taglib.
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
 
getSingleQuote() - Method in class org.apache.velocity.tools.generic.EscapeTool
Renders a single quotation mark (').
getSinix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getSize() - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the number of action messages queued.
getSize(String) - Method in class org.apache.velocity.tools.struts.ActionMessagesTool
Returns the number of action messages queued for a particular property.
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
 
getSlurp() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getSource() - Method in exception org.apache.velocity.tools.config.ConfigurationException
 
getSource() - Method in class org.apache.velocity.tools.config.FactoryConfiguration
Returns the original source of this particular instance.
getSource() - Method in class org.apache.velocity.tools.generic.ValueParser
 
getSource() - 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.
getSrc() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Gets the src attribute's value when defining the html script element.
getStaroffice() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getStaticJavascript() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Render just the static JavaScript methods.
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.ImportSupport.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.ImportSupport.ImportResponseWrapper
Retrieves the buffered output, using the containing tag's 'charEncoding' attribute, or the tag's default encoding, if necessary.
getString() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityBodyContent
 
getStrings(String) - Method in class org.apache.velocity.tools.generic.ValueParser
 
getStringsDelimiter() - Method in class org.apache.velocity.tools.generic.ConversionTool
 
getStringsTrim() - Method in class org.apache.velocity.tools.generic.ConversionTool
 
getStyleAsInt(String) - Method in class org.apache.velocity.tools.generic.DateTool
Deprecated. 
getStyleAsInt(String) - Method in class org.apache.velocity.tools.generic.NumberTool
Deprecated. 
getSubkey(String) - Method in class org.apache.velocity.tools.generic.ValueParser
subkey getter that returns a map -> value for every "subkey.subkey2" found entry
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
 
getSun() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getSun4() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getSun5() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getSuni86() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getSuper() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns a new ClassTool instance that is inspecting the superclass of the Class being inspected by this instance.
getSystemCalendar() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getSystemDate() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getSystemTime() - Static method in class org.apache.velocity.tools.generic.DateTool
 
getTab() - Method in class org.apache.velocity.tools.generic.MarkupTool
 
getTag() - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Returns the tag that contains this attribute.
getTagClass() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Returns the class of the tag.
getTags() - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Returns the tags of this taglib.
getTarget() - Method in enum org.apache.velocity.tools.config.Data.Type
 
getTarget() - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
 
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(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityView
Deprecated. Use VelocityView.getTemplate(HttpServletRequest).
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
 
getTemplate(String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
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.
getTlibVersion() - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Returns the taglib version.
getToken() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the transaction control token for this session or null if no token exists.
getToken(HttpSession) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the transaction token stored in this session or null if not used.
getTokenName() - Method in class org.apache.velocity.tools.struts.FormTool
Returns the query parameter name under which a transaction token must be reported.
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.
getToolbox() - Method in class org.apache.velocity.tools.view.context.ChainedContext
Deprecated. Returns the tools for this context
getToolbox(Object) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. Overrides XMLToolboxManager to handle the separate scopes.
getToolbox(Object) - Method in interface org.apache.velocity.tools.view.ToolboxManager
Deprecated. Retrieves a map of the tools and data being managed.
getToolbox(Object) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated.  
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
 
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
 
getToolInfoClass() - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Deprecated. Overrides ToolboxRuleSet to use ServletToolInfo class.
getToolInfoClass() - Method in class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated. Return the bean class to be created for tool elements.
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.
getType() - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Returns the type of the attribute.
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
 
getUnix() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getUnixware() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
getUri() - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Returns the URI of the taglib.
getURI() - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.getPath()
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.BrowserTool
 
getUserCanOverwriteTools() - Method in class org.apache.velocity.tools.ToolContext
Default is true.
getUserCanOverwriteTools() - Method in class org.apache.velocity.tools.ToolManager
 
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
Return the specified value of the date returned by DateTool.getCalendar() or null if the field is invalid.
getValue(Object, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified value of the specified date, or null if the field or date is invalid.
getValue(int, Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the specified value of the specified date, or null if the field or date is invalid.
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
 
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
Returns a reference to the current Velocity context.
getVelocityContext() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns a reference to the Velocity context (this object).
getVelocityEngine() - Method in class org.apache.velocity.tools.ToolManager
 
getVelocityEngine() - Method in interface org.apache.velocity.tools.view.ViewContext
Returns the current VelocityEngine instance.
getVelocityEngine() - Method in class org.apache.velocity.tools.view.ViewToolContext
Returns a reference to the VelocityEngine.
getVelocityLog() - Static method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Allow subclasses to statically access the static target.
getVelocityProperty(String, String) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
getVelocityStruts() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns a FactoryConfiguration including all default "VelocityStruts" tools available as well as the default "VelocityView" tools and "GenericTools".
getVelocityView() - Static method in class org.apache.velocity.tools.config.ConfigurationUtils
Returns a FactoryConfiguration including all default "VelocityView" tools available as well as the default "GenericTools".
getVelocityView() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getVelocityView() - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Deprecated. Overrides parent to ensure each VVS instance has it's own separate configuration, just like in Tools 1.x.
getVelocityView() - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Deprecated. Overrides parent to ensure each VVS instance has it's own separate configuration, just like in Tools 1.x.
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.BrowserTool
 
getViewToolContext() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
getVista() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getVMS() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getW3m() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWap() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWebcrawler() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWebTV() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWeeks() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the number of weeks between the dates being compared.
getWget() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWidth() - Method in class org.apache.velocity.tools.generic.DisplayTool.Measurements
 
getWin16() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWin2k() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWin31() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWin32() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWin3x() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWin95() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWin98() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWindows() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWinme() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWinnt() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWinxp() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getWrappedType() - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Returns the type that should be used in the Velocity directive for this attribute.
getWriter() - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
 
getWriter() - Method in class org.apache.velocity.tools.view.jsp.jspimpl.ExternalWriterHttpServletResponse
getX11() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getYahoo() - Method in class org.apache.velocity.tools.view.BrowserTool
 
getYear() - Method in class org.apache.velocity.tools.generic.DateTool
Returns the year value of the date returned by DateTool.getCalendar().
getYear(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Returns the year value of the specified date.
getYears() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Return the approximate number of years between the dates being compared.
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
 
hasBody() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
It tells if this tag has a body.
hasChildren() - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
hasConfigure() - Method in class org.apache.velocity.tools.ToolInfo
 
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.
hasMore() - Method in class org.apache.velocity.tools.generic.IteratorTool
Deprecated. Returns true if there are more elements in the wrapped list.
hasNext() - Method in class org.apache.velocity.tools.generic.IteratorTool
Deprecated. Returns true if there are more elements in the list and more() was called.
hasNext() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Returns true if there are more elements in the iterator being managed by this instance which satisfy all the LoopTool.ActionConditions set for this instance.
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
 
hasResults() - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated. Use PagerTool.hasItems()
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
 
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.
importAttribute(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Imports the named attribute-value from the current tiles-context into the current Velocity context.
importAttribute(String, String) - Method in class org.apache.velocity.tools.struts.TilesTool
Imports the named attribute-value from the current tiles-context into the named context ("page", "request", "session", or "application").
importAttributes() - Method in class org.apache.velocity.tools.struts.TilesTool
Imports all attributes in the current tiles-context into the current velocity-context.
importAttributes(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Imports all attributes in the current tiles-context into the named context ("page", "request", "session", or "application").
ImportSupport - Class in org.apache.velocity.tools.view
Provides methods to import arbitrary local or remote resources as strings.
ImportSupport() - Constructor for class org.apache.velocity.tools.view.ImportSupport
 
ImportSupport.ImportResponseWrapper - Class in org.apache.velocity.tools.view
Wraps responses to allow us to retrieve results as Strings.
ImportSupport.ImportResponseWrapper(HttpServletResponse) - Constructor for class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
Constructs a new ImportResponseWrapper.
ImportSupport.SafeClosingHttpURLConnectionReader - Class in org.apache.velocity.tools.view
 
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
 
ImportTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
ImportTool() - Constructor for class org.apache.velocity.tools.view.tools.ImportTool
Deprecated.  
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(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "INFO" level.
info(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "INFO" level.
init(Object) - Method in class org.apache.velocity.tools.struts.FormTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.struts.MessageResourcesTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.i18n.MultiViewsTool
Deprecated. 
init(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Deprecated.  
init(ServletConfig) - Method in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Deprecated.  
init(ExtendedProperties) - Method in class org.apache.velocity.tools.view.servlet.WebappLoader
Deprecated.  
init(RuntimeServices) - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated. init()
init(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractPagerTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.AbstractSearchTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.BrowserSnifferTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.ContextTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.CookieTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.ImportTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.ParameterParser
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.ViewRenderTool
Deprecated. 
init(Object) - Method in class org.apache.velocity.tools.view.tools.ViewResourceTool
Deprecated. 
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 org.apache.commons.collections.ExtendedProperties 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(ExtendedProperties) - 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
INIT_METHOD_NAME - Static variable in class org.apache.velocity.tools.OldToolInfo
 
initialize(Servlet, ServletRequest, ServletResponse, String, boolean, int, boolean) - Method in class org.apache.velocity.tools.view.jsp.jspimpl.VelocityPageContext
 
initializeView() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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
 
insert(Object) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified argument to be inserted into the text output.
insert(Object, Object) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified arguments to be inserted into the text output.
insert(Object, Object, Object) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified arguments to be inserted into the text output.
insert(List) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified List of arguments to be inserted into the text output.
insert(Object[]) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified array of arguments to be inserted into the text output.
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.ClassUtils
 
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.struts.StrutsUtils
 
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
 
internalGet(String) - Method in class org.apache.velocity.tools.view.context.ChainedContext
Deprecated.  
internalRecurse(Context, String, int) - Method in class org.apache.velocity.tools.generic.RenderTool
 
internalSort(List, List) - Method in class org.apache.velocity.tools.generic.SortTool
 
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(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.
isAbsoluteUrl(String) - Static method in class org.apache.velocity.tools.view.ImportSupport
Returns true if our current URL is absolute, false otherwise.
isAbstract() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns true if the inspected Class is declared abstract.
isAbstract() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isArray(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Checks if an object is an array.
isAuto() - Method in class org.apache.velocity.tools.generic.Alternator
 
isCached() - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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
 
isDebugEnabled() - Method in class org.apache.velocity.tools.config.LogSupport
 
isDebugEnabled() - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Returns true if Velocity's LogChute returns true for isDebugEnabled().
isDeprecated(AnnotatedElement) - Static method in class org.apache.velocity.tools.generic.ClassTool
 
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
 
isEmpty(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Checks if a List/array is empty.
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.
isErrorEnabled() - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Returns true if Velocity's LogChute returns true for isErrorEnabled().
isFatalEnabled() - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Returns true if isErrorEnabled() returns true, since Velocity's LogChute doesn't support this level.
isFinal() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns true if the inspected Class is declared final.
isFinal() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isFirst() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns true if the current loop is on its first iteration.
isFirst(String) - Method in class org.apache.velocity.tools.generic.LoopTool
Returns true if the loop with the specified name is on its first iteration.
isFirst() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Returns true if either 0 or 1 elements have been returned by LoopTool.ManagedIterator.next().
isInfoEnabled() - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Returns true if Velocity's LogChute returns true for isInfoEnabled().
isInterface() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns true if the inspected Class is an interface.
isInterface() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isLast() - Method in class org.apache.velocity.tools.generic.LoopTool
Returns true if the current loop is on its last iteration.
isLast(String) - Method in class org.apache.velocity.tools.generic.LoopTool
Returns true if the loop with the specified name is on its last iteration.
isLast() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Returns true if the last element returned by LoopTool.ManagedIterator.next() is the last element available in the iterator being managed which satisfies any/all LoopTool.ActionConditions set for this instance.
isLevelEnabled(int) - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated. This will return true if the specified level is equal to or higher than the level this LogChute is enabled for.
isList() - Method in enum org.apache.velocity.tools.config.Data.Type
 
isList(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Checks if an object is a List.
isNative() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isOpaque() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns true if this instance represents an opaque URI.
isOrphan() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
isPathChanged() - Method in class org.apache.velocity.tools.view.LinkTool
 
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.
isRequired() - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Returns true if the attribute is required.
isRtexprvalue() - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Returns true if the attribute accepts runtime expression.
isSafeMode() - Method in class org.apache.velocity.tools.generic.SafeConfig
Returns true if this tool is in "safe mode".
isSecure() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns true if this instance's scheme is "https".
isSimpleTag() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
It tells if this tag implements SimpleTag.
isSkipSetters() - Method in class org.apache.velocity.tools.ToolInfo
 
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
 
isSyncedWith(String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Returns true if this ManagedIterator has a sync'ed iterator with the specified name.
isSynchronized() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isTraceEnabled() - Method in class org.apache.velocity.tools.config.LogSupport
 
isTraceEnabled() - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Returns true if Velocity's LogChute returns true for isTraceEnabled().
isTransient() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isVarArgs() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
 
isVarArgs() - Method in class org.apache.velocity.tools.generic.ClassTool.ConstructorSub
Returns true if the final parameter for the constructor was declared as a vararg.
isVarArgs() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
Returns true if the final parameter for the method was declared as a vararg.
isVoid() - Method in class org.apache.velocity.tools.generic.ClassTool.MethodSub
Returns true if the return type of this method is void.
isVolatile() - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
isWarnEnabled() - Method in class org.apache.velocity.tools.config.LogSupport
 
isWarnEnabled() - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Returns true if Velocity's LogChute returns true for isWarnEnabled().
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 &.
iterator() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns an XmlTool.NodeIterator that returns new XmlTool instances for each Node held internally by this instance.
IteratorTool - Class in org.apache.velocity.tools.generic
Deprecated. Use LoopTool instead
IteratorTool() - Constructor for class org.apache.velocity.tools.generic.IteratorTool
Deprecated. Create a IteratorTool instance to use as tool.
IteratorTool(Object) - Constructor for class org.apache.velocity.tools.generic.IteratorTool
Deprecated. Create a IteratorTool instance to use in #foreach.

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
 
jsFormName - Variable in class org.apache.velocity.tools.struts.ValidatorTool
formName is used for both Javascript and non-javascript validations.
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 - 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.
keySet() - Method in class org.apache.velocity.tools.generic.ValueParser
 
keySet() - Method in class org.apache.velocity.tools.ToolContext
 

L

layoutDir - Variable in class org.apache.velocity.tools.view.VelocityLayoutServlet
 
LinkTool - Class in org.apache.velocity.tools.generic
The LinkTool provides many methods to work with URIs and can help you: construct full URIs (opaque, absolute or relative) encode and decode URLs (part or whole) retrieve path info for the current request and more..
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
 
LinkTool - Class in org.apache.velocity.tools.view.tools
Deprecated. Use LinkTool
LinkTool() - Constructor for class org.apache.velocity.tools.view.tools.LinkTool
Deprecated.  
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
 
ListTool - Class in org.apache.velocity.tools.generic
Deprecated. 
ListTool() - Constructor for class org.apache.velocity.tools.generic.ListTool
Deprecated.  
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(String) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated. Reads an XML document from the specified file path and sets up the toolbox from that.
load(InputStream) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated. Reads an XML document from an InputStream and sets up the toolbox from that.
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(Locale) - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Returns a new TextKey with the specified resource bundle set.
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.ClassTool
 
log - Variable in class org.apache.velocity.tools.generic.FieldTool
 
LOG - Variable in class org.apache.velocity.tools.generic.LinkTool
 
LOG - Variable in class org.apache.velocity.tools.generic.XmlTool
 
LOG - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
LOG - Variable in class org.apache.velocity.tools.view.AbstractSearchTool
 
LOG - Variable in class org.apache.velocity.tools.view.BrowserTool
 
log - Variable in class org.apache.velocity.tools.view.CookieTool
 
LOG - Variable in class org.apache.velocity.tools.view.ImportSupport
 
LOG - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated.  
log(int, String) - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated. Send a log message from Velocity.
log(int, String, Throwable) - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated.  
LOG - Static variable in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
LOG - Static variable in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated.  
LOG_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
LogChuteCommonsLog - Class in org.apache.velocity.tools.generic.log
Redirects commons-logging messages to Velocity's configured LogChute.
LogChuteCommonsLog() - Constructor for class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
 
LogChuteCommonsLog(String) - Constructor for class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
 
logPrefix() - Method in class org.apache.velocity.tools.config.ConfigurationCleaner
 
logPrefix() - Method in class org.apache.velocity.tools.config.LogSupport
Override this to set a class-specific prefix
LogSupport - Class in org.apache.velocity.tools.config
This allows for a Log to optionally be attached to a subclass in order to output logging messages.
LogSupport() - Constructor for class org.apache.velocity.tools.config.LogSupport
 
LogSystemCommonsLog - Class in org.apache.velocity.tools.generic.log
Deprecated. Use LogChuteCommonsLog instead
LogSystemCommonsLog() - Constructor for class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Deprecated.  
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.ActionCondition is satisfied by the subsequent element.
LoopTool.ActionCondition - Class in org.apache.velocity.tools.generic
Composition class which associates an LoopTool.Action and LoopTool.ActionCondition for a LoopTool.ManagedIterator.
LoopTool.ActionCondition(LoopTool.Action, LoopTool.Condition) - Constructor for class org.apache.velocity.tools.generic.LoopTool.ActionCondition
 
LoopTool.Comparison - Class in org.apache.velocity.tools.generic
Base condition class for conditions (assumption here is that conditions are all comparative.
LoopTool.Comparison(Object) - Constructor for class org.apache.velocity.tools.generic.LoopTool.Comparison
 
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.Equals(Object) - Constructor for class org.apache.velocity.tools.generic.LoopTool.Equals
 
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.ManagedIterator(String, Iterator, LoopTool) - Constructor for class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
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.
LoopTool.SyncedIterator(Iterator) - Constructor for class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
 

M

make(Object...) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Make an automatic Alternator from the specifed objects.
make(Collection) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
make(boolean, Object...) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Returns a new Alternator for the specified list with the specified automatic shifting preference.
make(boolean, Collection) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
make(Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
make(boolean, Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
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
 
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
Make a manual Alternator from the specified objects.
manual(Collection) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
manual(Object, Object) - Method in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. Will be unnecessary with Velocity 1.6
mark(int) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
markSupported() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
MarkupTool - Class in org.apache.velocity.tools.generic
NOTE: This tools is considered "alpha" quality due to lack of testing and a generally unpolished API.
MarkupTool() - Constructor for class org.apache.velocity.tools.generic.MarkupTool
 
MarkupTool.Tag - Class in org.apache.velocity.tools.generic
 
MarkupTool.Tag(MarkupTool) - Constructor for class org.apache.velocity.tools.generic.MarkupTool.Tag
 
matches(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ActionCondition
Returns true if the specified value meets the set LoopTool.ActionCondition
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.
merge(Template, Context, Writer) - Method in class org.apache.velocity.tools.view.VelocityView
Merges the template with the context.
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, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
 
message(String, Collection) - Method in class org.apache.velocity.tools.generic.DisplayTool
Deprecated. Will be unnecessary with Velocity 1.6
message(String, Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Deprecated. Will be unnecessary with Velocity 1.6
message(String, Object, Object) - Method in class org.apache.velocity.tools.generic.DisplayTool
Deprecated. Will be unnecessary with Velocity 1.6
message(String, Object...) - Method in class org.apache.velocity.tools.generic.DisplayTool
Uses MessageFormat to format the specified String with the specified arguments.
MessageResourcesTool - Class in org.apache.velocity.tools.struts
Abstract view tool that provides access to Struts' message resources.
MessageResourcesTool() - Constructor for class org.apache.velocity.tools.struts.MessageResourcesTool
 
MessageTool - Class in org.apache.velocity.tools.struts
The MessageTool is used to render internationalized message strings.
MessageTool() - Constructor for class org.apache.velocity.tools.struts.MessageTool
 
MessageTool.TextKey - Class in org.apache.velocity.tools.struts
Helper class to simplify tool usage when retrieving no-arg messages from the default bundle that have periods in their key.
MessageTool.TextKey(String, String, Object[], Locale) - Constructor for class org.apache.velocity.tools.struts.MessageTool.TextKey
 
method - Variable in class org.apache.velocity.tools.generic.ClassTool.MethodSub
 
methods - Variable in class org.apache.velocity.tools.generic.ClassTool
 
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
 
more() - Method in class org.apache.velocity.tools.generic.IteratorTool
Deprecated.  Asks for the next element in the list.
mul(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
mul(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
 
MultiViewsTool - Class in org.apache.velocity.tools.view.i18n
Deprecated. 
MultiViewsTool() - Constructor for class org.apache.velocity.tools.view.i18n.MultiViewsTool
Deprecated.  

N

name(Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
newInstance() - Method in class org.apache.velocity.tools.ToolInfo
 
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 - Variable in class org.apache.velocity.tools.generic.IteratorTool
Deprecated.  
next() - Method in class org.apache.velocity.tools.generic.IteratorTool
Deprecated.  Gets the next object in the list.
next() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Returns the next element that meets the set LoopTool.ActionConditions (if any) in the iterator being managed.
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.
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
 
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

OLD_AUTO_ALTERNATE_DEFAULT_KEY - Static variable in class org.apache.velocity.tools.generic.AlternatorTool
Deprecated. 
OLD_LOCK_CONFIG_KEY - Static variable in class org.apache.velocity.tools.generic.SafeConfig
Deprecated. 
OLD_SAFE_MODE_KEY - Static variable in class org.apache.velocity.tools.view.tools.ContextTool
Deprecated. 
OldToolInfo - Class in org.apache.velocity.tools
Manages old tools which still use the deprecated init() method.
OldToolInfo(String, Class) - Constructor for class org.apache.velocity.tools.OldToolInfo
Creates a new instance using the minimum required info necessary for a tool.
OldXmlFactoryConfigurationRuleSet - Class in org.apache.velocity.tools.config
Deprecated. This is provided merely for 1.x compatibility.
OldXmlFactoryConfigurationRuleSet() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet
Deprecated.  
OldXmlFactoryConfigurationRuleSet.BooleanConfigRule - Class in org.apache.velocity.tools.config
Deprecated.  
OldXmlFactoryConfigurationRuleSet.BooleanConfigRule() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.BooleanConfigRule
Deprecated.  
OldXmlFactoryConfigurationRuleSet.CreateSessionRule - Class in org.apache.velocity.tools.config
Deprecated.  
OldXmlFactoryConfigurationRuleSet.CreateSessionRule() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.CreateSessionRule
Deprecated.  
OldXmlFactoryConfigurationRuleSet.DeprecationRule - Class in org.apache.velocity.tools.config
Deprecated.  
OldXmlFactoryConfigurationRuleSet.DeprecationRule() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.DeprecationRule
Deprecated.  
OldXmlFactoryConfigurationRuleSet.ParameterRule - Class in org.apache.velocity.tools.config
Deprecated.  
OldXmlFactoryConfigurationRuleSet.ParameterRule() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.ParameterRule
Deprecated.  
OldXmlFactoryConfigurationRuleSet.ScopeRule - Class in org.apache.velocity.tools.config
Deprecated.  
OldXmlFactoryConfigurationRuleSet.ScopeRule() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.ScopeRule
Deprecated.  
OldXmlFactoryConfigurationRuleSet.SetNextDataRule - Class in org.apache.velocity.tools.config
Deprecated.  
OldXmlFactoryConfigurationRuleSet.SetNextDataRule() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.SetNextDataRule
Deprecated.  
OldXmlFactoryConfigurationRuleSet.XhtmlRule - Class in org.apache.velocity.tools.config
Deprecated.  
OldXmlFactoryConfigurationRuleSet.XhtmlRule() - Constructor for class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.XhtmlRule
Deprecated.  
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.generic - package org.apache.velocity.tools.generic
Contains a collection of reusable, general-purpose "tools" for Velocity.
org.apache.velocity.tools.generic.log - package org.apache.velocity.tools.generic.log
Contains classes created to serve as bridges between Commons-Logging and Velocity's LogSystem.
org.apache.velocity.tools.plugin.taglib - package org.apache.velocity.tools.plugin.taglib
Wraps a JSP tag library into one Velocity directive per tag.
org.apache.velocity.tools.plugin.taglib.model - package org.apache.velocity.tools.plugin.taglib.model
Model classes representing a tag library descriptor elements.
org.apache.velocity.tools.struts - package org.apache.velocity.tools.struts
VelocityStruts contains view tools for integrating Velocity with the Apache Struts 1 framework by providing easy access to Struts resources from within Velocity templates.
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.context - package org.apache.velocity.tools.view.context
All classes in this package have been deprecated.
org.apache.velocity.tools.view.i18n - package org.apache.velocity.tools.view.i18n
 
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.
org.apache.velocity.tools.view.servlet - package org.apache.velocity.tools.view.servlet
All classes in this package have been deprecated.
org.apache.velocity.tools.view.tools - package org.apache.velocity.tools.view.tools
All classes in this package have been deprecated and moved to org.apache.velocity.tools.view.
orphan() - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 

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.
ParameterParser - Class in org.apache.velocity.tools.view.tools
Deprecated. 
ParameterParser() - Constructor for class org.apache.velocity.tools.view.tools.ParameterParser
Deprecated. Constructs a new instance
ParameterParser(ServletRequest) - Constructor for class org.apache.velocity.tools.view.tools.ParameterParser
Deprecated. Constructs a new instance using the specified request.
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.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(Object) - Method in class org.apache.velocity.tools.generic.XmlTool
This accepts XML in form.
parseBoolean(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
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
Converts a string to an instance of Date, using the configured date parsing format, the configured default Locale, and the system's default TimeZone to parse it.
parseDate(String, String) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts a string to an instance of Date using the specified format,the configured default Locale, and the system's default TimeZone to parse it.
parseDate(String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts a string to an instance of Date using the configured date format and specified Locale to parse it.
parseDate(String, String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts a string to an instance of Date using the specified format and Locale to parse it.
parseDate(String, String, Object, TimeZone) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts a string to an instance of Date using the specified format, Locale, and TimeZone.
parseLocale(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts a String value into a Locale.
parseNumber(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts an object to an instance of Number using the format returned by ConversionTool.getNumberFormat() and the default Locale if the object is not already an instance of Number.
parseNumber(String, String) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts an object to an instance of Number using the specified format and the Locale returned by LocaleConfig.getLocale().
parseNumber(String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts an object to an instance of Number using the configured number format and the specified Locale.
parseNumber(String, String, Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
Converts an object to an instance of Number using the specified format and Locale.
parseNumber(String) - Method in class org.apache.velocity.tools.generic.MathTool
Deprecated. 
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
Converts a single String value into an array of Strings by splitting it on the tool's set stringsDelimiter.
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.
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.
popTilesContext() - Method in class org.apache.velocity.tools.struts.TilesTool
Pops the tiles sub-context off the context-stack after the lower level tiles have been rendered.
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
 
PREFIX - Static variable in class org.apache.velocity.tools.view.ServletLogChute
Deprecated.  
prepareContext(ToolContext) - Method in class org.apache.velocity.tools.ToolManager
 
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
 
processAsDefinitionOrURL(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Try to process name as a definition, or as an URL if not found.
processDefinition(ComponentDefinition) - Method in class org.apache.velocity.tools.struts.TilesTool
End of Process for definition.
processObjectValue(Object) - Method in class org.apache.velocity.tools.struts.TilesTool
Process an object retrieved as a bean or attribute.
processTypedAttribute(AttributeDefinition) - Method in class org.apache.velocity.tools.struts.TilesTool
Process typed attribute according to its type.
processUrl(String) - Method in class org.apache.velocity.tools.struts.TilesTool
Processes an url
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").
PropertiesFactoryConfiguration - Class in org.apache.velocity.tools.config
This reads in configuration info formatted as a property file using ExtendedProperties from Commons-Collections.
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_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.
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
 
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.
pushTilesContext() - Method in class org.apache.velocity.tools.struts.TilesTool
pushes the current tiles context onto the context-stack.
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(InputStream) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
Reads an configuration from an InputStream.
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, Log) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
 
read(URL, boolean, Log) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
 
read(Object, InputStream, boolean, Log) - Method in class org.apache.velocity.tools.config.FileFactoryConfiguration
 
read(InputStream) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
Reads an properties file from an InputStream and uses it to configure this FactoryConfiguration.
read(ExtendedProperties) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
 
read(InputStream) - Method in class org.apache.velocity.tools.config.XmlFactoryConfiguration
Reads an XML document from an InputStream and uses it to configure this FactoryConfiguration.
read(String) - Method in class org.apache.velocity.tools.generic.XmlTool
Creates a URL from the string and passes it to XmlTool.read(URL).
read(URL) - Method in class org.apache.velocity.tools.generic.XmlTool
Reads, parses and creates a Document from the given URL and uses it as the root Node for this instance.
read(Object) - Method in class org.apache.velocity.tools.generic.XmlTool
If safe mode is explicitly turned off for this tool, then this will accept either a URL or the string representation thereof.
read() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
read(char[]) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
read(char[], int, int) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
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.
readData(ExtendedProperties) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
 
READONLY_KEY - Static variable in class org.apache.velocity.tools.generic.ValueParser
The key used for specifying whether to be read-only
readProperties(ExtendedProperties, Configuration) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
 
readToolboxes(ExtendedProperties) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
 
readTools(ExtendedProperties, ToolboxConfiguration) - Method in class org.apache.velocity.tools.config.PropertiesFactoryConfiguration
 
ready() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
recurse(String) - Method in class org.apache.velocity.tools.generic.RenderTool
Recursively evaluates a String containing VTL using the current context, and returns the result as a String.
recurse(Context, String) - Method in class org.apache.velocity.tools.generic.RenderTool
Recursively evaluates a String containing VTL using the current context, and returns the result as a String.
relative() - Method in class org.apache.velocity.tools.generic.LinkTool
Returns a copy of this LinkTool instance that has LinkTool.setForceRelative(boolean) set to true.
relative(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
Returns a copy of the link with the specified directory-relative URI reference set as the end of the path and LinkTool.setForceRelative(boolean) set to true.
RELATIVE_TYPE - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
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() - Method in class org.apache.velocity.tools.generic.IteratorTool
Deprecated. Removes the current element from the list.
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(Object) - 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
rendering methods
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_body(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
render_classes(StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
render_end(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
render_id(StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
render_name(StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
render_start(String, StringBuilder) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
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.struts.FormTool
A reference to the HtttpServletRequest.
request - Variable in class org.apache.velocity.tools.struts.MessageResourcesTool
 
request - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the HttpServletRequest.
request - Variable in class org.apache.velocity.tools.view.CookieTool
 
request - Variable in class org.apache.velocity.tools.view.ImportSupport
 
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
 
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.IteratorTool
Deprecated.  Resets the wrapper so that it starts over at the beginning of the list.
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.ImportSupport.SafeClosingHttpURLConnectionReader
 
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.
resolve(UiDependencyTool) - Method in class org.apache.velocity.tools.view.UiDependencyTool.Group
 
resources - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the ValidatorResources.
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.
ResourceTool.Key(String, String[], Object, Object[]) - Constructor for class org.apache.velocity.tools.generic.ResourceTool.Key
 
response - Variable in class org.apache.velocity.tools.view.CookieTool
 
response - Variable in class org.apache.velocity.tools.view.ImportSupport
 
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.
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, Log) - Static 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.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.
RUNTIME_LOG_LEVEL_KEY - Static variable in class org.apache.velocity.tools.view.ServletLogChute
Deprecated.  

S

SAFE_MODE_KEY - Static variable in class org.apache.velocity.tools.generic.SafeConfig
Many tools interested in locking configure() also have other things they wish to secure.
SafeConfig - Class in org.apache.velocity.tools.generic
Implements common logic and constants for tools which automatically locks down the public void configure(Map params) method after it is called once.
SafeConfig() - Constructor for class org.apache.velocity.tools.generic.SafeConfig
 
scheme - Variable in class org.apache.velocity.tools.generic.LinkTool
 
scheme(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
Returns a new instance with the specified value set as its scheme.
SCHEME_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
 
Scope - Class in org.apache.velocity.tools
A specialized constants class to provide some compile-time typo checking and runtime validation for scopes specified in annotations, toolbox configs, etc.
scope - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
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
 
SecureLinkTool - Class in org.apache.velocity.tools.struts
Tool to be able to use Struts SSL Extensions with Velocity.
SecureLinkTool() - Constructor for class org.apache.velocity.tools.struts.SecureLinkTool
 
selectModule(String, ServletContext) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Select the module to which the specified request belongs, and add return the corresponding ModuleConfig.
self - Variable in class org.apache.velocity.tools.generic.LinkTool
 
SELF_ABSOLUTE_KEY - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
SELF_INCLUDE_PARAMETERS_KEY - Static variable in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
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.ServletLogChute
Deprecated.  
servletContext - Variable in class org.apache.velocity.tools.view.ViewToolManager
 
servletContext - Variable in class org.apache.velocity.tools.view.WebappResourceLoader
 
ServletLogChute - Class in org.apache.velocity.tools.view
Deprecated. This class has been moved to Velocity Engine 1.6+ and only remains here temporarily for users of previous Velocity Engine versions.
ServletLogChute() - Constructor for class org.apache.velocity.tools.view.ServletLogChute
Deprecated. Construct a simple logger for a servlet environment.
ServletToolboxManager - Class in org.apache.velocity.tools.view.servlet
Deprecated. Use XmlFactoryConfiguration
ServletToolboxRuleSet - Class in org.apache.velocity.tools.view.servlet
Deprecated. Use XmlFactoryConfigurationRuleSet.
ServletToolboxRuleSet() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet
Deprecated.  
ServletToolboxRuleSet.BooleanConfigRule - Class in org.apache.velocity.tools.view.servlet
Deprecated. Abstract rule for configuring boolean options on the parent object/element of the matching element.
ServletToolboxRuleSet.BooleanConfigRule() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.BooleanConfigRule
Deprecated.  
ServletToolboxRuleSet.CreateSessionRule - Class in org.apache.velocity.tools.view.servlet
Deprecated. Rule that sets setCreateSession() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
ServletToolboxRuleSet.CreateSessionRule() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.CreateSessionRule
Deprecated.  
ServletToolboxRuleSet.XhtmlRule - Class in org.apache.velocity.tools.view.servlet
Deprecated. Rule that sets setXhtml() for the top object on the stack, which must be a org.apache.velocity.tools.ServletToolboxManager.
ServletToolboxRuleSet.XhtmlRule() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.XhtmlRule
Deprecated.  
ServletToolInfo - Class in org.apache.velocity.tools.view.servlet
Deprecated. Use ToolInfo
ServletToolInfo() - Constructor for class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
ServletUtils - Class in org.apache.velocity.tools.view.servlet
Deprecated. Use ServletUtils
ServletUtils() - Constructor for class org.apache.velocity.tools.view.servlet.ServletUtils
Deprecated.  
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.struts.FormTool
A reference to the HtttpSession.
session - Variable in class org.apache.velocity.tools.struts.ValidatorTool
A reference to the HttpSession.
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
 
SESSION_TOOLS_KEY - Static variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated.  
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.
set(Object, int, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Sets the specified element of a List/array.
setAbsolute(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.absolute(Object)
setAcceptLanguage(String) - Method in class org.apache.velocity.tools.view.BrowserTool
 
setAction(String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Returns a copy of the link with the given action name converted into a server-relative URI reference.
setAction(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
Returns a copy of the link with the given action name converted into a server-relative URI reference.
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
setAnchor(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.anchor(Object) instead
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
 
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
Sets the default for auto-alternating.
setAutoIgnoreParameters(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
setBodyContent(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Sets the body content of the tag.
setBodyContentKey(String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setBoolean(FactoryConfiguration, Boolean) - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.BooleanConfigRule
Deprecated.  
setBoolean(FactoryConfiguration, Boolean) - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.CreateSessionRule
Deprecated.  
setBoolean(FactoryConfiguration, Boolean) - Method in class org.apache.velocity.tools.config.OldXmlFactoryConfigurationRuleSet.XhtmlRule
Deprecated.  
setBoolean(Object, Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.BooleanConfigRule
Deprecated. Takes the parent object and boolean value in order to call the appropriate method on the parent for the implementing rule.
setBoolean(Object, Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.CreateSessionRule
Deprecated.  
setBoolean(Object, Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxRuleSet.XhtmlRule
Deprecated.  
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.
setCatchExceptions(boolean) - Method in class org.apache.velocity.tools.struts.TilesTool
 
setCdata(boolean) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the cdata status.
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
 
setClass(Class) - Method in class org.apache.velocity.tools.OldToolInfo
 
setClass(Class) - Method in class org.apache.velocity.tools.ToolInfo
Tries to create an instance of the specified Class, then looks for a configure(Map) method.
setClassname(String) - Method in class org.apache.velocity.tools.config.Data
 
setClassname(String) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
setClassname(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. If an instance of the tool cannot be created from the classname passed to this method, it will throw an exception.
setContentType(String) - Method in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
Has no effect.
setContentType(HttpServletRequest, HttpServletResponse) - Method in class org.apache.velocity.tools.view.VelocityViewServlet
Sets the content type of the response.
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.servlet.ServletToolboxManager
Deprecated. Sets whether or not to create a new session when none exists for the current request and session-scoped tools have been defined for this toolbox.
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
 
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.
setDefaultLocale(Locale) - Method in class org.apache.velocity.tools.generic.ResourceTool
Deprecated. 
setDeprecationSupportMode(boolean) - Method in class org.apache.velocity.tools.generic.ResourceTool
Deprecated. 
setDeprecationSupportMode(boolean) - Method in class org.apache.velocity.tools.view.VelocityView
Deprecated. 
setDescription(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Sets the description of the attribute.
setDescription(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Sets the description of the tag.
setDescription(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Sets the description.
setEnabledLevel(int) - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated. Set the minimum level at which messages will be printed.
setEncoding(JeeConfig) - Method in class org.apache.velocity.tools.view.VelocityView
 
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.
setForward(String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Returns a copy of the link with the given global forward name converted into a server-relative URI reference.
setForward(String) - Method in class org.apache.velocity.tools.struts.StrutsLinkTool
Returns a copy of the link with the given global or local forward name converted into a server-relative URI reference.
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
 
setHtmlComment(boolean) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets whether or not to delimit the JavaScript with html comments.
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
 
setJTag(Tag) - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Sets the tag that contains this attribute.
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
Mutators
setKey(String) - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated. Mutators
setKey(String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Mutators
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.ImportSupport.ImportResponseWrapper
Has no effect.
setLockConfig(boolean) - Method in class org.apache.velocity.tools.generic.SafeConfig
Only allow subclass access to this.
setLog(Log) - Method in class org.apache.velocity.tools.config.LogSupport
 
setLog(Log) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
 
setLog(Log) - Method in class org.apache.velocity.tools.view.BrowserTool
Set log.
setLog(Log) - Method in class org.apache.velocity.tools.view.CookieTool
Sets the Log used for logging messages when Cookie creation fails due to an invalid name.
setLog(Log) - Method in class org.apache.velocity.tools.view.ImportSupport
 
setMethod(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the method name that will be used for the Javascript validation method name if it has a value.
setName(String) - Method in class org.apache.velocity.tools.config.Property
 
setName(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Sets the name of the attribute.
setName(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Sets the name of the tag.
setNewItemsKey(String) - Method in class org.apache.velocity.tools.view.PagerTool
 
setNumberFormat(String) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
setPage(int) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the current page number of a multi-part form.
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.
setParam(Object, Object, boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated.  
setParameter(String, String) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Set/add new parameter for this tool.
setParameters(Map) - Method in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated. Set parameter map for this tool.
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).
setParams(Object, boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated.  
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(ExtendedProperties, 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
 
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
setRelative(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.relative(Object)
setRepository(StringResourceRepository) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
setRequest(HttpServletRequest) - Method in class org.apache.velocity.tools.struts.FormTool
Initializes this tool.
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.ImportSupport
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.tools.LinkTool
Deprecated. 
setRequestPath(String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
setRequired(boolean) - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
It tells if the attribute is required.
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.ImportSupport
Sets the current HttpServletResponse.
setResponse(HttpServletResponse) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
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.
setRtexprvalue(boolean) - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
It tells ifthe attribute accepts runtime expression.
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.SafeConfig
 
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
 
setScope(String) - Method in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
setSelfAbsolute(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.setForceRelative(boolean) as reversed replacement
setSelfIncludeParameters(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.setIncludeRequestParams(boolean) instead
setServletContext(ServletContext) - Method in class org.apache.velocity.tools.view.ImportSupport
Sets the ServletContext.
setShortName(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Sets the short name of the taglib.
setSkipSetters(Boolean) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
setSkipSetters(boolean) - Method in class org.apache.velocity.tools.ToolInfo
 
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.
setSrc(String) - Method in class org.apache.velocity.tools.struts.ValidatorTool
Sets the src attribute's value (used to include an external script resource) when defining the html script element.
setStatus(int) - Method in class org.apache.velocity.tools.view.ImportSupport.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.ConversionTool
Sets the delimiter used for separating values in a single String value.
setStringsTrim(boolean) - Method in class org.apache.velocity.tools.generic.ConversionTool
Sets whether strings should be trimmed when separated from a delimited string value.
setTab(String) - Method in class org.apache.velocity.tools.generic.MarkupTool
 
setTagClass(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
Sets the class of the tag.
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
 
setTlibVersion(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Sets the taglib version.
setToolbox(Map<String, Object>) - Method in class org.apache.velocity.tools.view.context.ChainedContext
Deprecated.  
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
 
setType(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Attribute
Sets the type of the attribute.
setType(String) - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
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.
setUri(String) - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
Sets the URI of the taglib.
setURI(String) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. use LinkTool.uri(Object)
setUserAgent(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
 
setUserInfo(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
 
setValue(Object) - Method in class org.apache.velocity.tools.config.Data
 
setValue(String) - Method in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
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.
setVelocityContext(Context) - Method in class org.apache.velocity.tools.struts.TilesTool
Initializes this tool.
setVelocityEngine(VelocityEngine) - Static method in class org.apache.velocity.tools.generic.log.LogSystemCommonsLog
Deprecated. Use LogChuteCommonsLog.setVelocityLog(Log target) instead
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.
setVelocityLog(Log) - Static method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Set a VelocityEngine to handle all the log messages.
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.
setXhtml(Boolean) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. Sets an application attribute to tell velocimacros and tools (especially the LinkTool) whether they should output XHTML or HTML.
setXhtml(boolean) - Method in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated. 
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
 
signature - Variable in class org.apache.velocity.tools.generic.ClassTool.CallableSub
 
signature(boolean) - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
 
size(Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Gets the size of a List/array.
size() - Method in class org.apache.velocity.tools.generic.ValueParser
 
size() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns the number of Nodes internally held by this instance.
skip(int) - Method in class org.apache.velocity.tools.generic.LoopTool
Skips ahead the specified number of iterations (if possible).
skip(int, String) - Method in class org.apache.velocity.tools.generic.LoopTool
This tells the specified loop to skip ahead the specified number of iterations.
skip(long) - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
SKIPPED_UNITS_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
The key used for specifying time units to be skipped over.
SkipSetters - Annotation Type in org.apache.velocity.tools.config
Annotation specifying that ToolInfo should only use the public void configure(Map) method for configuration of a tool, and skip over the step of trying to find individual property setters.
sort(Collection) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Object[]) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Map) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Object, String) - Method in class org.apache.velocity.tools.generic.SortTool
Sorts the collection on a single property.
sort(Collection, List) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Map, List) - Method in class org.apache.velocity.tools.generic.SortTool
 
sort(Object[], List) - Method in class org.apache.velocity.tools.generic.SortTool
 
SortTool - Class in org.apache.velocity.tools.generic
SortTool allows a user to sort a collection (or array, iterator, etc) on any arbitary set of properties exposed by the objects contained within the collection.
SortTool() - Constructor for class org.apache.velocity.tools.generic.SortTool
 
SortTool.PropertiesComparator - Class in org.apache.velocity.tools.generic
Does all of the comparisons
SortTool.PropertiesComparator(List) - Constructor for class org.apache.velocity.tools.generic.SortTool.PropertiesComparator
 
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.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.IteratorTool
Deprecated. Puts a condition to break out of the loop.
stop() - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Stops this iterator from doing any further iteration.
stop(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Directs this instance to stop iterating immediately prior to any element equal to the specified Object.
stop() - Method in class org.apache.velocity.tools.generic.LoopTool
This tells the current loop to stop after the current iteration.
stop(String) - Method in class org.apache.velocity.tools.generic.LoopTool
This is just like LoopTool.stop() except that the stop command is issued only to the loop/iterator with the specified name.
stopAll() - Method in class org.apache.velocity.tools.generic.LoopTool
This is just like LoopTool.stop() except that the stop command is issued all the loops being watched by this tool.
stopTo(String) - Method in class org.apache.velocity.tools.generic.LoopTool
This is just like LoopTool.stop(String) except that the stop command is issued both to the loop/iterator with the specified name and all loops nested within it.
storage - Variable in class org.apache.velocity.tools.generic.FieldTool
 
STORE_DYNAMIC_KEY - Static variable in class org.apache.velocity.tools.generic.FieldTool
The key used for specifying whether or not the tool should store fields in classes dynamically looked up from within a template.
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
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.ConversionTool
 
STRINGS_TRIM_KEY - Static variable in class org.apache.velocity.tools.generic.ConversionTool
 
stripSession(String) - Static method in class org.apache.velocity.tools.view.ImportSupport
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.
STRUTS_DEFAULTS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
 
StrutsLinkTool - Class in org.apache.velocity.tools.struts
The StrutsLinkTool extends the standard LinkTool to add methods for working with Struts' Actions and Forwards:
StrutsLinkTool() - Constructor for class org.apache.velocity.tools.struts.StrutsLinkTool
 
StrutsUtils - Class in org.apache.velocity.tools.struts
A utility class to expose the Struts shared resources.
sub(Object, Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
sub(Object...) - Method in class org.apache.velocity.tools.generic.MathTool
 
supportsNewInstance() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns true if a call to newInstance() on the Class being inspected is successful; otherwise returns false.
sync(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Adds another iterator to be kept in sync with the one being managed by this instance.
sync(Object, String) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Adds another iterator to be kept in sync with the one being managed by this instance.
sync(Object, Object) - Method in class org.apache.velocity.tools.generic.LoopTool
 
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 - Class in org.apache.velocity.tools.plugin.taglib.model
It represents a tag in a tag library descriptor.
Tag() - Constructor for class org.apache.velocity.tools.plugin.taglib.model.Tag
 
Taglib - Class in org.apache.velocity.tools.plugin.taglib.model
It represents a Tag Library, as read from a Tag Library Descriptor.
Taglib() - Constructor for class org.apache.velocity.tools.plugin.taglib.model.Taglib
 
Taglib2Directive - Class in org.apache.velocity.tools.plugin.taglib
Creates directives from a tag library.
Taglib2Directive() - Constructor for class org.apache.velocity.tools.plugin.taglib.Taglib2Directive
 
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
 
TilesTool - Class in org.apache.velocity.tools.struts
The TilesTool is used to interact with the Struts-Tiles framework that is part of Struts 1.
TilesTool() - Constructor for class org.apache.velocity.tools.struts.TilesTool
 
TIME_UNITS - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
Array of all time unit message keys to their millisecond conversion factor.
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
 
toBooleans(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
toBooleans(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
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 locale returned by LocaleConfig.getLocale() if necessary.
toCalendar(Object, Locale) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Calendar using the locale returned by LocaleConfig.getLocale() if necessary.
toCalendars(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
toCalendars(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
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
Converts an object to an instance of Date, when necessary using the configured date parsing format, the configured default Locale, and the system's default TimeZone to parse the string value of the specified object.
toDate(Object) - Method in class org.apache.velocity.tools.generic.DateTool
Converts an object to an instance of Date using the format returned by FormatConfig.getFormat(),the Locale returned by LocaleConfig.getLocale(), and the TimeZone returned by DateTool.getTimeZone() if the object is not already an instance of Date, Calendar, or Long.
toDate(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
 
toDates(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
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
 
toDouble(Object) - Method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into a Double Valid formats are Number or a String representation of a number
toDoubles(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
toEncoded(String, String) - Method in class org.apache.velocity.tools.struts.SecureLinkTool
Return the specified URL with the specified session identifier suitably encoded.
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
 
toInteger(Object) - Method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into an Integer Valid formats are Number or a String representation of a number
toIntegers(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
toInts(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
toLevel(String) - Method in class org.apache.velocity.tools.view.ServletLogChute
Deprecated.  
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
 
toLocales(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
toLocales(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
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
 
toNumber(Object) - Method in class org.apache.velocity.tools.generic.MathTool
Converts an object with a numeric value into a Number Valid formats are Number or a String representation of a number.
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
 
toNumbers(Collection) - Method in class org.apache.velocity.tools.generic.ConversionTool
 
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
 
TOOLBOX_KEY - Static variable in class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Deprecated. toolbox key is now managed by VelocityView
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
 
ToolboxManager - Interface in org.apache.velocity.tools.view
Deprecated. 
ToolboxRuleSet - Class in org.apache.velocity.tools.view
Deprecated. Use XmlFactoryConfigurationRuleSet
ToolboxRuleSet() - Constructor for class org.apache.velocity.tools.view.ToolboxRuleSet
Deprecated.  
ToolboxRuleSet.ParameterRule - Class in org.apache.velocity.tools.view
Deprecated.  
ToolboxRuleSet.ParameterRule() - Constructor for class org.apache.velocity.tools.view.ToolboxRuleSet.ParameterRule
Deprecated.  
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 - Interface in org.apache.velocity.tools.view
Deprecated. Use ToolInfo
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 ConfigurationUtils.getAutoLoaded() configuration and any configuration specified via a "org.apache.velocity.tools" system property.
ToolManager(boolean) - Constructor for class org.apache.velocity.tools.ToolManager
 
ToolManager(boolean, boolean) - Constructor for class org.apache.velocity.tools.ToolManager
 
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() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Renders this comparison to a String.
toString(long, int, int, boolean, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
 
toString(long, int, boolean, Locale) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Converts the specified positive duration of milliseconds into larger units up to the specified number of positive units, beginning with the largest positive unit.
toString(Object) - Method in class org.apache.velocity.tools.generic.ConversionTool
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.IteratorTool
Deprecated. Returns this object as a 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.plugin.taglib.model.Attribute
 
toString() - Method in class org.apache.velocity.tools.plugin.taglib.model.Tag
 
toString() - Method in class org.apache.velocity.tools.plugin.taglib.model.Taglib
 
toString() - Method in class org.apache.velocity.tools.struts.MessageTool.TextKey
Renders the text output according to the collected key value, bundle, and arguments.
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.
trace(String) - Method in class org.apache.velocity.tools.config.LogSupport
 
trace(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "DEBUG" level.
trace(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "DEBUG" level.
trace(Log, String, Object...) - Static method in class org.apache.velocity.tools.view.UiDependencyTool
 
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.SortTool.PropertiesComparator
 
TYPE_BOOLEAN - Static variable in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
TYPE_DESCENDING_SHORT - Static variable in class org.apache.velocity.tools.generic.SortTool.PropertiesComparator
 
TYPE_NUMBER - Static variable in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
TYPE_STRING - Static variable in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
TYPES_KEY_SPACE - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
 

U

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.FileRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.FileRule
 
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.Group(String, Log) - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.Group
 
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.GroupRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.GroupRule
 
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.NeedsRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.NeedsRule
 
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.
UiDependencyTool.TypeRule() - Constructor for class org.apache.velocity.tools.view.UiDependencyTool.TypeRule
 
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
 
unpublishApplicationTools() - Method in class org.apache.velocity.tools.view.ViewToolManager
Removes any published Scope.APPLICATION Toolbox.
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.
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.

V

VALID_SCHEME_CHARS - Static variable in class org.apache.velocity.tools.view.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
 
validateToolInfo(ToolInfo) - Method in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated. Ensures that application-scoped tools do not have request path restrictions set for them, as those will not be enforced.
validateToolInfo(ToolInfo) - Method in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated. Checks whether an object described by a ToolInfo passes some basic sanity checks.
ValidatorTool - Class in org.apache.velocity.tools.struts
View tool that works with Struts Validator to produce client side javascript validation for your forms.
ValidatorTool() - Constructor for class org.apache.velocity.tools.struts.ValidatorTool
 
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.
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
 
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.
velocityContext - Variable in class org.apache.velocity.tools.struts.TilesTool
 
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.servlet
Deprecated. This has moved to VelocityLayoutServlet
VelocityLayoutServlet() - Constructor for class org.apache.velocity.tools.view.servlet.VelocityLayoutServlet
Deprecated.  
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.servlet
Deprecated. This class has moved to VelocityViewServlet
VelocityViewServlet() - Constructor for class org.apache.velocity.tools.view.servlet.VelocityViewServlet
Deprecated.  
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.context
Deprecated. Use ViewContext
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
 
ViewRenderTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
ViewRenderTool() - Constructor for class org.apache.velocity.tools.view.tools.ViewRenderTool
Deprecated.  
ViewResourceTool - Class in org.apache.velocity.tools.view.tools
Deprecated. 
ViewResourceTool() - Constructor for class org.apache.velocity.tools.view.tools.ViewResourceTool
Deprecated.  
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
 
ViewToolInfo - Class in org.apache.velocity.tools.view
Deprecated. Use ToolInfo
ViewToolInfo() - Constructor for class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
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 the ConfigurationUtils.getAutoLoaded()() configuration and 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.config.LogSupport
 
warn(Object) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "WARN" level.
warn(Object, Throwable) - Method in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
Passes messages to Velocity's LogChute at "WARN" level.
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.
WebappLoader - Class in org.apache.velocity.tools.view.servlet
Deprecated. Use WebappResourceLoader instead.
WebappLoader() - Constructor for class org.apache.velocity.tools.view.servlet.WebappLoader
Deprecated.  
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.GetAttributeExecutor(Log, Introspector, Class, String) - Constructor for class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
 
WebappUberspector.SetAttributeExecutor - Class in org.apache.velocity.tools.view
Executor for setAttribute(name,value) method
WebappUberspector.SetAttributeExecutor(Log, Introspector, Class, Object, String) - Constructor for class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
 
WEEK_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
whenIs(Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns a ComparisonDateTool.Comparison between the result of DateTool.getCalendar() and the specified date.
whenIs(Object, Object) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool
Returns a ComparisonDateTool.Comparison between the second specified date and the first specified date.
wrap(Object) - Method in class org.apache.velocity.tools.generic.IteratorTool
Deprecated. Wraps a list with the tool.
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 - Static variable in interface org.apache.velocity.tools.view.context.ViewContext
Deprecated.  
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.
XML_DEFAULTS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
 
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
 
XmlFactoryConfiguration(boolean) - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfiguration
 
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.
XmlFactoryConfiguration(boolean, 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 and using the specified setting for supporting the old toolbox.xml format from VelocityTools 1.x.
XmlFactoryConfigurationRuleSet - Class in org.apache.velocity.tools.config
This provides set of XmlFactoryConfigurationRuleSet.DataValueInBodyRules 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.DataValueInBodyRule() - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet.DataValueInBodyRule
 
XmlFactoryConfigurationRuleSet.PropertyAttributeRule - Class in org.apache.velocity.tools.config
 
XmlFactoryConfigurationRuleSet.PropertyAttributeRule() - Constructor for class org.apache.velocity.tools.config.XmlFactoryConfigurationRuleSet.PropertyAttributeRule
 
XmlTool - Class in org.apache.velocity.tools.generic
Tool for reading/navigating XML files.
XmlTool() - Constructor for class org.apache.velocity.tools.generic.XmlTool
 
XmlTool(Node) - Constructor for class org.apache.velocity.tools.generic.XmlTool
 
XmlTool(List<Node>) - Constructor for class org.apache.velocity.tools.generic.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
XmlTool.NodeIterator(Iterator<Node>) - Constructor for class org.apache.velocity.tools.generic.XmlTool.NodeIterator
 
XMLToolboxManager - Class in org.apache.velocity.tools.view
Deprecated. Use XmlFactoryConfiguration
XMLToolboxManager() - Constructor for class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated. Default constructor

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-2011 The Apache Software Foundation. All Rights Reserved.