net.sunyijun.resource.config

类 Configs

java.lang.Object

net.sunyijun.resource.config.Configs

public class Configs
extends Object

Global configs. All methods are static.

Default support 2 config file.
One is for product function config, called system config, default class path is "/config/config.properties".
Another is for debug function config, called debug config, default class path is "/config/self.properties".
If want to use other path, before get config, call setSystemConfigs(String, OneProperties) or setDebugConfigs(OneProperties, String)

If want to use some other config files, can addSelfConfigs(String, OneProperties), first param "configAbsoluteClassPath" is class path and also is an identity for config file. When get self config, must provide configAbsoluteClassPath.

从以下版本开始:

0.0.1

作者:

yijun.sun

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_DEBUG_CONFIG_ABSOLUTE_CLASS_PATH Default debug config file absolute class path: "/config/self.properties"
static String	DEFAULT_SYSTEM_CONFIG_ABSOLUTE_CLASS_PATH Default system config file absolute class path: "/config/config.properties"

构造器概要

构造器

构造器和说明
Configs()

方法概要

限定符和类型	方法和说明
static void	addSelfConfigs(String configAbsoluteClassPath, OneProperties configsObj) Add self define configs file.
static String	getDebugConfig(IConfigKey key) Get debug config string.
static BigDecimal	getDebugConfigDecimal(IConfigKey key) Get debug config decimal.
static String	getSelfConfig(String configAbsoluteClassPath, IConfigKey key) Get self config string.
static String	getSelfConfig(String configAbsoluteClassPath, String keyPrefix, IConfigKey key) Get self config string.
static BigDecimal	getSelfConfigDecimal(String configAbsoluteClassPath, IConfigKey key) Get self config decimal.
static BigDecimal	getSelfConfigDecimal(String configAbsoluteClassPath, String keyPrefix, IConfigKey key) Get self config decimal.
static String	getSystemConfig(IConfigKey key) Get system config string.
static String	getSystemConfig(String keyPrefix, IConfigKey key) Get system config string.
static BigDecimal	getSystemConfigDecimal(IConfigKey key) Get system config decimal.
static BigDecimal	getSystemConfigDecimal(String keyPrefix, IConfigKey key) Get system config decimal.
static boolean	isDebugConfig(IConfigKey key) Get debug config boolean value
static boolean	isSelfConfig(String configAbsoluteClassPath, IConfigKey key) Get self config boolean value
static boolean	isSelfConfig(String configAbsoluteClassPath, String keyPrefix, IConfigKey key) Get self config boolean value.
static boolean	isSystemConfig(IConfigKey key) Get debug config boolean value
static boolean	isSystemConfig(String keyPrefix, IConfigKey key) Get debug config boolean value.
static void	modifyDebugConfig(Map<IConfigKey,String> modifyConfig) Modify debug configs.
static void	modifySelfConfig(String configAbsoluteClassPath, IConfigKey key, String value) Modify one self config.
static void	modifySelfConfig(String configAbsoluteClassPath, Map<IConfigKey,String> modifyConfig) Modify self configs.
static void	modifySelfConfig(String configAbsoluteClassPath, String keyPrefix, IConfigKey key, String value) Modify one self config.
static void	modifySystemConfig(IConfigKey key, String value) Modify one system config.
static void	modifySystemConfig(Map<IConfigKey,String> modifyConfig) Modify system configs.
static void	modifySystemConfig(String keyPrefix, IConfigKey key, String value) Modify one system config.
static void	setDebugConfigs(OneProperties debugConfigsObj, String debugConfigAbsoluteClassPath) Set self define debug configs.
static void	setSystemConfigs(String systemConfigAbsoluteClassPath, OneProperties systemConfigsObj) Set self define system configs.

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_SYSTEM_CONFIG_ABSOLUTE_CLASS_PATH

public static final String DEFAULT_SYSTEM_CONFIG_ABSOLUTE_CLASS_PATH

Default system config file absolute class path: "/config/config.properties"

另请参阅:

常量字段值

DEFAULT_DEBUG_CONFIG_ABSOLUTE_CLASS_PATH

public static final String DEFAULT_DEBUG_CONFIG_ABSOLUTE_CLASS_PATH

Default debug config file absolute class path: "/config/self.properties"

另请参阅:

常量字段值

构造器详细资料

Configs

public Configs()

方法详细资料

getSystemConfig

public static String getSystemConfig(IConfigKey key)

Get system config string.

参数:

key - config key

返回:

config value string. Return null if not config in system config file ""/config/config.properties"" or self define system config path.

另请参阅:

