org.dnwiebe.orienteer

Class Orienteer

java.lang.Object

org.dnwiebe.orienteer.Orienteer

public class Orienteer
extends Object

Main public class for Orienteer.

Constructor Summary

Constructors

Constructor and Description
Orienteer()

Method Summary

Modifier and Type	Method and Description
Orienteer	addConverter(Converter converter) Add a type Converter for general use to enable a new return type to be mentioned in the configuration interface passed to Orienteer.make().
<T extends Lookup> Orienteer	addConverter(Converter converter, Class<T> lookupType) Add a type Converter for use only on values returned from a particular kind of Lookup, to enable a new return type to be mentioned in the configuration interface passed to Orienteer.make().
Orienteer	inhibitInitialCheck() Call this if for some reason you don't want make() to run its standard initial check to make sure all the configuration values are readable.
<T> T	make(Class<T> singletonInterface, Lookup... lookups) Manufacture and return an object of a class that implements the provided interface, such that methods called on that object will produce the highest-priority configuration values available for them.

Methods inherited from class java.lang.Object

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

Constructor Detail

Orienteer

public Orienteer()

Method Detail

addConverter

public Orienteer addConverter(Converter converter)

Add a type Converter for general use to enable a new return type to be mentioned in the configuration interface passed to Orienteer.make(). If you add multiple Converters that all produce the same type, only the last will be used.

Parameters:

converter - Custom Converter for the new type.

Returns:

Orienteer object for operation chaining.

addConverter

public <T extends Lookup> Orienteer addConverter(Converter converter,
                                                 Class<T> lookupType)

Add a type Converter for use only on values returned from a particular kind of Lookup, to enable a new return type to be mentioned in the configuration interface passed to Orienteer.make(). If you add multiple Converters that all produce the same type for the same Lookup class, only the last will be used.

Parameters:

converter - Custom Converter for the new type.

lookupType - Only use this converter for configuration values from a Lookup of this type.

Returns:

Orienteer object for operation chaining.

inhibitInitialCheck

public Orienteer inhibitInitialCheck()

Call this if for some reason you don't want make() to run its standard initial check to make sure all the configuration values are readable.

Returns:

Orienteer object for operation chaining.

make

public <T> T make(Class<T> singletonInterface,
                  Lookup... lookups)

Manufacture and return an object of a class that implements the provided interface, such that methods called on that object will produce the highest-priority configuration values available for them. The provided interface must contain only methods that accept no parameters and return object (not primitive or void) types. Immediately upon creating the object, Orienteer will call all its methods to make sure seeking values does not throw exceptions. However, if a value is readily provided at make() time, but is not as forthcoming when it is sought later, you may get exceptions at runtime past startup.

Parameters:

singletonInterface - Interface for configuration object

lookups - Lookups to be consulted in order of priority. If a particular Lookup successfully provides a configuration value, later-specified Lookups are not consulted.

Returns:

Object of a generated class that implements singletonInterface.