A C D F G I L M N P R S T U

A

adaptSettings(String, boolean, Class<T>) - Method in interface com.tomgibara.pronto.config.Config

This method creates a live mapping of this config's source properties to a specified interface.

C

CachingConfigSource - Class in com.tomgibara.pronto.config.source

Instances of this class wrap other ConfigSource instances and cache the values they return.

CachingConfigSource(ConfigSource, long) - Constructor for class com.tomgibara.pronto.config.source.CachingConfigSource

Creates new a source which caches responses from another ConfigSource.

clone() - Method in interface com.tomgibara.pronto.config.Config

Returns a config object which is supported by the same properties and which uses the same class loader.

com.tomgibara.pronto.config - package com.tomgibara.pronto.config

com.tomgibara.pronto.config.impl - package com.tomgibara.pronto.config.impl

com.tomgibara.pronto.config.source - package com.tomgibara.pronto.config.source

CompositeConfigSource - Class in com.tomgibara.pronto.config.source

This class provides a simple way of combining the properties from two configuration sources into one.

CompositeConfigSource(ConfigSource, ConfigSource) - Constructor for class com.tomgibara.pronto.config.source.CompositeConfigSource

Constructs a new composite configuration source from two existing sources.

Config - Interface in com.tomgibara.pronto.config

ConfigFactory - Class in com.tomgibara.pronto.config

Instances of this class are responsible for creating Config objects with which configuration settings can be exposed through Java interfaces.

ConfigFactory() - Constructor for class com.tomgibara.pronto.config.ConfigFactory

ConfigFactoryImpl - Class in com.tomgibara.pronto.config.impl

Default FactoryImpl implementation.

ConfigFactoryImpl() - Constructor for class com.tomgibara.pronto.config.impl.ConfigFactoryImpl

ConfigPolicy - Interface in com.tomgibara.pronto.config

Implementations of this interface control the operational parameters of config objects.

ConfigSource - Interface in com.tomgibara.pronto.config

Implementations of this interface are supplied to configs to provide the raw properties for configuration.

connectToURL() - Method in class com.tomgibara.pronto.config.source.URLConfigSource

This method is responsible for obtaining a connection to the URL for this source, configuring it, calling the connect() method on it and then returning the connection.

D

DEFAULT_MIN_READ_PERIOD - Static variable in class com.tomgibara.pronto.config.DefaultConfigPolicy

The value returned by the getMinReadPeriod() method.

DefaultConfigPolicy - Class in com.tomgibara.pronto.config

If no policy is explicitly specified for a config, an instance of this class is used by default.

DefaultConfigPolicy() - Constructor for class com.tomgibara.pronto.config.DefaultConfigPolicy

defaultForClass(Class) - Method in interface com.tomgibara.pronto.config.ConfigPolicy

This method should return a default property value for the specified class.

defaultForClass(Class) - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

Returns -1 for whole number primitives, 0.0 for floating point primitives, false for boolean primitives and \0 for character primitives.

DefaultPropertiesReader - Class in com.tomgibara.pronto.config.source

Reads properties from an input stream using the java.util.Properties class.

DefaultPropertiesReader() - Constructor for class com.tomgibara.pronto.config.source.DefaultPropertiesReader

Constructs a PropertiesReader which reads properties in the standard Java properties file format of dot separated, newline delimited key-value pairs.

DefaultPropertiesReader(boolean) - Constructor for class com.tomgibara.pronto.config.source.DefaultPropertiesReader

Constructs a PropertiesReader which reads properties in the standard Java properties file format.

F

FileConfigSource - Class in com.tomgibara.pronto.config.source

Parses a file into configuration properties.

FileConfigSource(File) - Constructor for class com.tomgibara.pronto.config.source.FileConfigSource

Constructs a source which reads its properties from a file using a DefaultPropertiesReader.

FileConfigSource(File, PropertiesReader) - Constructor for class com.tomgibara.pronto.config.source.FileConfigSource

Constructs a source which reads its properties from a file using the supplied properties reader.

