org.xblackcat.sjpu.settings.config

Interface IConfig

All Known Subinterfaces:

IMutableConfig

All Known Implementing Classes:

DefaultConfig, EnvConfig, InputStreamConfig, JvmConfig, MultiSourceConfig, MutableConfig

public interface IConfig

08.11.2016 11:22

Method Summary

Modifier and Type	Method and Description
default <T> T	get(java.lang.Class<T> clazz) Loads settings for specified interface.
default <T> T	get(java.lang.Class<T> clazz, boolean optional) Loads settings for specified interface.
default <T> T	get(java.lang.Class<T> clazz, java.lang.String prefixName) Loads settings for specified interface.
<T> T	get(java.lang.Class<T> clazz, java.lang.String prefixName, boolean optional)

Method Detail

get

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

Loads settings for specified interface. Gets prefix for value names from @Prefix annotation if any. Optionality of the settings is specified with @Optional annotation.

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 properly annotated

get

default <T> T get(java.lang.Class<T> clazz,
                  boolean optional)
           throws SettingsException

Loads settings for specified interface. Gets prefix for value names from @Prefix annotation if any.

Type Parameters:

T - target interface for holding settings.

Parameters:

clazz - target interface class for holding settings.

optional - true to return null instead of throwing exception if resource is missing.

Returns:

initialized implementation of the specified interface class.

Throws:

SettingsException - if interface methods are not properly annotated

get

default <T> T get(java.lang.Class<T> clazz,
                  java.lang.String prefixName)
           throws SettingsException

Loads settings for specified interface. Optionality of the settings is specified with @Optional annotation.

Type Parameters:

T - target interface for holding settings.

Parameters:

clazz - target interface class for holding settings.

prefixName - override prefix for properties

Returns:

initialized implementation of the specified interface class.

Throws:

SettingsException - if interface methods are not properly annotated

get

<T> T get(java.lang.Class<T> clazz,
          java.lang.String prefixName,
          boolean optional)
   throws SettingsException

Throws:

SettingsException