A C D E F G H I M N P R S T V

A

Application - class nl.chess.it.util.config.examples.extended.Application.

This class makes sure the correct order is used in initializing the various part of the application.

addError(String, Throwable) - Method in class nl.chess.it.util.config.ConfigValidationResult

Makes a nice description of an error that happens when calling a method and adds this description to the list with errors.

C

Config - class nl.chess.it.util.config.Config.

Configuration class.

Config(Properties) - Constructor for class nl.chess.it.util.config.Config

Constructs a Config based on an existing Properties.

Config(String) - Constructor for class nl.chess.it.util.config.Config

Constructs a Config based on a resource.

ConfigValidationResult - class nl.chess.it.util.config.ConfigValidationResult.

This is the result of a check on the validity of the properties in a Configobject.

ConfigValidationResult() - Constructor for class nl.chess.it.util.config.ConfigValidationResult

ConfigurationException - exception nl.chess.it.util.config.ConfigurationException.

Thrown when there's something wrong with the configuration.

ConfigurationException() - Constructor for class nl.chess.it.util.config.ConfigurationException

ConfigurationException(String) - Constructor for class nl.chess.it.util.config.ConfigurationException

ConfigurationException(String, Throwable) - Constructor for class nl.chess.it.util.config.ConfigurationException

ConfigurationException(Throwable) - Constructor for class nl.chess.it.util.config.ConfigurationException

ConfigurationResolverEnvironmentVariable - class nl.chess.it.util.config.resolv.ConfigurationResolverEnvironmentVariable.

Opens a file or URL which name is given in an environment variable.

ConfigurationResolverEnvironmentVariable(String) - Constructor for class nl.chess.it.util.config.resolv.ConfigurationResolverEnvironmentVariable

CustomValidationConfig - class nl.chess.it.util.config.examples.newvalidation.CustomValidationConfig.

This class shows how to provide project-specific validation on properties.

CustomValidationConfig(String) - Constructor for class nl.chess.it.util.config.examples.newvalidation.CustomValidationConfig

clearResult() - Method in class nl.chess.it.util.config.InstrumentedProperties

compareTo(Object) - Method in class nl.chess.it.util.config.PropertyDisplayItem

D

DurationParser - class nl.chess.it.util.config.DurationParser.

Helper class that parses a String and interprets it as a duration.

DurationParser() - Constructor for class nl.chess.it.util.config.DurationParser

E

equals(Object) - Method in class nl.chess.it.util.config.PropertyDisplayItem

expectedtype - Variable in class nl.chess.it.util.config.InvalidPropertyException

Describes what type of variable we though the property should be.

F

FileParser - class nl.chess.it.util.config.FileParser.

FileParser() - Constructor for class nl.chess.it.util.config.FileParser

G

getAmountOfLegs() - Method in class nl.chess.it.util.config.examples.newvalidation.CustomValidationConfig

Return the amount of legs that has been defined in the properties.

getBoolean(String) - Method in class nl.chess.it.util.config.Config

Gets the value for the given key.

getBuiltBy() - Method in class nl.chess.it.util.config.examples.extended.VersionInformation

getBuiltOn() - Method in class nl.chess.it.util.config.examples.extended.VersionInformation

getConfig() - Method in class nl.chess.it.util.config.examples.extended.Application

getDate(String) - Method in class nl.chess.it.util.config.Config

getDurationInMs(String) - Method in class nl.chess.it.util.config.Config

Returns a duration.

getDurationInMs(String, String) - Method in class nl.chess.it.util.config.DurationParser

Main parse method.

getErrors() - Method in class nl.chess.it.util.config.ConfigValidationResult

Returns a List with Strings that indicate any errors that might have occured.

getException() - Method in class nl.chess.it.util.config.resolv.ConfigurationResolverEnvironmentVariable

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

getExistingReadableFile(String) - Method in class nl.chess.it.util.config.Config

getExistingReadableFile(String, String) - Method in class nl.chess.it.util.config.FileParser

getExpectedType() - Method in class nl.chess.it.util.config.MissingPropertyException

Returns the expected type of the property that was missing

getExpectedtype() - Method in class nl.chess.it.util.config.InvalidPropertyException

getFileName(String, String) - Method in class nl.chess.it.util.config.FileParser

getInstance() - Static method in class nl.chess.it.util.config.examples.extended.Application

getInt(String) - Method in class nl.chess.it.util.config.Config

getLastUsedKey() - Method in class nl.chess.it.util.config.InstrumentedProperties

Returns the last used key (key in property file).

getLastUsedValue() - Method in class nl.chess.it.util.config.InstrumentedProperties

Returns the last used value.

getMessageFormatPattern(String, Object[]) - Method in class nl.chess.it.util.config.Config

Checks if the value stored under the given key is a pattern that can be used to construct a MessageFormat.

getMethodName() - Method in class nl.chess.it.util.config.PropertyDisplayItem

Name of the method for the property.

