Package ubic.basecode.util

Class ConfigUtils

java.lang.Object

ubic.basecode.util.ConfigUtils

public class ConfigUtils
extends Object

Convenience methods for loading configurations

Author:

Paul

Constructor Summary

Constructors

Constructor	Description
ConfigUtils()

Method Summary

Modifier and Type	Method	Description
static org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<org.apache.commons.configuration2.PropertiesConfiguration>	getConfigBuilder(File file)
static org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<org.apache.commons.configuration2.PropertiesConfiguration>	getConfigBuilder(String name)
static org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<org.apache.commons.configuration2.PropertiesConfiguration>	getConfigBuilder(URL url)
static org.apache.commons.configuration2.PropertiesConfiguration	loadClasspathConfig(String name)
static org.apache.commons.configuration2.PropertiesConfiguration	loadConfig(File file)
static org.apache.commons.configuration2.PropertiesConfiguration	loadConfig(String name)
static org.apache.commons.configuration2.PropertiesConfiguration	loadConfig(URL url)
static URL	locate(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigUtils

public ConfigUtils()

Method Detail

getConfigBuilder

public static org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<org.apache.commons.configuration2.PropertiesConfiguration> getConfigBuilder(File file)
                                                                                                                                                           throws org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

file -

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

getConfigBuilder

public static org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<org.apache.commons.configuration2.PropertiesConfiguration> getConfigBuilder(String name)
                                                                                                                                                           throws org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

name - If the file does not exist, attempts to create it in the user's home directory.

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

getConfigBuilder

public static org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder<org.apache.commons.configuration2.PropertiesConfiguration> getConfigBuilder(URL url)
                                                                                                                                                           throws org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

url -

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

loadClasspathConfig

public static org.apache.commons.configuration2.PropertiesConfiguration loadClasspathConfig(String name)
                                                                                     throws org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

name - the classpath location, such as "project.properties" in the base package, or org/foo/project.properties.

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

loadConfig

public static org.apache.commons.configuration2.PropertiesConfiguration loadConfig(File file)
                                                                            throws org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

file -

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

loadConfig

public static org.apache.commons.configuration2.PropertiesConfiguration loadConfig(String name)
                                                                            throws org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

name - If the file does not exist, attempts to create it in the user's home directory.

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

loadConfig

public static org.apache.commons.configuration2.PropertiesConfiguration loadConfig(URL url)
                                                                            throws org.apache.commons.configuration2.ex.ConfigurationException

Parameters:

url -

Returns:

Throws:

org.apache.commons.configuration2.ex.ConfigurationException

locate

public static URL locate(String name)