org.melati.util
Class PropertiesUtils

java.lang.Object
  org.melati.util.PropertiesUtils

public final class PropertiesUtils
extends java.lang.Object

Useful things to do with properties files.

Method Summary

static java.util.Properties	fromFile(java.io.File path) Get a Properties object from a file.
static java.util.Properties	fromResource(java.lang.Class clazz, java.lang.String name) Get a Properties object from a Class.
static int	getOrDefault_int(java.util.Properties properties, java.lang.String propertyName, int def) Get an Integer property from a Properties object or make a fuss.
static java.lang.String	getOrDefault(java.util.Properties properties, java.lang.String propertyName, java.lang.String def) Get a property or return the supplied default.
static int	getOrDie_int(java.util.Properties properties, java.lang.String propertyName) Get an Integer property.
static java.lang.String	getOrDie(java.util.Properties properties, java.lang.String propertyName) Return a property.
static java.lang.Object	instanceOfNamedClass(java.util.Properties properties, java.lang.String propertyName, java.lang.String interfaceClassName, java.lang.String defaultName) Instantiate a Class.
static java.lang.Object	instanceOfNamedClass(java.lang.String className, java.lang.String interfaceClassName) Instantiate an interface.

Methods inherited from class java.lang.Object

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

Method Detail

fromFile

public static java.util.Properties fromFile(java.io.File path)
                                     throws java.io.IOException

Get a Properties object from a file.

Parameters:

path - a File path name

Returns:

a Properties object

Throws:

java.io.IOException - if there is a problem loading the file

fromResource

public static java.util.Properties fromResource(java.lang.Class clazz,
                                                java.lang.String name)
                                         throws java.io.IOException

Get a Properties object from a Class.

Parameters:

clazz - the Class to look up

name - the property file name

Returns:

a Properties object

Throws:

java.io.IOException - if the file cannot load or is not found

getOrDie

public static java.lang.String getOrDie(java.util.Properties properties,
                                        java.lang.String propertyName)
                                 throws NoSuchPropertyException

Return a property.

Parameters:

properties - the Properties object to look in

propertyName - the property to get

Returns:

the property value

Throws:

NoSuchPropertyException - if the property is not set

getOrDefault

public static java.lang.String getOrDefault(java.util.Properties properties,
                                            java.lang.String propertyName,
                                            java.lang.String def)

Get a property or return the supplied default.

Parameters:

properties - the Properties object to look in

propertyName - the property to get

def - the default to return if not found

Returns:

the property value

getOrDie_int

public static int getOrDie_int(java.util.Properties properties,
                               java.lang.String propertyName)
                        throws NoSuchPropertyException,
                               FormatPropertyException

Get an Integer property.

Parameters:

properties - the Properties object to look in

propertyName - the property to get

Returns:

the int property value

Throws:

NoSuchPropertyException - if it is not found

FormatPropertyException - if it is not an Integer

getOrDefault_int

public static int getOrDefault_int(java.util.Properties properties,
                                   java.lang.String propertyName,
                                   int def)
                            throws FormatPropertyException

Get an Integer property from a Properties object or make a fuss.

Parameters:

properties - a Properties

propertyName - the name of the property

def - cater for multiple definitions, with increment numbers

Returns:

the property as an int

Throws:

FormatPropertyException - if it is not an Integer

instanceOfNamedClass

public static java.lang.Object instanceOfNamedClass(java.lang.String className,
                                                    java.lang.String interfaceClassName)
                                             throws InstantiationPropertyException

Instantiate an interface.

Parameters:

className - the name of the class

interfaceClassName - the interface Class name

Returns:

a new object

Throws:

InstantiationPropertyException - if the named class does not descend from the interface

instanceOfNamedClass

public static java.lang.Object instanceOfNamedClass(java.util.Properties properties,
                                                    java.lang.String propertyName,
                                                    java.lang.String interfaceClassName,
                                                    java.lang.String defaultName)
                                             throws InstantiationPropertyException

Instantiate a Class.

Parameters:

properties - a Properties

propertyName - the name of the property

interfaceClassName - the interface name

defaultName - a default concrete class if the property is undefined

Returns:

a new Object

Throws:

InstantiationPropertyException - if there is a problem