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
 
abbreviate - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
 
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.
acceptLanguage - Variable in class org.apache.velocity.tools.view.BrowserTool
 
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
 
actionComparator - Static variable in class org.apache.velocity.tools.struts.ValidatorTool
A Comparator to use when sorting ValidatorAction objects.
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...)
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.
addedDefaults - Variable in class org.apache.velocity.tools.config.EasyFactoryConfiguration
 
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
 
addFileFromGroup(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.
addRequestParams(boolean, String...) - Method in class org.apache.velocity.tools.view.LinkTool
 
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.
addResource(String, Set<String>, Class) - Static method in class org.apache.velocity.tools.ClassUtils
 
addResources(String, Set<String>, ClassLoader) - Static method in class org.apache.velocity.tools.ClassUtils
 
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
 
addToList(List, Object) - Method in class org.apache.velocity.tools.generic.LinkTool
 
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.
addType(Set<Class>, Class) - Method in class org.apache.velocity.tools.generic.ClassTool
 
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 - Variable in class org.apache.velocity.tools.generic.ValueParser
 
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
 
appendParam(String, Object) - Method in class org.apache.velocity.tools.generic.LinkTool
 
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.ToolManager
 
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
 
application - Variable in class org.apache.velocity.tools.view.ViewToolContext
 
APPLICATION_SCOPE - Static variable in class org.apache.velocity.tools.struts.TilesTool
 
appTools - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated.  
appToolsPublished - Variable in class org.apache.velocity.tools.view.ViewToolManager
 
args - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
args - Variable in class org.apache.velocity.tools.struts.MessageTool.TextKey
 
arrayContains(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Checks if an array contains a certain element.
attr(Object, Object) - Method in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
attr(Object) - Method in class org.apache.velocity.tools.generic.XmlTool
Returns the value of the specified attribute for the first/sole Node in the internal Node list for this instance, if that Node is an Element.
attributes - Variable in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
attributes() - Method in class org.apache.velocity.tools.generic.XmlTool
Returns a Map of all attributes for the first/sole Node held internally by this instance.
auto - Variable in class org.apache.velocity.tools.generic.Alternator
 
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. 
autoAlternateDefault - Variable in class org.apache.velocity.tools.generic.AlternatorTool
 
autoConfigure(boolean) - Method in class org.apache.velocity.tools.ToolManager
 
autoConfigure(boolean) - Method in class org.apache.velocity.tools.view.ViewToolManager
 
autoIgnore - Variable in class org.apache.velocity.tools.view.tools.LinkTool
Deprecated.  
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
 
bos - Variable in class org.apache.velocity.tools.view.ImportSupport.ImportResponseWrapper
A buffer, alternatively, to accumulate bytes.
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
 
bufferOutput - 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 - Variable in class org.apache.velocity.tools.struts.MessageTool.TextKey
 
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.
bundleName - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
bundles - Variable in class org.apache.velocity.tools.generic.ResourceTool
 
bundles - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
BUNDLES_KEY - Static variable in class org.apache.velocity.tools.generic.ResourceTool
 

C

cache - Variable in class org.apache.velocity.tools.Toolbox
 
cache - Variable in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
cache(String, String) - Method in class org.apache.velocity.tools.view.jsp.VelocityViewTag
 
cached - Variable in class org.apache.velocity.tools.generic.ResourceTool.Key
 
cacheData(Map<String, Object>) - Method in class org.apache.velocity.tools.Toolbox
 
cachedNext - Variable in class org.apache.velocity.tools.generic.IteratorTool
Deprecated.  
cacheNext(boolean) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
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.generic.RenderTool
 
catchExceptions - Variable in class org.apache.velocity.tools.struts.TilesTool
Indicates if there is a MethodExceptionEventHandler present
category - Variable in class org.apache.velocity.tools.generic.log.LogChuteCommonsLog
 
cdata - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
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 - Variable in class org.apache.velocity.tools.config.CompoundConfiguration
 
children - Variable in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
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.
classes - Variable in class org.apache.velocity.tools.generic.MarkupTool.Tag
 
classname(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
classname - Variable in class org.apache.velocity.tools.config.ToolConfiguration
 
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.
ClassUtils() - Constructor for class org.apache.velocity.tools.ClassUtils
 
clazz - Variable in class org.apache.velocity.tools.generic.FieldTool.MutableField
 
clazz - Variable in class org.apache.velocity.tools.ToolInfo
 
clazz - Variable in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
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(MarkupTool.Mode, MarkupTool.Tag, StringBuilder, boolean) - Method in class org.apache.velocity.tools.generic.MarkupTool
 
clear() - Method in class org.apache.velocity.tools.generic.ValueParser
 
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.
close() - Method in class org.apache.velocity.tools.view.ImportSupport.SafeClosingHttpURLConnectionReader
 
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
 
CommonsLogLogSystem - Class in org.apache.velocity.tools.generic.log
Deprecated. Use CommonsLogLogChute in Velocity 1.6 instead.
CommonsLogLogSystem() - Constructor for class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Deprecated.  
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.
conditions - Variable in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
config - Variable in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyWrap
 
config - Variable in class org.apache.velocity.tools.view.VelocityViewFilter
 
CONFIG_FACTORY_METHOD - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
 
configLocked - Variable in class org.apache.velocity.tools.generic.SafeConfig
 
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(Configuration, Throwable) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationException(Configuration, String) - Constructor for exception org.apache.velocity.tools.config.ConfigurationException
 
ConfigurationUtils - Class in org.apache.velocity.tools.config
Utility methods for handling tool configurations.
ConfigurationUtils() - Constructor for class org.apache.velocity.tools.config.ConfigurationUtils
 
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 - Variable in class org.apache.velocity.tools.ToolInfo
 
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 - Variable in class org.apache.velocity.tools.view.ViewToolInfo
Deprecated.  
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.
contains(String[], String) - Method in class org.apache.velocity.tools.view.LinkTool
 
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.generic.RenderTool
 
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 - Variable in class org.apache.velocity.tools.view.UiDependencyTool
 
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
 
contextKey - 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.
ConversionUtils() - Constructor for class org.apache.velocity.tools.ConversionUtils
 
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 - Variable in class org.apache.velocity.tools.config.Data
 
converter - Variable in enum org.apache.velocity.tools.config.Data.Type
 
converter(String) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
converter(Class) - Method in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
convertList(Object) - Method in class org.apache.velocity.tools.config.Data
 
convertValue(Object) - Method in class org.apache.velocity.tools.config.Data
 
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
 
count - Variable in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
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.
createSession - Variable in class org.apache.velocity.tools.view.PagerTool
 
createSession - Variable in class org.apache.velocity.tools.view.servlet.ServletToolboxManager
Deprecated.  
createSession - Variable in class org.apache.velocity.tools.view.ViewToolManager
 
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.
createView(JeeConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
createView(Class, JeeConfig) - Static method in class org.apache.velocity.tools.view.ServletUtils
 
crit - Variable in class org.apache.velocity.tools.view.AbstractSearchTool.StoredResults
 
criteria - Variable in class org.apache.velocity.tools.view.AbstractSearchTool
 
criteriaKey - Variable in class org.apache.velocity.tools.view.AbstractSearchTool
 
currency(Object) - Method in class org.apache.velocity.tools.generic.NumberTool
Convenience method equivalent to $number.format("currency", $foo).
current - Variable in class org.apache.velocity.tools.generic.LoopTool.SyncedIterator
 
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 - Variable in class org.apache.velocity.tools.config.FactoryConfiguration
 
data - Variable in class org.apache.velocity.tools.ToolboxFactory
 
data - Variable in class org.apache.velocity.tools.view.DataInfo
Deprecated.  
data - Variable in class org.apache.velocity.tools.view.XMLToolboxManager
Deprecated.  
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)).
Data.Type(Class, Converter) - Constructor for enum org.apache.velocity.tools.config.Data.Type
 
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
 
dateFormat - 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
 
datum - Variable in class org.apache.velocity.tools.config.EasyFactoryConfiguration.EasyData
 
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) - Method in class org.apache.velocity.tools.generic.RenderTool
 
debug(String, Throwable) - Method in class org.apache.velocity.tools.generic.RenderTool
 
debug(String, Object...) - Method in class org.apache.velocity.tools.ToolManager
 
debug(String, Object...) - Method in class org.apache.velocity.tools.view.UiDependencyTool
 
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_LOG_NAME - Static variable in class org.apache.velocity.tools.generic.log.CommonsLogLogSystem
Deprecated. Default name for the commons-logging instance
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_PREFIX - Static variable in class org.apache.velocity.tools.config.LogSupport
 
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
 
DEFAULT_TYPES - Static variable in class org.apache.velocity.tools.view.UiDependencyTool
 
defaultAllowedTags - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultAlternate - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultBundle - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
defaultCellLength - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultCellSuffix - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultContentType - Variable in class org.apache.velocity.tools.view.VelocityView
 
defaultDelim - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultFinalDelim - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
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
 
defaultTruncateAtWord - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultTruncateLength - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
defaultTruncateSuffix - Variable in class org.apache.velocity.tools.generic.DisplayTool
 
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.
delim - Variable in class org.apache.velocity.tools.generic.MarkupTool
 
dependencies - Variable in class org.apache.velocity.tools.view.UiDependencyTool
 
dependencies - Variable in class org.apache.velocity.tools.view.UiDependencyTool.Group
 
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.
deprecationSupportMode - Variable in class org.apache.velocity.tools.generic.ResourceTool
 
deprecationSupportMode - Variable in class org.apache.velocity.tools.view.VelocityView
 
depth(int) - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Set the maximum number of units to render for this comparison.
depth - Variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
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.
digForDependencies(Class) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
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
 
enabled - Variable in class org.apache.velocity.tools.view.ServletLogChute
Deprecated.  
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.generic.RenderTool
 
engine - Variable in class org.apache.velocity.tools.view.IncludeTool
 
ENGINE_KEY - Static variable in class org.apache.velocity.tools.ToolContext
 
entrySet() - Method in class org.apache.velocity.tools.generic.ValueParser
 
EQUAL_KEY - Static variable in class org.apache.velocity.tools.generic.ComparisonDateTool
 
equals(Object) - Method in class org.apache.velocity.tools.config.CompoundConfiguration
 
equals(Object) - Method in class org.apache.velocity.tools.config.Configuration
 
equals(Object) - Method in class org.apache.velocity.tools.config.Data
 
equals(Object) - Method in class org.apache.velocity.tools.config.FactoryConfiguration
This will consider the object equal if it is a FactoryConfiguration and whose FactoryConfiguration.toString(boolean) method, when passed false, returns a String equal to that returned by a call to toString(false) on this instance.
equals(Object) - Method in class org.apache.velocity.tools.config.ToolboxConfiguration
 
equals(Object) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
equals(Object) - Method in class org.apache.velocity.tools.generic.ClassTool.Sub
 
equals(Object) - Method in class org.apache.velocity.tools.generic.LinkTool
This instance is considered equal to any LinkTool instance whose toString() method returns a String equal to that returned by this instance's toString()
equals(Object, Object) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Check if two objects are equal.
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
 
exactPath - Variable in class org.apache.velocity.tools.view.servlet.ServletToolInfo
Deprecated.  
exclude(Object) - Method in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
Directs this instance to completely exclude any elements equal to the specified Object.
execute(Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.GetAttributeExecutor
 
execute(Object, Object) - Method in class org.apache.velocity.tools.view.WebappUberspector.SetAttributeExecutor
 
executeQuery(Object) - Method in class org.apache.velocity.tools.view.AbstractSearchTool
Executes a query for the specified criteria.
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.
expandSingletonArrays(Map<String, Object>) - Method in class org.apache.velocity.tools.view.ParameterTool
 

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.
fallbackVersion - Static variable in class org.apache.velocity.tools.view.BrowserTool
 
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
 
field - Variable in class org.apache.velocity.tools.generic.FieldTool.MutableField
 
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
 
filterLanguageTag(String) - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.
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
 
firefoxVersion - Static variable in class org.apache.velocity.tools.view.BrowserTool
 
first - Variable in class org.apache.velocity.tools.generic.LoopTool.ManagedIterator
 
floor(Object) - Method in class org.apache.velocity.tools.generic.MathTool
 
FORCE_RELATIVE_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
 
forceRelative - Variable in class org.apache.velocity.tools.generic.LinkTool
 
forceThreadSafe - Variable in class org.apache.velocity.tools.generic.RenderTool
 
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 - Variable in class org.apache.velocity.tools.generic.FormatConfig
 
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 - Variable in class org.apache.velocity.tools.view.UiDependencyTool.Type
 
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
 
formName - Variable in class org.apache.velocity.tools.struts.ValidatorTool
 
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
 
fragment - Variable in class org.apache.velocity.tools.generic.LinkTool
 
FRAGMENT_KEY - Static variable in class org.apache.velocity.tools.generic.LinkTool
 

G

geckoMajorVersion - Variable in class org.apache.velocity.tools.view.BrowserTool
 
geckoMinorVersion - Variable in class org.apache.velocity.tools.view.BrowserTool
 
geckoVersion - Variable in class org.apache.velocity.tools.view.BrowserTool
 
GENERIC_DEFAULTS_PATH - Static variable in class org.apache.velocity.tools.config.ConfigurationUtils
 
genericVersion - Static variable in class org.apache.velocity.tools.view.BrowserTool
 
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 - Variable in class org.apache.velocity.tools.struts.StrutsLinkTool
 
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
 
getActionConfig(ServletContext, String) - Static method in class org.apache.velocity.tools.struts.SecureLinkTool
Finds the configuration definition for the specified action link
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.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.
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
 
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
 
getCachedFile(String, String) - Method in class org.apache.velocity.tools.view.WebappResourceLoader
 
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().
getCallerLoader(Object) - Static method in class org.apache.velocity.tools.ClassUtils
 
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.
getClassLoader() - Static method in class org.apache.velocity.tools.ClassUtils
 
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.
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 (!).
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
 
getError(ToolConfiguration.Status) - Method in class org.apache.velocity.tools.config.ToolConfiguration
 
getErrors(HttpServletRequest) - Static method in class org.apache.velocity.tools.struts.StrutsUtils
Returns the Struts errors for this request or null if none exist.
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.
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
 
getFromArray(Object, int) - Method in class org.apache.velocity.tools.generic.ListTool
Deprecated. Gets the specified element of an array.
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
 
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
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.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
 
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.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
 
getReadOnly() - Method in class org.apache.velocity.tools.generic.ValueParser
Is the Map read-only?
getRelative() - Method in class org.apache.velocity.tools.generic.ComparisonDateTool.Comparison
Sets this comparison to be rendered as if it where generated using the ComparisonDateTool.whenIs(Object now, Object then) method.
getReliant() - Method in class org.apache.velocity.tools.view.BrowserTool
 
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.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 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.
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 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.ViewToolContext
Returns the current session, if any.
getSessionToolbox() - Method in class org.apache.velocity.tools.view.ViewToolManager
 
getShowDeprecated() - Method in class org.apache.velocity.tools.generic.ClassTool
Returns the current showDeprecated setting.
getSignature() - Method in class org.apache.velocity.tools.generic.ClassTool.CallableSub
 
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
 
getStartElement() - Method in class org.apache.velocity.tools.struts.ValidatorTool
Constructs the beginning
Copyright (c) 2003-2007 Apache Software Foundation