getNiceWebsite() - Method in class nl.chess.it.util.config.examples.simple.SimpleConfig

getNumberOfDays() - Method in class nl.chess.it.util.config.examples.simple.SimpleConfig

getOriginalValue() - Method in class nl.chess.it.util.config.PropertyDisplayItem

Original, unparsed value of the element in the property file.

getParseValue() - Method in class nl.chess.it.util.config.PropertyDisplayItem

Parsed value of the element in the property file.

getProperties() - Method in class nl.chess.it.util.config.InstrumentedProperties

Allows direct access to underlying properties.

getProperties() - Method in class nl.chess.it.util.config.resolv.ConfigurationResolverEnvironmentVariable

Returns Properties object for configuration

getProperty(String) - Method in class nl.chess.it.util.config.InstrumentedProperties

getPropertyName() - Method in class nl.chess.it.util.config.PropertyDisplayItem

Name of the element in the property file.

getPropertyname() - Method in class nl.chess.it.util.config.InvalidPropertyException

getPropertyname() - Method in class nl.chess.it.util.config.MissingPropertyException

Returns the name of the property that was missing.

getSizeInBytes(String) - Method in class nl.chess.it.util.config.Config

getSourceDescription() - Method in class nl.chess.it.util.config.ConfigValidationResult

Describes the location where the properties come from.

getSourceDescription() - Method in class nl.chess.it.util.config.resolv.ConfigurationResolverEnvironmentVariable

Description of the file or URL read.

getString(String) - Method in class nl.chess.it.util.config.Config

Gets the String value for the given key.

getString(String, String) - Method in class nl.chess.it.util.config.Config

Gets the value String for the given key.

getStringArrayFromCommaString(String, String) - Method in class nl.chess.it.util.config.Config

Gets the value for the given key.

getStringArrayFromCommaString(String) - Method in class nl.chess.it.util.config.Config

Gets the value for the given key.

getURL(String) - Method in class nl.chess.it.util.config.Config

Gets the value for the given key.

getUnusedProperties() - Method in class nl.chess.it.util.config.ConfigValidationResult

Returns a Set with the unused properties.

getUsedKeys() - Method in class nl.chess.it.util.config.InstrumentedProperties

getUsedProperties() - Method in class nl.chess.it.util.config.ConfigValidationResult

Returns a set of {PropertyDisplayItem PropertyDisplayItems} that shows which properties are in use.

getValue(String) - Method in class nl.chess.it.util.config.Config

This method gives access to the underlying Properties this class is wrapped around.

getValue() - Method in class nl.chess.it.util.config.InvalidPropertyException

getVersion() - Method in class nl.chess.it.util.config.examples.extended.VersionInformation

getWelcomeText() - Method in class nl.chess.it.util.config.examples.simple.SimpleConfig

getWritableFile(String) - Method in class nl.chess.it.util.config.Config

getWriteableFile(String, String) - Method in class nl.chess.it.util.config.FileParser

Returns a writable, existing File with the given name.

H

hasValue(String) - Method in class nl.chess.it.util.config.Config

Indicates whether or not a value is given for this key.

hashCode() - Method in class nl.chess.it.util.config.PropertyDisplayItem

I

InstrumentedProperties - class nl.chess.it.util.config.InstrumentedProperties.

Simple adapter around Properties, used to keep track of which keys in the properties are used during a given interval.

InstrumentedProperties(Properties) - Constructor for class nl.chess.it.util.config.InstrumentedProperties

InvalidPropertyException - exception nl.chess.it.util.config.InvalidPropertyException.

Thrown when a property could not be parsed as the expected type.

InvalidPropertyException() - Constructor for class nl.chess.it.util.config.InvalidPropertyException

Constructs a new InvalidPropertyException where no fields have been filled in (yet).

InvalidPropertyException(String) - Constructor for class nl.chess.it.util.config.InvalidPropertyException

Constructs a new InvalidPropertyException where some fields are not filled in (yet).

InvalidPropertyException(String, String, String) - Constructor for class nl.chess.it.util.config.InvalidPropertyException

Constructs a new InvalidPropertyException.

isThisANiceClass() - Method in class nl.chess.it.util.config.examples.simple.SimpleConfig

M

Main - class nl.chess.it.util.config.examples.extended.Main.

This file uses the configuration.

Main() - Constructor for class nl.chess.it.util.config.examples.extended.Main

MissingPropertyException - exception nl.chess.it.util.config.MissingPropertyException.

Thrown when a required property could not be found.

MissingPropertyException(String) - Constructor for class nl.chess.it.util.config.MissingPropertyException

MissingPropertyException(String, String) - Constructor for class nl.chess.it.util.config.MissingPropertyException

main(String[]) - Static method in class nl.chess.it.util.config.examples.extended.Main

main(String[]) - Static method in class nl.chess.it.util.config.examples.simple.SimpleApplication

N

nl.chess.it.util.config - package nl.chess.it.util.config

Utility classes that provide type-safe access to configuration details.

