Package de.mid.innovator.ui

Class PropertyProviderDefault

java.lang.Object

de.mid.innovator.ui.PropertyProviderDefault

All Implemented Interfaces:

PropertyProvider

public class PropertyProviderDefault
extends java.lang.Object
implements PropertyProvider

The class is a default implementation of the PropertyProvider interface which can be used to unify command line arguments and system properties. It also helps to configure and transform the property values at runtime. It checks the configured properties against the given command line arguments and provides the user with default values.

Author:

borschet

See Also:

Property, PropertyCfg, PropertyProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,Property>	confMap	The list of all configured properties.
protected java.util.Map<java.lang.String,java.lang.String>	propertyMap	The locally stored properties.

Constructor Summary

Constructors

Constructor	Description
PropertyProviderDefault()	The default constructor which creates an empty property provider.

Method Summary

Modifier and Type	Method	Description
void	disableValidateConfig()	Disables stringent validation of the configuration.
void	enableValidateConfig()	Enables stringent validation of the configuration.
java.util.List<Property>	getAllValidProperties()
boolean	getBooleanProperty(java.lang.String key)	A property getter for Boolean properties.
java.lang.Class<?>[]	getClassListProperty(java.lang.String key)	Gets a list of classes from a given string property.
java.lang.Class<?>	getClassProperty(java.lang.String key)	A property getter for class properties.
<T extends java.lang.Enum<T>> T	getEnumProperty(java.lang.Class<T> cls, java.lang.String key)	A property getter for enumeration type.
java.io.File[]	getFileListProperty(java.lang.String key)	Gets a list of files given with a string property value.
java.io.File	getFileProperty(java.lang.String key)	A property getter for File properties.
int	getIntegerProperty(java.lang.String key)	A property getter for integer properties.
boolean	getOptionalBooleanProperty(java.lang.String key)	Invokes getBooleanProperty(String)
java.lang.Class<?>[]	getOptionalClassListProperty(java.lang.String key, java.lang.Class<?>[] defaultValue)	Invokes getClassListProperty()
java.lang.Class<?>	getOptionalClassProperty(java.lang.String key)	Invokes getClassProperty(String)
<T extends java.lang.Enum<T>> T	getOptionalEnumProperty(java.lang.Class<T> cls, java.lang.String key)	Invokes getEnumProperty(Class, String)
java.io.File[]	getOptionalFileListProperty(java.lang.String key, java.io.File[] defaultValue)	Invokes getFileListProperty()
java.io.File	getOptionalFileProperty(java.lang.String key)	Invokes getFileProperty(String)
int	getOptionalIntegerProperty(java.lang.String key)	Invokes getIntegerProperty()
java.lang.String	getOptionalStringProperty(java.lang.String key)	Invokes getStringProperty()
protected java.lang.String	getRawPropertyString(java.lang.String key)	Searches the local propertyMap or tries to locate a system property
java.lang.String	getStringProperty(java.lang.String key)	A property getter for string properties.
void	InitWithCommandLineArguments(java.lang.String[] commandLineArguments)	Initializes the property provider with a wide array of command line argument strings, checks the given values against the configuration and prepares the values for use with the typed getter methods.
void	provideProperty(Property p)	Adds precisely one property that can be used at runtime.
void	providePropertyList(java.util.List<Property> validProps)	Configures a list of valid properties to be used at runtime.

Methods inherited from class java.lang.Object

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

Field Detail

propertyMap

protected java.util.Map<java.lang.String,java.lang.String> propertyMap

The locally stored properties.

confMap

protected java.util.Map<java.lang.String,Property> confMap

The list of all configured properties.

Constructor Detail

PropertyProviderDefault

public PropertyProviderDefault()

The default constructor which creates an empty property provider.

Method Detail

providePropertyList

public void providePropertyList(java.util.List<Property> validProps)

Configures a list of valid properties to be used at runtime.

Specified by:

providePropertyList in interface PropertyProvider

provideProperty

public void provideProperty(Property p)

Adds precisely one property that can be used at runtime.

Specified by:

provideProperty in interface PropertyProvider

enableValidateConfig

public void enableValidateConfig()

Enables stringent validation of the configuration.

Specified by:

enableValidateConfig in interface PropertyProvider

See Also:

InitWithCommandLineArguments(String[])

disableValidateConfig

public void disableValidateConfig()

Disables stringent validation of the configuration.

Specified by:

disableValidateConfig in interface PropertyProvider

See Also:

InitWithCommandLineArguments(String[])

getAllValidProperties

public java.util.List<Property> getAllValidProperties()

Specified by:

getAllValidProperties in interface PropertyProvider

Returns:

all previously configured properties

InitWithCommandLineArguments

public void InitWithCommandLineArguments(java.lang.String[] commandLineArguments)
                                  throws UnknownArgumentException

Initializes the property provider with a wide array of command line argument strings, checks the given values against the configuration and prepares the values for use with the typed getter methods. This means that the command line arguments are parsed according to the format "<key>=<value>". The property provider checks every given string argument so that they correspond with a valid configured property. If no such property can be found, an exception is raised. This behavior can be prevented by calling disableValidateConfig() before the property provider is initialized.

Specified by:

InitWithCommandLineArguments in interface PropertyProvider

Throws:

UnknownArgumentException - If the list of command line arguments contains a property that was not previously configured and this check is not disabled.

getOptionalBooleanProperty

public boolean getOptionalBooleanProperty(java.lang.String key)

Invokes getBooleanProperty(String)

Specified by:

getOptionalBooleanProperty in interface PropertyProvider

Parameters:

key - the argument key value

