类 ToolConfiguration
java.lang.Object
org.apache.velocity.tools.config.Configuration
org.apache.velocity.tools.config.ToolConfiguration
- 所有已实现的接口:
Comparable<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 calling
createInfo()
.
Most users will not find themselves directly using the API of this class.
- 版本:
- $Id: ToolConfiguration.java 511959 2007-02-26 19:24:39Z nbubna $
- 作者:
- Nathan Bubna
-
嵌套类概要
嵌套类 -
字段概要
字段 -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明void
addConfiguration
(Configuration config) int
compareTo
(Configuration conf) private void
digForDependencies
(Class clazz) boolean
Returns the default key value for the set tool class.private final String
getError
(ToolConfiguration.Status status) String[]
getKey()
Returns the key set for this tool.private final ToolConfiguration.Status
String[]
int
hashCode()
void
void
setClassname
(String classname) void
void
setRestrictTo
(String path) void
setSkipSetters
(Boolean cfgOnly) toString()
void
validate()
从类继承的方法 org.apache.velocity.tools.config.Configuration
addProperty, appendProperties, getProperties, getProperty, getPropertyMap, hasProperties, removeProperty, removeProperty, setProperties, setProperty, setPropertyMap
-
字段详细资料
-
key
-
classname
-
restrictTo
-
skipSetters
-
status
-
problem
-
-
构造器详细资料
-
ToolConfiguration
public ToolConfiguration()
-
-
方法详细资料
-
setKey
-
setClass
-
setClassname
-
setRestrictTo
-
setSkipSetters
-
getKey
Returns the key set for this tool. If no key has been explicitly set, this will return the result ofgetDefaultKey()
. -
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
-
getToolClass
-
getInvalidScopes
-
getValidScopes
-
getStatus
-
digForDependencies
-
getRestrictTo
-
getSkipSetters
-
createInfo
-
getError
-
addConfiguration
- 覆盖:
addConfiguration
在类中Configuration
-
validate
public void validate()- 覆盖:
validate
在类中Configuration
-
compareTo
- 指定者:
compareTo
在接口中Comparable<Configuration>
- 覆盖:
compareTo
在类中Configuration
-
hashCode
public int hashCode()- 覆盖:
hashCode
在类中Configuration
-
equals
- 覆盖:
equals
在类中Configuration
-
toString
-