Package org.apache.velocity.tools.config
Class ToolConfiguration
- java.lang.Object
-
- org.apache.velocity.tools.config.Configuration
-
- org.apache.velocity.tools.config.ToolConfiguration
-
- All Implemented Interfaces:
java.lang.Comparable<Configuration>
public class ToolConfiguration extends Configuration
This class handles configuration info for tools, including their key, classname, path restriction, and properties. It also does fairly aggresive validation and is able to identify if the tool is "old" (i.e. designed for VelocityTools 1.x). Once configuration is complete, a
ToolInfo
instance can be created by callingcreateInfo()
.Most users will not find themselves directly using the API of this class.
- Version:
- $Id: ToolConfiguration.java 511959 2007-02-26 19:24:39Z nbubna $
- Author:
- Nathan Bubna
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
ToolConfiguration.Status
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
classname
private java.lang.String
key
private java.lang.Throwable
problem
private java.lang.String
restrictTo
private java.lang.Boolean
skipSetters
private ToolConfiguration.Status
status
-
Constructor Summary
Constructors Constructor Description ToolConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addConfiguration(Configuration config)
int
compareTo(Configuration conf)
ToolInfo
createInfo()
private void
digForDependencies(java.lang.Class clazz)
boolean
equals(java.lang.Object obj)
java.lang.String
getClassname()
java.lang.String
getDefaultKey()
Returns the default key value for the set tool class.private java.lang.String
getError(ToolConfiguration.Status status)
java.lang.String[]
getInvalidScopes()
java.lang.String
getKey()
Returns the key set for this tool.java.lang.String
getRestrictTo()
java.lang.Boolean
getSkipSetters()
private ToolConfiguration.Status
getStatus()
java.lang.Class
getToolClass()
java.lang.String[]
getValidScopes()
int
hashCode()
void
setClass(java.lang.Class clazz)
void
setClassname(java.lang.String classname)
void
setKey(java.lang.String key)
void
setRestrictTo(java.lang.String path)
void
setSkipSetters(java.lang.Boolean cfgOnly)
java.lang.String
toString()
void
validate()
-
Methods inherited from class org.apache.velocity.tools.config.Configuration
addProperty, appendProperties, getProperties, getProperty, getPropertyMap, hasProperties, removeProperty, removeProperty, setProperties, setProperty, setPropertyMap
-
-
-
-
Field Detail
-
key
private java.lang.String key
-
classname
private java.lang.String classname
-
restrictTo
private java.lang.String restrictTo
-
skipSetters
private java.lang.Boolean skipSetters
-
status
private ToolConfiguration.Status status
-
problem
private java.lang.Throwable problem
-
-
Method Detail
-
setKey
public void setKey(java.lang.String key)
-
setClass
public void setClass(java.lang.Class clazz)
-
setClassname
public void setClassname(java.lang.String classname)
-
setRestrictTo
public void setRestrictTo(java.lang.String path)
-
setSkipSetters
public void setSkipSetters(java.lang.Boolean cfgOnly)
-
getKey
public java.lang.String getKey()
Returns the key set for this tool. If no key has been explicitly set, this will return the result ofgetDefaultKey()
.
-
getDefaultKey
public java.lang.String getDefaultKey()
Returns the default key value for the set tool class. First, this looks for aDefaultKey
annotation on the tool class. Then, if there is no default key annotation, theClass.getSimpleName()
is transformed into the key by removing any 'Tool' suffix and lowercasing the first character. This will only returnnull
if there is both no key and no classname set for this tool.
-
getClassname
public java.lang.String getClassname()
-
getToolClass
public java.lang.Class getToolClass()
-
getInvalidScopes
public java.lang.String[] getInvalidScopes()
-
getValidScopes
public java.lang.String[] getValidScopes()
-
getStatus
private final ToolConfiguration.Status getStatus()
-
digForDependencies
private void digForDependencies(java.lang.Class clazz)
-
getRestrictTo
public java.lang.String getRestrictTo()
-
getSkipSetters
public java.lang.Boolean getSkipSetters()
-
createInfo
public ToolInfo createInfo()
-
getError
private final java.lang.String getError(ToolConfiguration.Status status)
-
addConfiguration
public void addConfiguration(Configuration config)
- Overrides:
addConfiguration
in classConfiguration
-
validate
public void validate()
- Overrides:
validate
in classConfiguration
-
compareTo
public int compareTo(Configuration conf)
- Specified by:
compareTo
in interfacejava.lang.Comparable<Configuration>
- Overrides:
compareTo
in classConfiguration
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classConfiguration
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classConfiguration
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-