forClassLoader(ClassLoader) - Method in interface com.tomgibara.pronto.config.Config

Returns a config object which is supported by the same properties as this one but using the specified class loader.

G

getClassLoader() - Method in interface com.tomgibara.pronto.config.Config

The classloader with which this config was constructed.

getFile() - Method in class com.tomgibara.pronto.config.source.FileConfigSource

The file from which the properties are loaded.

getInstance() - Static method in class com.tomgibara.pronto.config.ConfigFactory

Should be called to obtain a ConfigFactory instance.

getLastModified() - Method in class com.tomgibara.pronto.config.source.LastModifiedCalculator

Returns the lastModified date maintained by this object.

getMinReadPeriod() - Method in interface com.tomgibara.pronto.config.ConfigPolicy

This method is called to determine the minimum period of time in milliseconds which must elapse before a config will consider refreshing configuration information.

getMinReadPeriod() - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

This default implementation returns the value of DEFAULT_MIN_READ_PERIOD.

getPolicy() - Method in interface com.tomgibara.pronto.config.Config

Returns the policy which is currently in effect for this config.

getPreferences() - Method in class com.tomgibara.pronto.config.source.PreferencesConfigSource

The preferences which are used to generate the properties for this source.

getPrimarySource() - Method in class com.tomgibara.pronto.config.source.CompositeConfigSource

getProperties() - Method in interface com.tomgibara.pronto.config.ConfigSource

A map of the configuration properties supplied by this source.

getProperties() - Method in class com.tomgibara.pronto.config.source.CachingConfigSource

Return the cached properties field from the underlying ConfigSource.

getProperties() - Method in class com.tomgibara.pronto.config.source.CompositeConfigSource

Returns the union of the properties from both underlying sources.

getProperties() - Method in class com.tomgibara.pronto.config.source.FileConfigSource

The properties read from this source's file.

getProperties() - Method in class com.tomgibara.pronto.config.source.LastModifiedCalculator

Returns a copy of the last supplied properties which had changed.

getProperties() - Method in class com.tomgibara.pronto.config.source.MapConfigSource

getProperties() - Method in class com.tomgibara.pronto.config.source.PreferencesConfigSource

The properties obtained from the preferences node.

getProperties() - Method in class com.tomgibara.pronto.config.source.StringConfigSource

getProperties() - Method in class com.tomgibara.pronto.config.source.SynchronizedConfigSource

getProperties() - Method in class com.tomgibara.pronto.config.source.SystemConfigSource

getProperties() - Method in class com.tomgibara.pronto.config.source.URLConfigSource

getProperty(String) - Method in interface com.tomgibara.pronto.config.Config

Obtains current value of a specfied propery.

getReader() - Method in class com.tomgibara.pronto.config.source.FileConfigSource

The reader which converts this source's file into properties.

getReader() - Method in class com.tomgibara.pronto.config.source.URLConfigSource

The reader which converts this source's resources into properties.

getSecondarySource() - Method in class com.tomgibara.pronto.config.source.CompositeConfigSource

getSource() - Method in interface com.tomgibara.pronto.config.Config

getSource() - Method in class com.tomgibara.pronto.config.source.CachingConfigSource

Returns the ConfigSource which is being cached by this object.

getSource() - Method in class com.tomgibara.pronto.config.source.SynchronizedConfigSource

The ConfigSource object which is being synchronized by this object.

getTTL() - Method in class com.tomgibara.pronto.config.source.CachingConfigSource

The length time for which values may be cached without being refreshed.

getURL() - Method in class com.tomgibara.pronto.config.source.URLConfigSource

The URL from which the properties are loaded.

I

isCachingEager() - Method in interface com.tomgibara.pronto.config.ConfigPolicy

This method is called to control whether the objects converted from configuration properties may be cached even if no class loader has been specified on a config.

isCachingEager() - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

By default, values from possibly different class loaders are cacheable.

isDefaultsCached() - Method in interface com.tomgibara.pronto.config.ConfigPolicy

