nl.chess.it.util.config.resolv
Class ConfigurationResolverEnvironmentVariable

java.lang.Object
  nl.chess.it.util.config.resolv.ConfigurationResolverEnvironmentVariable

public class ConfigurationResolverEnvironmentVariable

extends java.lang.Object

Opens a file or URL which name is given in an environment variable. Two situations can occur:

• file is okay and readable: getSourceDescription()and getProperties()are garantueed to be not null
• file is not usable or cannot be read: getSourceDescription()and getProperties()might be null

Note: this class is still in development; the external interface might change (slightly) later.

Author:

Guus Bosman (Chess-iT)

Constructor Summary

ConfigurationResolverEnvironmentVariable(java.lang.String key)

Method Summary

java.lang.Exception	getException() Returns the Exception that occurred while reading from the environment variable (if any).
java.util.Properties	getProperties() Returns Properties object for configuration
java.lang.String	getSourceDescription() Description of the file or URL read.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationResolverEnvironmentVariable

public ConfigurationResolverEnvironmentVariable(java.lang.String key)

Method Detail

getException

public java.lang.Exception getException()

Returns the Exception that occurred while reading from the environment variable (if any).

Returns:

Might be null.

getSourceDescription

public java.lang.String getSourceDescription()

Description of the file or URL read.

Returns:

If getException()was not null then this might be null.

getProperties

public java.util.Properties getProperties()

Returns Properties object for configuration

Returns:

If getException()was not null then this might be null.