setSystemConfigs(String, OneProperties)

getSystemConfig

public static String getSystemConfig(String keyPrefix,
                                     IConfigKey key)

Get system config string. Config key include prefix.

Example:
If key.getKeyString() is "test",
getSystemConfig("1.", key); will return "1.test" config value in system config file.

参数:

keyPrefix - config key prefix

key - config key

返回:

config value string. Return null if not config in system config file ""/config/config.properties"" or self define system config path.

另请参阅:

setSystemConfigs(String, OneProperties)

isSystemConfig

public static boolean isSystemConfig(IConfigKey key)

Get debug config boolean value

参数:

key - config key

返回:

true/false. If not config in system config file ""/config/config.properties"" or self define system config path, return false.

另请参阅:

setSystemConfigs(String, OneProperties)

isSystemConfig

public static boolean isSystemConfig(String keyPrefix,
                                     IConfigKey key)

Get debug config boolean value. Config key include prefix. Example:
If key.getKeyString() is "test",
isSystemConfig("1.", key); will return "1.test" config value in system config file.

参数:

keyPrefix - config key prefix

key - config key

返回:

true/false. If not config in system config file ""/config/config.properties"" or self define system config path, return false.

另请参阅:

setSystemConfigs(String, OneProperties)

getSystemConfigDecimal

public static BigDecimal getSystemConfigDecimal(IConfigKey key)

Get system config decimal.

参数:

key - config key

返回:

config BigDecimal value. Return null if not config in system config file ""/config/config.properties"" or self define system config path.

另请参阅:

setSystemConfigs(String, OneProperties)

getSystemConfigDecimal

public static BigDecimal getSystemConfigDecimal(String keyPrefix,
                                                IConfigKey key)

Get system config decimal. Config key include prefix. Example:
If key.getKeyString() is "test",
getSystemConfigDecimal("1.", key); will return "1.test" config value in system config file.

参数:

keyPrefix - config key prefix

key - config key

返回:

config BigDecimal value. Return null if not config in system config file ""/config/config.properties"" or self define system config path.

另请参阅:

setSystemConfigs(String, OneProperties)

getDebugConfig

public static String getDebugConfig(IConfigKey key)

Get debug config string.

参数:

key - config key

返回:

config value string. Return null if not config in debug config file ""/config/self.properties"" or self define debug config path.

另请参阅:

setDebugConfigs(OneProperties, String)

isDebugConfig

public static boolean isDebugConfig(IConfigKey key)

Get debug config boolean value

参数:

key - config key

返回:

true/false. If not config in debug config file ""/config/self.properties"" or self define debug config path, return false.

另请参阅:

setDebugConfigs(OneProperties, String)

getDebugConfigDecimal

public static BigDecimal getDebugConfigDecimal(IConfigKey key)

Get debug config decimal.

参数:

key - config key

返回:

config BigDecimal value. Return null if not config in debug config file ""/config/self.properties"" or self debug system config path.

另请参阅:

setDebugConfigs(OneProperties, String)

getSelfConfig

public static String getSelfConfig(String configAbsoluteClassPath,
                                   IConfigKey key)

Get self config string.

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

key - config key in configAbsoluteClassPath config file

返回:

config value string. Return null if not add config file or not config in config file.

另请参阅:

addSelfConfigs(String, OneProperties)

getSelfConfig

public static String getSelfConfig(String configAbsoluteClassPath,
                                   String keyPrefix,
                                   IConfigKey key)

Get self config string. Config key include prefix. Example:
If key.getKeyString() is "test",
getSelfConfig("/self.properties", "1.", key); will return "1.test" config value in "/self.properties".

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

keyPrefix - config key prefix

key - config key in configAbsoluteClassPath config file

返回:

config value string. Return null if not add config file or not config in config file.

另请参阅:

addSelfConfigs(String, OneProperties)

isSelfConfig

public static boolean isSelfConfig(String configAbsoluteClassPath,
                                   IConfigKey key)

Get self config boolean value

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

key - config key in configAbsoluteClassPath config file

返回:

true/false. If not add config file or not config in config file, return false.

另请参阅:

addSelfConfigs(String, OneProperties)

isSelfConfig

public static boolean isSelfConfig(String configAbsoluteClassPath,
                                   String keyPrefix,
                                   IConfigKey key)

Get self config boolean value. Config key include prefix. Example:
If key.getKeyString() is "test",
isSelfConfig("/self.properties", "1.", key); will return "1.test" config value in "/self.properties".

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

keyPrefix - config key prefix

key - config key in configAbsoluteClassPath config file

返回:

