com.sabre.oss.conf4j.json.source

Class JsonConfigurationSource

java.lang.Object

com.sabre.oss.conf4j.json.source.JsonConfigurationSource

All Implemented Interfaces:

ConfigurationSource, IterableConfigurationSource

public class JsonConfigurationSource
extends Object
implements IterableConfigurationSource

Configuration source which supports JSON. It flattens the JSON structure to key-value properties.

Hierarchical objects are exposed by nested paths.

For example:

   {
    "teams": {
      "ferrari": {
        "engine": "ferrari",
        "score": 522,
        "private": false
       },
       "williams": {
         "engine": "mercedes",
         "score": 83,
         "private": true
       }
     }
   }
 

is transformed into these properties:

 teams.ferrari.engine=ferrari
 teams.ferrari.score=522
 teams.ferrari.private=false
 teams.williams.engine=mercedes
 teams.williams.score=83
 teams.williams.private=true
 

[] brackets are used to split lists into property keys.

For example:

   {
     "months": {
       "odd": [
         "January",
         "March",
         "May",
         "July",
         "August",
         "October",
         "December"
       ],
       "even": [
         "April",
         "June",
         "September",
         "November"
       ],
       "both": "February"
     }
   }
 

is transformed into these properties:

 months.odd[0]=January
 months.odd[1]=March
 months.odd[2]=May
 months.odd[3]=July
 months.odd[4]=August
 months.odd[5]=October
 months.odd[6]=December
 months.even[0]=April
 months.even[1]=June
 months.even[2]=September
 months.even[3]=November
 months.both=February
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PROPERTY Property name used when JSON does not represent map.

Constructor Summary

Constructors

Constructor and Description
JsonConfigurationSource(File file) Constructs value source from File.
JsonConfigurationSource(InputStream inputStream) Constructs value source from InputStream.
JsonConfigurationSource(Reader reader) Constructs value source from Reader.

Method Summary

Modifier and Type	Method and Description
Iterable<ConfigurationEntry>	getAllConfigurationEntries()
OptionalValue<String>	getValue(String key, Map<String,String> attributes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sabre.oss.conf4j.source.ConfigurationSource

findEntry

Field Detail

DEFAULT_PROPERTY

public static final String DEFAULT_PROPERTY

Property name used when JSON does not represent map.

For example:

 some string
 

is transformed into:

 document=some string
 

See Also:

Constant Field Values

Constructor Detail

JsonConfigurationSource

public JsonConfigurationSource(InputStream inputStream)

Constructs value source from InputStream.

Note: JSON is loaded and processed in the constructor and inputStream is closed at the end of processing.

Parameters:

inputStream - input stream which provides JSON.

Throws:

UncheckedIOException - when IOException is thrown during processing.

JsonConfigurationSource

public JsonConfigurationSource(Reader reader)

Constructs value source from Reader.

Note: JSON is loaded and processed in the constructor and inputStream is closed at the end of processing.

Parameters:

reader - reader which provides JSON source.

Throws:

UncheckedIOException - when IOException is thrown during processing.

JsonConfigurationSource

public JsonConfigurationSource(File file)

Constructs value source from File.

Parameters:

file - file which contains JSON source.

Throws:

IllegalArgumentException - when provided file not found.

UncheckedIOException - when IOException is thrown during processing.

Method Detail

getValue

public OptionalValue<String> getValue(String key,
                                      Map<String,String> attributes)

Specified by:

getValue in interface ConfigurationSource

getAllConfigurationEntries

public Iterable<ConfigurationEntry> getAllConfigurationEntries()

Specified by:

getAllConfigurationEntries in interface IterableConfigurationSource