类 ConfigurationUtils
java.lang.Object
org.apache.velocity.tools.config.ConfigurationUtils
Utility methods for handling tool configurations.
- 版本:
- $Id: ConfigurationUtils.java 511959 2007-02-26 19:24:39Z nbubna $
- 作者:
- Nathan Bubna
-
字段概要
字段 -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明static void
clean
(Configuration config) Convenience method that automatically creates a newConfigurationCleaner
and applies it to the specifiedConfiguration
.static ToolboxFactory
Returns a new, standardToolboxFactory
configured with the results of bothgetAutoLoaded()
andfindFromSystemProperty()
.static FactoryConfiguration
Searches for a configuration file at the specified path and returns it in the form of aFactoryConfiguration
.static FactoryConfiguration
Returns aFactoryConfiguration
loaded from the path specified in the "org.apache.velocity.tools" system property (if any).static FactoryConfiguration
findInClasspath
(String path) static FactoryConfiguration
findInClasspath
(String path, Object caller) Searches the classpath for a configuration file matching the specified path.static FactoryConfiguration
findInFileSystem
(String path) Searches the file system for a configuration file matching the specified path.static FactoryConfiguration
Returns aFactoryConfiguration
including allgetDefaultTools()
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.static FactoryConfiguration
getAutoLoaded
(boolean includeDefaults) Returns aFactoryConfiguration
composed, in order of the following configurations:getDefaultTools()
(only if includeDefaults istrue
) 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 benull
.static FactoryConfiguration
Returns the "default"FactoryConfiguration
.static FactoryConfiguration
getFromClass
(Class factory) static FactoryConfiguration
getFromClass
(String classname) static FactoryConfiguration
Returns aFactoryConfiguration
including all default "GenericTools" available and no others.static FactoryConfiguration
Returns aFactoryConfiguration
including all default "VelocityStruts" tools available as well as the default "VelocityView" tools and "GenericTools".static FactoryConfiguration
Returns aFactoryConfiguration
including all default "VelocityView" tools available as well as the default "GenericTools".static FactoryConfiguration
Returns aFactoryConfiguration
loaded from a configuration file at the specified path.static FactoryConfiguration
Returns aFactoryConfiguration
read from a known configuration file type at the specifiedURL
.
-
字段详细资料
-
构造器详细资料
-
ConfigurationUtils
private ConfigurationUtils()
-
-
方法详细资料
-
getInstance
-
getDefaultTools
Returns the "default"FactoryConfiguration
. This includes all the standard tools developed by this project and available in the jar being used. In other words, if the velocity-tools-generic-2.x.jar is being used, then only the generic tools will be included. If the velocity-tools-struts-2.x.jar is being used, then all VelocityTools will be available. This also means that subclasses in the larger jars will override their superclasses. So, if you are using the VelocityStruts jar, then your $link reference will be a StrutsLinkTool. If you are using the VelocityView jar, it will be a standard LinkTool. -
getGenericTools
Returns aFactoryConfiguration
including all default "GenericTools" available and no others. -
getVelocityView
Returns aFactoryConfiguration
including all default "VelocityView" tools available as well as the default "GenericTools". -
getVelocityStruts
Returns aFactoryConfiguration
including all default "VelocityStruts" tools available as well as the default "VelocityView" tools and "GenericTools". -
getAutoLoaded
Returns aFactoryConfiguration
including allgetDefaultTools()
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
Returns aFactoryConfiguration
composed, in order of the following configurations:getDefaultTools()
(only if includeDefaults istrue
)- 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)
null
. -
findFromSystemProperty
Returns aFactoryConfiguration
loaded from the path specified in the "org.apache.velocity.tools" system property (if any). If no such property has been setnull
will be returned.- 抛出:
org.apache.velocity.exception.ResourceNotFoundException
- if the system property has a value but no configuration file was found at the specified location
-
createFactory
Returns a new, standardToolboxFactory
configured with the results of bothgetAutoLoaded()
andfindFromSystemProperty()
. -
clean
Convenience method that automatically creates a newConfigurationCleaner
and applies it to the specifiedConfiguration
. -
load
Returns aFactoryConfiguration
loaded from a configuration file at the specified path. If no such file is found at that path, this will throw aResourceNotFoundException
.- 另请参阅:
-
find
Searches for a configuration file at the specified path and returns it in the form of aFactoryConfiguration
. This method will look for a matching file in both the classpath and the file system. If perchance a match is found in both, then both are loaded and the configuration loaded from the file system is given precedence (i.e. it is added onto the other). If no match is found in either, then this will returnnull
. -
findInFileSystem
Searches the file system for a configuration file matching the specified path. If found, it will read and return it as aFactoryConfiguration
. If not found, this will returnnull
.- 抛出:
IllegalStateException
- if the file exists, but its path could not be converted to a URL for reading.
-
findInClasspath
-
findInClasspath
Searches the classpath for a configuration file matching the specified path. If found, it will read and return it as aFactoryConfiguration
. If not found, this will returnnull
. If there are multiple matching resources in the classpath, then they will be added together in the order found (i.e. the last one will have precedence). -
read
Returns aFactoryConfiguration
read from a known configuration file type at the specifiedURL
. If the file is missing or unreadable, this will simply returnnull
(i.e. if an IOException is thrown).- 抛出:
UnsupportedOperationException
- if the file type (identified via suffix) is neither ".xml" or ".properties"
-
getFromClass
-
getFromClass
-