This method is called to determine whether values created by the defaultForClass method may be cached for subsequent property requests.

isDefaultsCached() - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

By default, the default values generated by defaultForClass are cached.

isExceptionLogged() - Method in interface com.tomgibara.pronto.config.ConfigPolicy

Whether exceptions generated by the configuration source when accessing properties should be logged.

isExceptionLogged() - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

By default exceptions are not logged because they are expected to be caught and logged by the client code.

isExceptionThrown() - Method in interface com.tomgibara.pronto.config.ConfigPolicy

Whether exceptions generated by the configuration source when accessing properties should be thrown from the interface accessor methods.

isExceptionThrown() - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

By default exceptions are thrown.

isFixed() - Method in class com.tomgibara.pronto.config.source.MapConfigSource

Whether the values returned by this config source are fixed.

isTimestampNewer(long, long) - Method in interface com.tomgibara.pronto.config.ConfigPolicy

This method is called to identify whether the change in the timestamp associated with a set of configuration properties represents a change in the properties.

isTimestampNewer(long, long) - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

The default implementation returns true if and only if the new timestamp is strictly greater than the old timestamp.

isXML() - Method in class com.tomgibara.pronto.config.source.DefaultPropertiesReader

Whether the properties are read as XML.

L

lastModified() - Method in interface com.tomgibara.pronto.config.ConfigSource

Returns the time at which the properties were last known to have changed.

lastModified() - Method in class com.tomgibara.pronto.config.source.CachingConfigSource

Return the cached lastModified field from the underlying ConfigSource.

lastModified() - Method in class com.tomgibara.pronto.config.source.CompositeConfigSource

Returns the latest time at which either of the underlying configuration sources was last modified.

lastModified() - Method in class com.tomgibara.pronto.config.source.FileConfigSource

The date on which the file was last modified.

lastModified() - Method in class com.tomgibara.pronto.config.source.MapConfigSource

lastModified() - Method in class com.tomgibara.pronto.config.source.PreferencesConfigSource

The time at which the properties returned by this property source, were last known to have changed.

lastModified() - Method in class com.tomgibara.pronto.config.source.StringConfigSource

Because this object is immutable, this method returns zero.

lastModified() - Method in class com.tomgibara.pronto.config.source.SynchronizedConfigSource

lastModified() - Method in class com.tomgibara.pronto.config.source.SystemConfigSource

lastModified() - Method in class com.tomgibara.pronto.config.source.URLConfigSource

LastModifiedCalculator - Class in com.tomgibara.pronto.config.source

Instances of this class can compute accurate values for lastModified from property maps alone.

LastModifiedCalculator() - Constructor for class com.tomgibara.pronto.config.source.LastModifiedCalculator

Initializes the object without a known last modified date or known properties.

LastModifiedCalculator(Map<String, String>, long) - Constructor for class com.tomgibara.pronto.config.source.LastModifiedCalculator

After calling this constructor, the lastModified field will equal the supplied lastModified date and the properties field will contain a copy of the supplied properties.

M

MapConfigSource - Class in com.tomgibara.pronto.config.source

Encapsulates a Map as a ConfigSource.

MapConfigSource(Map<String, String>, boolean) - Constructor for class com.tomgibara.pronto.config.source.MapConfigSource

Creates a new config source using properties from a supplied map.

MapConfigSource(Map<String, String>) - Constructor for class com.tomgibara.pronto.config.source.MapConfigSource

Creates a new config source using properties from a supplied map.

N

newConfig(ConfigSource, ClassLoader) - Method in class com.tomgibara.pronto.config.ConfigFactory

Constructs a new config.

newConfig(ConfigSource, ClassLoader) - Method in class com.tomgibara.pronto.config.impl.ConfigFactoryImpl

Returns a new ConfigImpl instance.

P

PreferencesConfigSource - Class in com.tomgibara.pronto.config.source

A configuration source which draws its properties from a Preferences node.

PreferencesConfigSource(Preferences) - Constructor for class com.tomgibara.pronto.config.source.PreferencesConfigSource

