org.dnwiebe.orienteer.lookups

Class JsonFlatLookup

java.lang.Object

org.dnwiebe.orienteer.lookups.Lookup

org.dnwiebe.orienteer.lookups.JsonLookup

org.dnwiebe.orienteer.lookups.JsonFlatLookup

public class JsonFlatLookup
extends JsonLookup

Looks up configuration values in a JSON object. Method name abcDEFGhi becomes abc.def.ghi.

Nested Class Summary

Nested classes/interfaces inherited from class org.dnwiebe.orienteer.lookups.JsonLookup

JsonLookup.Pair

Field Summary

Fields inherited from class org.dnwiebe.orienteer.lookups.JsonLookup

tree

Constructor Summary

Constructors

Constructor and Description
JsonFlatLookup(InputStream istr, String configRoot) Create a JsonNestingLookup from an InputStream containing JSON.
JsonFlatLookup(Reader rdr, String configRoot) Create a JsonNestingLookup from a Reader containing JSON.
JsonFlatLookup(String name, InputStream istr, String configRoot) Create a JsonNestingLookup from an InputStream containing JSON.
JsonFlatLookup(String name, Reader rdr, String configRoot) Create a JsonNestingLookup from a Reader containing JSON.
JsonFlatLookup(String resourceName, String configRoot) Create a JsonNestingLookup from JSON in a resource file.
JsonFlatLookup(String name, String resourceName, String configRoot) Create a JsonNestingLookup from JSON in a resource file.

Method Summary

Modifier and Type	Method and Description
String	nameFromFragments(List<String> fragments) Assemble an attribute name that conforms to this Lookup's naming scheme from the provided list of name fragments.
String	valueFromName(String name, Class singletonType) Perform the actual lookup characteristic of this Lookup.

Methods inherited from class org.dnwiebe.orienteer.lookups.JsonLookup

valueFromName, valueFromName

Methods inherited from class org.dnwiebe.orienteer.lookups.Lookup

capitalize, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonFlatLookup

public JsonFlatLookup(Reader rdr,
                      String configRoot)

Create a JsonNestingLookup from a Reader containing JSON.

Parameters:

rdr - Reader containing a complete JSON structure with an unnamed JSON object at the top level.

configRoot - JavaScript notation for the location in the JSON structure of the object containing the configuration.

JsonFlatLookup

public JsonFlatLookup(InputStream istr,
                      String configRoot)

Create a JsonNestingLookup from an InputStream containing JSON.

Parameters:

istr - InputStream containing a complete JSON structure with an unnamed JSON object at the top level.

configRoot - JavaScript notation for the location in the JSON structure of the object containing the configuration.

JsonFlatLookup

public JsonFlatLookup(String resourceName,
                      String configRoot)

Create a JsonNestingLookup from JSON in a resource file.

Parameters:

resourceName - Name of a resource file containing a JSON structure with an unnamed JSON object at the top level.

configRoot - JavaScript notation for the location in the JSON structure of the object containing the configuration.

JsonFlatLookup

public JsonFlatLookup(String name,
                      Reader rdr,
                      String configRoot)

Create a JsonNestingLookup from a Reader containing JSON.

Parameters:

name - Name to be used in forensics for this Lookup

rdr - Reader containing a complete JSON structure with an unnamed JSON object at the top level.

configRoot - JavaScript notation for the location in the JSON structure of the object containing the configuration.

JsonFlatLookup

public JsonFlatLookup(String name,
                      InputStream istr,
                      String configRoot)

Create a JsonNestingLookup from an InputStream containing JSON.

Parameters:

name - Name to be used in forensics for this Lookup

istr - InputStream containing a complete JSON structure with an unnamed JSON object at the top level.

configRoot - JavaScript notation for the location in the JSON structure of the object containing the configuration.

JsonFlatLookup

public JsonFlatLookup(String name,
                      String resourceName,
                      String configRoot)

Create a JsonNestingLookup from JSON in a resource file.

Parameters:

name - Name to be used in forensics for this Lookup

resourceName - Name of a resource file containing a JSON structure with an unnamed JSON object at the top level.

configRoot - JavaScript notation for the location in the JSON structure of the object containing the configuration.

Method Detail

nameFromFragments

public String nameFromFragments(List<String> fragments)

Description copied from class: Lookup

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.

Specified by:

nameFromFragments in class Lookup

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 String valueFromName(String name,
                            Class singletonType)

Description copied from class: Lookup

Perform the actual lookup characteristic of this Lookup.

Specified by:

valueFromName in class 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.