org.openstreetmap.atlas.checks.configuration

Class ConfigurationResolver

java.lang.Object

org.openstreetmap.atlas.checks.configuration.ConfigurationResolver

public final class ConfigurationResolver
extends java.lang.Object

Resolves several different Configuration sources for runtime configuration

Method Summary

Modifier and Type	Method and Description
static org.openstreetmap.atlas.utilities.configuration.Configuration	emptyConfiguration() Creates an empty Configuration for use when no configuration is needed
static java.util.Optional<java.io.InputStream>	getResourceAsStream(java.lang.String resource) Helper method that returns an InputStream to a JSON configuration available on the ClassPath
static java.util.Optional<java.io.InputStream>	getResourceAsStream(java.net.URI uri) Helper method that returns an InputStream to a JSON configuration referenced by URI
static org.openstreetmap.atlas.utilities.configuration.Configuration	inlineConfiguration(java.lang.String inline) Creates a Configuration defined inline
static org.openstreetmap.atlas.utilities.configuration.Configuration	loadConfiguration(org.openstreetmap.atlas.utilities.runtime.CommandMap commandMap, org.openstreetmap.atlas.utilities.runtime.Command.Switch<org.openstreetmap.atlas.utilities.collections.StringList> keyFiles, org.openstreetmap.atlas.utilities.runtime.Command.Switch<java.lang.String> keyJson) Resolves a Configuration for Commands given the CommandMap and Command.Switchs available
static org.openstreetmap.atlas.utilities.configuration.Configuration	resourceConfiguration(java.lang.String path, java.lang.Class context) Resolves a Configuration from the classpath

Methods inherited from class java.lang.Object

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

Method Detail

emptyConfiguration

public static org.openstreetmap.atlas.utilities.configuration.Configuration emptyConfiguration()

Creates an empty Configuration for use when no configuration is needed

Returns:

a new Configuration

getResourceAsStream

public static java.util.Optional<java.io.InputStream> getResourceAsStream(java.net.URI uri)

Helper method that returns an InputStream to a JSON configuration referenced by URI

Parameters:

uri - the location of the configuration

Returns:

an Optional InputStream

getResourceAsStream

public static java.util.Optional<java.io.InputStream> getResourceAsStream(java.lang.String resource)

Helper method that returns an InputStream to a JSON configuration available on the ClassPath

Parameters:

resource - a fully qualified resource name

Returns:

an Optional InputStream

inlineConfiguration

public static org.openstreetmap.atlas.utilities.configuration.Configuration inlineConfiguration(java.lang.String inline)

Creates a Configuration defined inline

Parameters:

inline - JSON configuration string

Returns:

a new Configuration

loadConfiguration

public static org.openstreetmap.atlas.utilities.configuration.Configuration loadConfiguration(org.openstreetmap.atlas.utilities.runtime.CommandMap commandMap,
                                                                                              org.openstreetmap.atlas.utilities.runtime.Command.Switch<org.openstreetmap.atlas.utilities.collections.StringList> keyFiles,
                                                                                              org.openstreetmap.atlas.utilities.runtime.Command.Switch<java.lang.String> keyJson)

Resolves a Configuration for Commands given the CommandMap and Command.Switchs available

Parameters:

commandMap - the Command's CommandMap

keyFiles - the Command.Switch containing a list of URIs for configuration

keyJson - the Command.Switch containing inline JSON configuration

Returns:

a new Configuration

resourceConfiguration

public static org.openstreetmap.atlas.utilities.configuration.Configuration resourceConfiguration(java.lang.String path,
                                                                                                  java.lang.Class context)

Resolves a Configuration from the classpath

Parameters:

path - a fully qualified resource name

context - a Class to get the ClassLoader from

Returns:

a new Configuration