Create a configuration source which draws its properties from the supplied preferences node.

ProntoConfigException - Exception in com.tomgibara.pronto.config

Instances of this exception are thrown when a Config encounters a problem satisfying a configuration property request in any form.

ProntoConfigException() - Constructor for exception com.tomgibara.pronto.config.ProntoConfigException

Construct a new ProntoConfigException.

ProntoConfigException(String, Throwable) - Constructor for exception com.tomgibara.pronto.config.ProntoConfigException

Construct a new ProntoConfigException.

ProntoConfigException(String) - Constructor for exception com.tomgibara.pronto.config.ProntoConfigException

Construct a new ProntoConfigException.

ProntoConfigException(Throwable) - Constructor for exception com.tomgibara.pronto.config.ProntoConfigException

Construct a new ProntoConfigException.

PropertiesReader - Interface in com.tomgibara.pronto.config.source

Implementations of this interface can be supplied to ConfigSource objects which obtain their data from binary streams to specify how properties are read from the data.

propertyFromMethod(String) - Method in interface com.tomgibara.pronto.config.ConfigPolicy

This method defines the mapping of method names on an interface to property names in the configuration.

propertyFromMethod(String) - Method in class com.tomgibara.pronto.config.DefaultConfigPolicy

The default implementation drops "get" and "is" prefixes and replaces progressions to upper case into hyphens eg.

R

read(InputStream) - Method in class com.tomgibara.pronto.config.source.DefaultPropertiesReader

read(InputStream) - Method in interface com.tomgibara.pronto.config.source.PropertiesReader

Reads the bytes from an input stream and returns a set of properties which have been extracted from it.

S

setPolicy(ConfigPolicy) - Method in interface com.tomgibara.pronto.config.Config

Sets the policy.

setTTL(long) - Method in class com.tomgibara.pronto.config.source.CachingConfigSource

Changes the length time for which values may be cached without being refreshed.

startListening() - Method in class com.tomgibara.pronto.config.source.PreferencesConfigSource

Causes this source to start listening for property changes and node changes to the preference node.

stopListening() - Method in class com.tomgibara.pronto.config.source.PreferencesConfigSource

Causes this source to stop listening for changes to the property values.

StringConfigSource - Class in com.tomgibara.pronto.config.source

Instances of this class convert a single string into a set of properties as follows: 1) The string is split at each semicolon.

StringConfigSource(String) - Constructor for class com.tomgibara.pronto.config.source.StringConfigSource

Constructs a new set of properties from the supplied string.

SynchronizedConfigSource - Class in com.tomgibara.pronto.config.source

Instances of this class wrap other ConfigSource instances and ensure that its ConfigSource methods are safe for concurrent access.

SynchronizedConfigSource(ConfigSource) - Constructor for class com.tomgibara.pronto.config.source.SynchronizedConfigSource

Constructs a new ConfigSource which synchronizes access to the methods of another ConfigSource.

SystemConfigSource - Class in com.tomgibara.pronto.config.source

Enacapsulates the system properties as a ConfigSource.

SystemConfigSource() - Constructor for class com.tomgibara.pronto.config.source.SystemConfigSource

T

toString() - Method in class com.tomgibara.pronto.config.source.StringConfigSource

U

update(Map<String, String>) - Method in class com.tomgibara.pronto.config.source.LastModifiedCalculator

Computes the lastModified field of this object based on the supplied map.

URLConfigSource - Class in com.tomgibara.pronto.config.source

Accesses a (possibly) remote resource that is been specified via a URL and parses it into a collection of property values.

URLConfigSource(URL) - Constructor for class com.tomgibara.pronto.config.source.URLConfigSource

Constructs a source which reads its properties from a URL using a DefaultPropertiesReader.

URLConfigSource(URL, PropertiesReader) - Constructor for class com.tomgibara.pronto.config.source.URLConfigSource

Constructs a source which reads its properties from a URL using the supplied properties reader.

A C D F G I L M N P R S T U