meka.core

Class PropsUtils

java.lang.Object

meka.core.PropsUtils

public class PropsUtils
extends Object

Utility class for props files.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG whether to output some debug information.

Constructor Summary

Constructors

Constructor and Description
PropsUtils()

Method Summary

Modifier and Type	Method and Description
static Properties	collapse(Properties props) Collapses all the inherited and current properties into a single Properties object and returns it.
static URL[]	find(String props) Locates the properties file in the current classpath.
static void	main(String[] args) Allows some basic operations on properties files: read <props>- reads the specified props file and outputs it, e.g., "read meka/gui/goe/MekaEditors.props" find <props>- finds all occurrences of the specified props file and outputs them, e.g., "find meka/gui/goe/MekaEditors.props"
protected static void	printUsage() Prints the usage of this class from the commandline to stdout.
static Properties	read(String props) Reads properties that inherit from three locations.
static String	toString(Properties props, String comment) Outputs the properties as they would be written to a file.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

whether to output some debug information.

Constructor Detail

PropsUtils

public PropsUtils()

Method Detail

read

public static Properties read(String props)
                       throws Exception

Reads properties that inherit from three locations. Properties are first defined in the system resource location (i.e. in the CLASSPATH). These default properties must exist. Properties optionally defined in the user properties location (WekaPackageManager.PROPERTIES_DIR) override default settings. Properties defined in the current directory (optional) override all these settings.

Parameters:

props - the location of the props file that should be loaded. e.g.: "weka/core/Utils.props".

Returns:

the Properties

Throws:

Exception - if an error occurs reading the properties files.

See Also:

Utils.readProperties(String)

find

public static URL[] find(String props)

Locates the properties file in the current classpath.

Parameters:

props - the props file to locate

Returns:

the URLs where the props file was found

collapse

public static Properties collapse(Properties props)

Collapses all the inherited and current properties into a single Properties object and returns it.

Parameters:

props - the properties to collapse

Returns:

the collapsed version of this Properties object

toString

public static String toString(Properties props,
                              String comment)

Outputs the properties as they would be written to a file.

Parameters:

props - the properties to turn into a string

comment - the comment to output

Returns:

the generated output or null in case of an error

printUsage

protected static void printUsage()

Prints the usage of this class from the commandline to stdout.

main

public static void main(String[] args)
                 throws Exception

Allows some basic operations on properties files:

• read <props>- reads the specified props file and outputs it, e.g., "read meka/gui/goe/MekaEditors.props"
• find <props>- finds all occurrences of the specified props file and outputs them, e.g., "find meka/gui/goe/MekaEditors.props"

Throws:

Exception