org.attribyte.util

Class InitUtil

java.lang.Object

org.attribyte.util.InitUtil

public class InitUtil
extends java.lang.Object

Convenience methods for initializing from properties.

Author:

Matt Hamer - Attribyte, LLC.

Constructor Summary

Constructors

Constructor and Description
InitUtil(java.lang.String prefix, java.util.Properties props) Creates a properties init util with case-insensitive names.
InitUtil(java.lang.String prefix, java.util.Properties props, boolean lowercaseNames)

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	fromCommandLine(java.lang.String[] args, java.util.Properties props) Processes command-line arguments by treating those beginning with '-' as properties of the format -[name]=[value].
int	getIntProperty(java.lang.String propertyName, int defaultValue) Gets a property as an integer.
int	getIntProperty(java.lang.String propertyName, int index, int defaultValue) Gets a multi-valued integer property.
long	getLongProperty(java.lang.String propertyName, long defaultValue) Gets a property as a long.
java.util.Properties	getProperties() Gets new properties containing only those that begin with the initialized prefix.
java.lang.String	getProperty(java.lang.String propertyName) Gets a property.
java.lang.String	getProperty(java.lang.String propertyName, int index, java.lang.String defaultValue) Gets a multi-valued property.
java.lang.String	getProperty(java.lang.String propertyName, java.lang.String defaultValue) Gets a property.
boolean	hasProperty(java.lang.String propertyName) Determine if a non-empty property exists.
java.lang.Object	initClass(java.lang.String propertyName, java.lang.Class<?> expectedClass) Create an instance of a class.
java.util.List<java.lang.Object>	initClassList(java.lang.String propertyName, java.lang.Class<?> expectedClass) Creates a list of instances of a class.
static long	millisFromTime(java.lang.String time) Gets a time in milliseconds from a string that allows the units 'ms', 's', 'm', 'h', 'd' at the end.
java.util.Map<java.lang.String,java.util.Properties>	split() Gets a map of properties vs name where name is supplied as a prefix, e.g.
void	throwPositiveIntRequiredException(java.lang.String propertyName) Throws initialization exception indicating property is not a positive integer.
void	throwRequiredException(java.lang.String propertyName) Throws initialization exception indicating property is required.
static java.util.Collection<Pair<java.lang.String,java.lang.String>>	toPairCollection(java.util.Properties props) Convert properties to a collection of string pairs.

Methods inherited from class java.lang.Object

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

Constructor Detail

InitUtil

public InitUtil(java.lang.String prefix,
                java.util.Properties props)

Creates a properties init util with case-insensitive names.

Parameters:

prefix - The prefix appended to all property names.

props - The properties.

InitUtil

public InitUtil(java.lang.String prefix,
                java.util.Properties props,
                boolean lowercaseNames)

Method Detail

getProperties

public java.util.Properties getProperties()

Gets new properties containing only those that begin with the initialized prefix.

Prefix is removed from key name in returned properties.

Returns:

The new properties.

split

public java.util.Map<java.lang.String,java.util.Properties> split()

Gets a map of properties vs name where name is supplied as a prefix, e.g.

prefix.[name].property=value.

Returns:

The map of properties vs name.

hasProperty

public boolean hasProperty(java.lang.String propertyName)

Determine if a non-empty property exists.

Parameters:

propertyName - The property name.

Returns:

Does the property exist?

getProperty

public final java.lang.String getProperty(java.lang.String propertyName)

Gets a property.

Parameters:

propertyName - The property name.

Returns:

The property, or null if unspecified.

getProperty

public final java.lang.String getProperty(java.lang.String propertyName,
                                          java.lang.String defaultValue)

Gets a property.

Parameters:

propertyName - The property name.

defaultValue - The default value.

Returns:

The property, or the default value if unspecified.

getProperty

public final java.lang.String getProperty(java.lang.String propertyName,
                                          int index,
                                          java.lang.String defaultValue)

Gets a multi-valued property.

Index values are separated by ','. If index exceeds the number of values, the last is returned.

Parameters:

propertyName - The property name.

index - The index.

defaultValue - The default value. Used only if the property does not exist.

Returns:

The property, or the default value if unspecified.

getIntProperty

public final int getIntProperty(java.lang.String propertyName,
                                int index,
                                int defaultValue)
                         throws InitializationException

Gets a multi-valued integer property.

Index values are separated by ','. If index exceeds the number of values, the last is returned.

Parameters:

propertyName - The property name.

index - The index.

defaultValue - The default value. Used only if the property does not exist.

Returns:

The property, or the default value if unspecified.

Throws:

InitializationException - if property is not an integer.

getIntProperty

public final int getIntProperty(java.lang.String propertyName,
                                int defaultValue)
                         throws InitializationException

Gets a property as an integer.

Parameters:

propertyName - The property name.

defaultValue - The default value.

Returns:

The property, or the default value if unspecified.

Throws:

InitializationException - if property is not an integer.

getLongProperty

public final long getLongProperty(java.lang.String propertyName,
                                  long defaultValue)
                           throws InitializationException

Gets a property as a long.

Parameters:

propertyName - The property name.

defaultValue - The default value.

Returns:

The property, or the default value if unspecified.

Throws:

InitializationException - if property is not an integer.

initClass

public final java.lang.Object initClass(java.lang.String propertyName,
                                        java.lang.Class<?> expectedClass)
                                 throws InitializationException

Create an instance of a class.

Parameters:

propertyName - The property containing the class name.

expectedClass - The expected class.

Returns:

An instance of the class or null if the property was not specified.

Throws:

InitializationException - if the class could not be found or instantiated.

initClassList

public final java.util.List<java.lang.Object> initClassList(java.lang.String propertyName,
                                                            java.lang.Class<?> expectedClass)
                                                     throws InitializationException

Creates a list of instances of a class.

Parameters:

propertyName - The name of a property containing a space-separated list of classes.

expectedClass - The expected class.

Returns:

The list containing instances of the class or an empty list if no property value.

Throws:

InitializationException - if class could not be found or instantiated.

throwRequiredException

public final void throwRequiredException(java.lang.String propertyName)
                                  throws InitializationException

Throws initialization exception indicating property is required.

Parameters:

propertyName - The property name.

Throws:

InitializationException - if called.

throwPositiveIntRequiredException

public final void throwPositiveIntRequiredException(java.lang.String propertyName)
                                             throws InitializationException

Throws initialization exception indicating property is not a positive integer.

Parameters:

propertyName - The property name.

Throws:

InitializationException - if called.

fromCommandLine

public static java.lang.String[] fromCommandLine(java.lang.String[] args,
                                                 java.util.Properties props)

Processes command-line arguments by treating those beginning with '-' as properties of the format -[name]=[value].

Properties with no specified value (e.g. -debug) are added to the properties with a value of "true".

Parameters:

args - The input arguments.

props - The properties to which command line properties are added.

Returns:

The arguments with properties removed.

millisFromTime

public static final long millisFromTime(java.lang.String time)
                                 throws InitializationException

Gets a time in milliseconds from a string that allows the units 'ms', 's', 'm', 'h', 'd' at the end.

Parameters:

time - The time string.

Returns:

The milliseconds, or Long.MIN_VALUE if units are unspecified or not recognized.

Throws:

InitializationException - if the time is not an integer.

toPairCollection

public static final java.util.Collection<Pair<java.lang.String,java.lang.String>> toPairCollection(java.util.Properties props)

Convert properties to a collection of string pairs.

Parameters:

props - The properties.

Returns:

The collection of pairs.