org.xblackcat.sjpu.settings

Class Config

java.lang.Object

org.xblackcat.sjpu.settings.Config

public final class Config
extends java.lang.Object

14.04.2014 15:22

Field Summary

Fields

Modifier and Type	Field and Description
static IConfig	Defaults Initializes specified class with default values if any.

Method Summary

Modifier and Type	Method and Description
static IConfig	anyOf(IConfig... sources)
static <T> T	get(java.lang.Class<T> clazz) Loads settings for specified interface.
static IMutableConfig	track(java.lang.Class<?> clazz)
static IMutableConfig	track(java.io.File file)
static IMutableConfig	track(java.nio.file.Path file)
static IMutableConfig	track(java.lang.String resourceName)
static IMutableConfig	track(java.lang.String resourceName, java.lang.ClassLoader classLoader)
static IConfig	use(java.lang.Class<?> clazz) Builds a config reader from .properties file which location is specified by annotations in the given class.
static IConfig	use(java.io.File file) Builds a config reader from .properties file specified by File object.
static IConfig	use(java.nio.file.Path file) Builds a config reader from .properties file specified by Path object.
static IConfig	use(java.lang.String resourceName) Builds a config reader from .properties file located in class path resources.
static IConfig	use(org.xblackcat.sjpu.util.function.SupplierEx<java.io.InputStream,java.io.IOException> inputStreamSupplier) Builds a config reader from .properties file located in class path resources.
static IConfig	use(java.net.URL url) Builds a config reader from .properties file specified by url.
static IConfig	useEnv()
static IConfig	useJvm()

Methods inherited from class java.lang.Object

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

Field Detail

Defaults

public static final IConfig Defaults

Initializes specified class with default values if any. A SettingsException will be thrown if the specified interface has methods without DefaultValue annotation

Method Detail

use

public static IConfig use(java.io.File file)

Builds a config reader from .properties file specified by File object.

Parameters:

file - .properties file.

Returns:

config reader

use

public static IConfig use(java.nio.file.Path file)

Builds a config reader from .properties file specified by Path object.

Parameters:

file - .properties file.

Returns:

config reader

use

public static IConfig use(java.net.URL url)

Builds a config reader from .properties file specified by url.

Parameters:

url - url to .properties file.

Returns:

config reader

use

public static IConfig use(java.lang.String resourceName)

Builds a config reader from .properties file located in class path resources.

Parameters:

resourceName - resource name.

Returns:

config reader

use

public static IConfig use(org.xblackcat.sjpu.util.function.SupplierEx<java.io.InputStream,java.io.IOException> inputStreamSupplier)

Builds a config reader from .properties file located in class path resources.

Parameters:

inputStreamSupplier - input stream provider with all the

Returns:

config reader

useEnv

public static IConfig useEnv()

useJvm

public static IConfig useJvm()

anyOf

public static IConfig anyOf(IConfig... sources)

use

public static IConfig use(java.lang.Class<?> clazz)
                   throws SettingsException

Builds a config reader from .properties file which location is specified by annotations in the given class.

Parameters:

clazz - class annotated with @SettingsSource annotation.

Returns:

config reader

Throws:

SettingsException - if interface methods are not annotated or interface is not annotated with @SettingsSource

get

public static <T> T get(java.lang.Class<T> clazz)
                 throws SettingsException

Loads settings for specified interface. A default location of resource file is used. Default location is specified by @SettingsSource annotation.

If specified class marked with Optional annotation a null value will be returned in case when required resource is not exists.

Type Parameters:

T - target interface for holding settings.

Parameters:

clazz - target interface class for holding settings.

Returns:

initialized implementation of the specified interface class.

Throws:

SettingsException - if interface methods are not annotated or interface is not annotated with @SettingsSource

track

public static IMutableConfig track(java.lang.Class<?> clazz)
                            throws SettingsException,
                                   java.io.IOException,
                                   java.lang.UnsupportedOperationException

Throws:

SettingsException

java.io.IOException

java.lang.UnsupportedOperationException

track

public static IMutableConfig track(java.lang.String resourceName)
                            throws java.io.IOException,
                                   java.lang.UnsupportedOperationException

Throws:

java.io.IOException

java.lang.UnsupportedOperationException

track

public static IMutableConfig track(java.lang.String resourceName,
                                   java.lang.ClassLoader classLoader)
                            throws java.io.IOException,
                                   java.lang.UnsupportedOperationException

Throws:

java.io.IOException

java.lang.UnsupportedOperationException

track

public static IMutableConfig track(java.nio.file.Path file)
                            throws java.io.IOException,
                                   java.lang.UnsupportedOperationException

Throws:

java.io.IOException

java.lang.UnsupportedOperationException

track

public static IMutableConfig track(java.io.File file)
                            throws java.io.IOException,
                                   java.lang.UnsupportedOperationException

Throws:

java.io.IOException

java.lang.UnsupportedOperationException