org.dnwiebe.orienteer.lookups

Class Lookup

java.lang.Object

org.dnwiebe.orienteer.lookups.Lookup

Direct Known Subclasses:

FailingLookup, JsonLookup, MapLookup, PropertiesLookup, TestLookup

public abstract class Lookup
extends Object

Looks up configuration data from a particular source.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Lookup()
protected	Lookup(String name)

Method Summary

Modifier and Type	Method and Description
protected String	capitalize(String string) Capitalizes the first character of a String, leaves the rest alone.
String	getName() Provides a name for this Lookup, mostly for use in system logs.
abstract String	nameFromFragments(List<String> fragments) Assemble an attribute name that conforms to this Lookup's naming scheme from the provided list of name fragments.
abstract String	valueFromName(String name, Class singletonType) Perform the actual lookup characteristic of this Lookup.

Methods inherited from class java.lang.Object

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

Constructor Detail

Lookup

protected Lookup()

Lookup

protected Lookup(String name)

Method Detail

getName

public String getName()

Provides a name for this Lookup, mostly for use in system logs. Defaults to the fully-qualified name of the class.

Returns:

Name for Lookup.

nameFromFragments

public abstract String nameFromFragments(List<String> fragments)

Assemble an attribute name that conforms to this Lookup's naming scheme from the provided list of name fragments. This is where the naming scheme for a Lookup is defined.

Parameters:

fragments - This will be the camel-cased name of the method from your configuration interface, broken apart into fragments. For example, "threadPoolSize" will become {"thread", "Pool", "Size"} and "weatherServiceBaseURL" will become {"weather", "Service", "Base", "URL"}.

Returns:

Schemed name for this Lookup. For example, "thread.pool.size" or "THREAD_POOL_SIZE" or "ThreadPoolSize" or whatever you decide is appropriate.

valueFromName

public abstract String valueFromName(String name,
                                     Class singletonType)

Perform the actual lookup characteristic of this Lookup.

Parameters:

name - The name of the value to look up, in this Lookup's naming scheme. For example, if the configuration interface's method name is "threadPoolSize" and nameFromFragments converts that to "thread.pool.size," then this method will receive "thread.pool.size" as the name to look up.

singletonType - This is the configuration interface that's being satisfied. Mostly you'll ignore this parameter, but you might find it useful for composing error messages or logging.

Returns:

The String value (always a String value) of the attribute being sought, or null if not available.

capitalize

protected String capitalize(String string)

Capitalizes the first character of a String, leaves the rest alone. Perhaps useful as a utility.

Parameters:

string - String to capitalize

Returns:

Capitalized String