true/false. If not add config file or not config in config file, return false.

另请参阅:

addSelfConfigs(String, OneProperties)

getSelfConfigDecimal

public static BigDecimal getSelfConfigDecimal(String configAbsoluteClassPath,
                                              IConfigKey key)

Get self config decimal.

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

key - config key in configAbsoluteClassPath config file

返回:

config BigDecimal value. Return null if not add config file or not config in config file.

另请参阅:

addSelfConfigs(String, OneProperties)

getSelfConfigDecimal

public static BigDecimal getSelfConfigDecimal(String configAbsoluteClassPath,
                                              String keyPrefix,
                                              IConfigKey key)

Get self config decimal. Config key include prefix. Example:
If key.getKeyString() is "test",
getSelfConfigDecimal("/self.properties", "1.", key); will return "1.test" config value in "/self.properties".

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

keyPrefix - config key prefix

key - config key in configAbsoluteClassPath config file

返回:

config BigDecimal value. Return null if not add config file or not config in config file.

另请参阅:

addSelfConfigs(String, OneProperties)

modifySystemConfig

public static void modifySystemConfig(Map<IConfigKey,String> modifyConfig)
                               throws IOException

Modify system configs.

参数:

modifyConfig - need update configs. If one value is null, will not update that one.

抛出:

IOException

modifySystemConfig

public static void modifySystemConfig(IConfigKey key,
                                      String value)
                               throws IOException

Modify one system config.

参数:

key - need update config's key

value - new config value

抛出:

IOException

modifySystemConfig

public static void modifySystemConfig(String keyPrefix,
                                      IConfigKey key,
                                      String value)
                               throws IOException

Modify one system config. Config key include prefix. Example:
If key.getKeyString() is "test",
modifySystemConfig("1.", key, "newValue"); will modify "1.test" config value in system config file.

参数:

keyPrefix - config key prefix

key - need update config's key

value - new config value

抛出:

IOException

modifyDebugConfig

public static void modifyDebugConfig(Map<IConfigKey,String> modifyConfig)
                              throws IOException

Modify debug configs.

参数:

modifyConfig - need update configs. If one value is null, will not update that one.

抛出:

IOException

modifySelfConfig

public static void modifySelfConfig(String configAbsoluteClassPath,
                                    Map<IConfigKey,String> modifyConfig)
                             throws IOException

Modify self configs.

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

modifyConfig - need update configs. If one value is null, will not update that one.

抛出:

IOException

modifySelfConfig

public static void modifySelfConfig(String configAbsoluteClassPath,
                                    IConfigKey key,
                                    String value)
                             throws IOException

Modify one self config.

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

key - need update config's key

value - new config value

抛出:

IOException

modifySelfConfig

public static void modifySelfConfig(String configAbsoluteClassPath,
                                    String keyPrefix,
                                    IConfigKey key,
                                    String value)
                             throws IOException

Modify one self config. Config key include prefix. Example:
If key.getKeyString() is "test",
modifySelfConfig("/self.properties", "1.", key, "newValue"); will modify "1.test" config value in "/self.properties".

参数:

configAbsoluteClassPath - config path. addSelfConfigs(String, OneProperties)

keyPrefix - config key prefix

key - need update config's key

value - new config value

抛出:

IOException

addSelfConfigs

public static void addSelfConfigs(String configAbsoluteClassPath,
                                  OneProperties configsObj)

Add self define configs file.

Can use self configs path or self class extends OneProperties.

参数:

configAbsoluteClassPath - self configs absolute class path. This path also is a config file key string. Can't be null, if null add nothing.

configsObj - self class extends OneProperties. Can be null, if null means not use self class.

另请参阅:

OneProperties

setSystemConfigs

public static void setSystemConfigs(String systemConfigAbsoluteClassPath,
                                    OneProperties systemConfigsObj)

Set self define system configs.

Can use self system configs path or self class extends OneProperties.

参数:

systemConfigAbsoluteClassPath - self system configs absolute class path. Can be null, if null means use default path ""/config/config.properties""

systemConfigsObj - self class extends OneProperties. Can be null, if null means not use self class.

另请参阅:

OneProperties

setDebugConfigs

public static void setDebugConfigs(OneProperties debugConfigsObj,
                                   String debugConfigAbsoluteClassPath)

Set self define debug configs.

Can use self debug configs path or self class extends OneProperties.

参数:

debugConfigsObj - self class extends OneProperties. If null means not use self class.

debugConfigAbsoluteClassPath - self system configs path. If null means use default path ""/config/self.properties""

另请参阅:

OneProperties