nl.chess.it.util.config.examples.extended - package nl.chess.it.util.config.examples.extended

A more advanced example of the use of Java Config, including a suggested application layout.

nl.chess.it.util.config.examples.newvalidation - package nl.chess.it.util.config.examples.newvalidation

nl.chess.it.util.config.examples.simple - package nl.chess.it.util.config.examples.simple

An example of the use of Java Config that is kept as simple as possible.

nl.chess.it.util.config.resolv - package nl.chess.it.util.config.resolv

Utility classes that help out in resolving the location of configuration properties for an application.

P

PropertyDisplayItem - class nl.chess.it.util.config.PropertyDisplayItem.

Simple place holder that can be used to display the value of a property.

PropertyDisplayItem(String, String, String, String) - Constructor for class nl.chess.it.util.config.PropertyDisplayItem

Creates a new PropertyDisplayItem object.

PropertyInputStreamValidator - class nl.chess.it.util.config.resolv.PropertyInputStreamValidator.

PropertyInputStreamValidator() - Constructor for class nl.chess.it.util.config.resolv.PropertyInputStreamValidator

PropertyParseException - exception nl.chess.it.util.config.PropertyParseException.

DOCUMENT ME!

PropertyParseException(String) - Constructor for class nl.chess.it.util.config.PropertyParseException

Constructs a new PropertyParseException that indicates that a property could not be parsed due to the error described in the String given.

propertyname - Variable in class nl.chess.it.util.config.InvalidPropertyException

Name of the property (key in Properties).

R

RESOURCE_NAME - Static variable in class nl.chess.it.util.config.examples.extended.VersionInformation

Filename that contains the version information.

RESOURCE_NAME - Static variable in class nl.chess.it.util.config.examples.newvalidation.CustomValidationConfig

Name of the file we are looking for to read the configuration.

RESOURCE_NAME - Static variable in class nl.chess.it.util.config.examples.simple.SimpleConfig

Name of the file we are looking for to read the configuration.

S

SimpleApplication - class nl.chess.it.util.config.examples.simple.SimpleApplication.

A simple example of the use of a Config class.

SimpleApplication() - Constructor for class nl.chess.it.util.config.examples.simple.SimpleApplication

SimpleConfig - class nl.chess.it.util.config.examples.simple.SimpleConfig.

This class is a simple configuration example.

SimpleConfig(String) - Constructor for class nl.chess.it.util.config.examples.simple.SimpleConfig

Creates a new SimpleConfig object.

setExpectedtype(String) - Method in class nl.chess.it.util.config.InvalidPropertyException

setExpectedtype(String) - Method in class nl.chess.it.util.config.PropertyParseException

setPropertyname(String) - Method in class nl.chess.it.util.config.InvalidPropertyException

setSourceDescription(String) - Method in class nl.chess.it.util.config.ConfigValidationResult

Set the location where the properties come from.

setUnusedProperties(Set) - Method in class nl.chess.it.util.config.ConfigValidationResult

Sets the set with unusedProperties.

setUsedProperties(Set) - Method in class nl.chess.it.util.config.ConfigValidationResult

Allows replacement of the set with usedProperties.

setValue(String) - Method in class nl.chess.it.util.config.InvalidPropertyException

setValue(String) - Method in class nl.chess.it.util.config.PropertyParseException

startInstrumenting() - Method in class nl.chess.it.util.config.InstrumentedProperties

Start a session to instrument the property file.

stopInstrumenting() - Method in class nl.chess.it.util.config.InstrumentedProperties

Stops a session instrumenting the property file.

T

testMessageFormat(String, String, Object[]) - Method in class nl.chess.it.util.config.Config

Verifies that the given pattern can be used to construct a MessageFormat.

thereAreErrors() - Method in class nl.chess.it.util.config.ConfigValidationResult

Whether or not any exceptions occured when validating the configuration.

thereAreUnusedProperties() - Method in class nl.chess.it.util.config.ConfigValidationResult

Indicates whether or not there are unused properties.

toString() - Method in class nl.chess.it.util.config.ConfigValidationResult

toString() - Method in class nl.chess.it.util.config.InvalidPropertyException

toString() - Method in class nl.chess.it.util.config.MissingPropertyException

toString() - Method in class nl.chess.it.util.config.PropertyDisplayItem

toString() - Method in class nl.chess.it.util.config.PropertyParseException

V

VersionInformation - class nl.chess.it.util.config.examples.extended.VersionInformation.

Reads version information.

VersionInformation() - Constructor for class nl.chess.it.util.config.examples.extended.VersionInformation

Construct a VersionInformation, information will be read from VersionInformation.RESOURCE_NAME.

validate(InputStream) - Static method in class nl.chess.it.util.config.resolv.PropertyInputStreamValidator

validateConfiguration() - Method in class nl.chess.it.util.config.Config

Validates the configuration properties.

value - Variable in class nl.chess.it.util.config.InvalidPropertyException

Actual value read.

A C D E F G H I M N P R S T V