org.xblackcat.sjpu.settings

Class Config.Builder

java.lang.Object

org.xblackcat.sjpu.settings.Config.Builder

Enclosing class:

Config

public static class Config.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
IConfig	anyOf(IConfig... sources)
IConfig	defaults()
<T> T	get(java.lang.Class<T> clazz) Loads settings for specified interface.
Config.Builder	substitute(IConfig substitution)
Config.Builder	substitute(java.util.Map<java.lang.String,java.lang.String> substitution)
Config.Builder	substituteEnv()
Config.Builder	substituteJvm()
IMutableConfig	track(java.lang.Class<?> clazz)
IMutableConfig	track(java.io.File file)
IMutableConfig	track(java.nio.file.Path file)
IMutableConfig	track(java.lang.String resourceName)
IMutableConfig	track(java.lang.String resourceName, java.lang.ClassLoader classLoader)
IConfig	use(java.lang.Class<?> clazz) Builds a config reader from .properties file which location is specified by annotations in the given class.
IConfig	use(java.io.File file) Builds a config reader from .properties file specified by File object.
IConfig	use(java.nio.file.Path file) Builds a config reader from .properties file specified by Path object.
IConfig	use(java.lang.String resourceName) Builds a config reader from .properties file located in class path resources.
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.
IConfig	use(java.net.URL url) Builds a config reader from .properties file specified by url.
IConfig	useEnv()
IConfig	useJvm()
Config.Builder	with(java.lang.String prefix, java.util.function.UnaryOperator<java.lang.String> valueHandler) Register a value processor.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

with

public Config.Builder with(java.lang.String prefix,
                           java.util.function.UnaryOperator<java.lang.String> valueHandler)

Register a value processor. If property value is started with prefix the prefix will be cut and remaining part will be passed to valueHandler

Parameters:

prefix -

valueHandler -

Returns:

the config builder

substituteEnv

public Config.Builder substituteEnv()

substituteJvm

public Config.Builder substituteJvm()

substitute

public Config.Builder substitute(java.util.Map<java.lang.String,java.lang.String> substitution)

substitute

public Config.Builder substitute(IConfig substitution)

use

public IConfig use(java.io.File file)

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

Parameters:

file - .properties file.

Returns:

config reader

defaults

public IConfig defaults()

use

public 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 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 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 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 IConfig useEnv()

useJvm

public IConfig useJvm()

anyOf

public IConfig anyOf(IConfig... sources)

use

public 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 <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 IMutableConfig track(java.lang.Class<?> clazz)
                     throws SettingsException,
                            java.io.IOException,
                            java.lang.UnsupportedOperationException

Throws:

SettingsException

java.io.IOException

java.lang.UnsupportedOperationException

track

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

Throws:

java.io.IOException

java.lang.UnsupportedOperationException

track

public 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 IMutableConfig track(java.nio.file.Path file)
                     throws java.io.IOException,
                            java.lang.UnsupportedOperationException

Throws:

java.io.IOException

java.lang.UnsupportedOperationException

track

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

Throws:

java.io.IOException

java.lang.UnsupportedOperationException