Returns:

true if the property's string value is "true", otherwise false

getOptionalClassProperty

public java.lang.Class<?> getOptionalClassProperty(java.lang.String key)
                                            throws InvalidArgumentException

Invokes getClassProperty(String)

Specified by:

getOptionalClassProperty in interface PropertyProvider

Parameters:

key - the argument key value

Returns:

the given value, otherwise the configured default value

Throws:

InvalidArgumentException - If the given string cannot be converted into a valid class.

getOptionalEnumProperty

public <T extends java.lang.Enum<T>> T getOptionalEnumProperty(java.lang.Class<T> cls,
                                                               java.lang.String key)
                                                        throws InvalidArgumentException

Invokes getEnumProperty(Class, String)

Specified by:

getOptionalEnumProperty in interface PropertyProvider

Parameters:

cls - the enumeration type of the property

key - the key value

Returns:

the given value, otherwise the configured default value

Throws:

InvalidArgumentException - If the conversion from the value to a valid member of the given enumeration fails.

getOptionalFileProperty

public java.io.File getOptionalFileProperty(java.lang.String key)

Invokes getFileProperty(String)

Specified by:

getOptionalFileProperty in interface PropertyProvider

Returns:

the given value, otherwise the configured default value

getOptionalIntegerProperty

public int getOptionalIntegerProperty(java.lang.String key)
                               throws InvalidArgumentException

Invokes getIntegerProperty()

Specified by:

getOptionalIntegerProperty in interface PropertyProvider

Returns:

its result if defined, otherwise the configured default value

Throws:

InvalidArgumentException - If the properties string value cannot be converted into an integer.

getOptionalStringProperty

public java.lang.String getOptionalStringProperty(java.lang.String key)

Invokes getStringProperty()

Specified by:

getOptionalStringProperty in interface PropertyProvider

Returns:

its result if defined, otherwise the configured default value

getOptionalClassListProperty

public java.lang.Class<?>[] getOptionalClassListProperty(java.lang.String key,
                                                         java.lang.Class<?>[] defaultValue)
                                                  throws InvalidArgumentException

Invokes getClassListProperty()

Specified by:

getOptionalClassListProperty in interface PropertyProvider

Returns:

its result if defined, otherwise the configured default value

Throws:

InvalidArgumentException - if the property string value cannot be converted into a list of classes.

getOptionalFileListProperty

public java.io.File[] getOptionalFileListProperty(java.lang.String key,
                                                  java.io.File[] defaultValue)

Invokes getFileListProperty()

Specified by:

getOptionalFileListProperty in interface PropertyProvider

Returns:

its result if defined, otherwise the configured default value

getRawPropertyString

protected java.lang.String getRawPropertyString(java.lang.String key)

Searches the local propertyMap or tries to locate a system property

Returns:

a string value for the given key or null

getEnumProperty

public <T extends java.lang.Enum<T>> T getEnumProperty(java.lang.Class<T> cls,
                                                       java.lang.String key)
                                                throws InvalidArgumentException,
                                                       MissingArgumentException

A property getter for enumeration type.

Specified by:

getEnumProperty in interface PropertyProvider

Parameters:

cls - the enumeration type of the property

key - the key value

Returns:

an instance of the enumeration

Throws:

InvalidArgumentException

MissingArgumentException - if no such property can be found.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key)
                           throws MissingArgumentException

A property getter for Boolean properties.

Specified by:

getBooleanProperty in interface PropertyProvider

Throws:

MissingArgumentException - If no such property can be found.

getClassProperty

public java.lang.Class<?> getClassProperty(java.lang.String key)
                                    throws MissingArgumentException,
                                           InvalidArgumentException

A property getter for class properties.

Specified by:

getClassProperty in interface PropertyProvider

Throws:

InvalidArgumentException - if the property value cannot be converted into a valid class.

MissingArgumentException - if no such property can be found.

getFileProperty

public java.io.File getFileProperty(java.lang.String key)
                             throws MissingArgumentException

A property getter for File properties.

Specified by:

getFileProperty in interface PropertyProvider

Returns:

a file object created with File(java.lang.String)

Throws:

MissingArgumentException - if no such property can be found.

getIntegerProperty

public int getIntegerProperty(java.lang.String key)
                       throws MissingArgumentException,
                              InvalidArgumentException

A property getter for integer properties.

Specified by:

getIntegerProperty in interface PropertyProvider

Throws:

InvalidArgumentException - if the property value cannot be converted into an integer.

MissingArgumentException - if no such property can be found.

getStringProperty

public java.lang.String getStringProperty(java.lang.String key)
                                   throws MissingArgumentException

A property getter for string properties.

Specified by:

getStringProperty in interface PropertyProvider

Throws:

MissingArgumentException - if no such property can be found.

getClassListProperty

public java.lang.Class<?>[] getClassListProperty(java.lang.String key)
                                          throws MissingArgumentException,
                                                 InvalidArgumentException

Gets a list of classes from a given string property. Each class specifications must be separated by a File.pathSeparator.

Specified by:

getClassListProperty in interface PropertyProvider

Returns:

an array of classes.

Throws:

InvalidArgumentException - if an entry of the string list cannot be converted into a valid class.

MissingArgumentException - if no such property can be found.

getFileListProperty

public java.io.File[] getFileListProperty(java.lang.String key)
                                   throws MissingArgumentException

Gets a list of files given with a string property value. The single file specifications must be separated by File.pathSeparator.

Specified by:

getFileListProperty in interface PropertyProvider

Returns:

an array of file instances.

Throws:

MissingArgumentException - if no such property can be found.