AbstractConfigurationProvider (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.configuration.AbstractConfigurationProvider

All Implemented Interfaces:

IConfigReader, IConfigurationProvider

Direct Known Subclasses:

DefaultConfigurationProvider, JSONConfigurationProvider, PropertyConfigurationProvider
```
public abstract class AbstractConfigurationProvider
extends Object
implements IConfigurationProvider
```
Author:

刘镇 (suninformation@163.com) on 2017/7/31 上午12:39

Constructor Summary

Constructors
Constructor and Description

AbstractConfigurationProvider()

Constructors
Constructor and Description
`AbstractConfigurationProvider()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract IConfigFileParser`	`buildConfigFileParser(URL cfgFileName)` 构建配置文件分析器对象
`boolean`	`contains(String key)` 判断键key的配置项是否存在
`boolean`	`contains(String category, String key)` 判断键key的配置项是否存在
`String[]`	`getArray(String key)` 获取键值数组值
`String[]`	`getArray(String key, boolean zeroSize)` 获取键值数组值
`String[]`	`getArray(String key, String[] defaultValue)` 获取键值数组值
`String[]`	`getArray(String category, String key, boolean zeroSize)` 获取指定分类中键的键值数组
`boolean`	`getBoolean(String key)` 获得对应的布尔值
`boolean`	`getBoolean(String key, boolean defaultValue)` 获得对应的布尔值，若不存在则返回指定默认值
`boolean`	`getBoolean(String category, String key, boolean defaultValue)` 获取指定分类中键的布尔值，若为空则返回指定默认值
`List<String>`	`getCategoryNames()` 获取分类的名称集合
`String`	`getCfgFileName()` 获取当前加载的配置文件路径
`<T> T`	`getClassImpl(String key, Class<T> interfaceClass)` 获取接口实例类型
`<T> T`	`getClassImpl(String key, String defaultValue, Class<T> interfaceClass)` 获取接口实例类型，若不存在则返回指定默认值
`<T> T`	`getClassImpl(String category, String key, String defaultValue, Class<T> interfaceClass)` 获取指定分类中键的接口实例类型，若不存在则返回指定默认值
`IConfigFileParser`	`getConfigFileParser()` 返回当前配置文件分析器
`double`	`getDouble(String key)` 获取双精度浮点数
`double`	`getDouble(String key, double defaultValue)` 获取双精度浮点数，若不存在则返回指定默认值
`double`	`getDouble(String category, String key, double defaultValue)` 获取指定分类中键的双精度浮点数，若为空则返回指定默认值
`float`	`getFloat(String key)` 获取浮点数
`float`	`getFloat(String key, float defaultValue)` 获取浮点数，若不存在则返回指定默认值
`float`	`getFloat(String category, String key, float defaultValue)` 获取指定分类中键的浮点数，若为空则返回指定默认值
`int`	`getInt(String key)` 获得对应的数字值
`int`	`getInt(String key, int defaultValue)` 获得对应的数字值，若不存在则返回指定默认值
`int`	`getInt(String category, String key, int defaultValue)` 获取指定分类中键的对应的数字值，若为空则返回指定默认值
`List<String>`	`getList(String key)` 获得对应的文字值列表，其中匹配以key开头的键串
`List<String>`	`getList(String category, String key)` 获取指定分类中键的对应的文字值列表，其中匹配以key开头的键串
`long`	`getLong(String key)` 获取长整数
`long`	`getLong(String key, long defaultValue)` 获取长整数，若不存在则返回指定默认值
`long`	`getLong(String category, String key, long defaultValue)` 获取指定分类中键的长整数，若为空则返回指定默认值
`Map<String,String>`	`getMap(String key)` 获取键值映射
`Map<String,String>`	`getMap(String category, String key)` 获取指定分类中键的键值映射
`String`	`getString(String key)` 获得对应的文字值
`String`	`getString(String key, String defaultValue)` 获得对应的文字值，若为空则返回指定默认值
`String`	`getString(String category, String key, String defaultValue)` 获取指定分类中键对应的文字值，若为空则返回指定默认值
`void`	`load(String cfgFileName)` 根据配置文件绝对路径加载配置
`void`	`reload()` 重新加载配置文件内容
`Map<String,String>`	`toMap()` 获得配置对象内部加载的配置项映射
`Map<String,String>`	`toMap(String category)` 获得配置对象内部加载的配置项映射

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.ymate.platform.core.configuration.IConfigurationProvider
getSupportFileExtName

- Constructor Detail
  - AbstractConfigurationProvider
```
public AbstractConfigurationProvider()
```
- Method Detail
  - load
```
public void load(String cfgFileName)
          throws Exception
```
    Description copied from interface: IConfigurationProvider
    
    根据配置文件绝对路径加载配置
    
    Specified by:
    
    load in interface IConfigurationProvider
    
    Parameters:
    
    cfgFileName - 配置文件路径及名称
    
    Throws:
    
    Exception - 加载配置文件可能产生的异常
  - buildConfigFileParser
```
protected abstract IConfigFileParser buildConfigFileParser(URL cfgFileName)
                                                    throws Exception
```
    构建配置文件分析器对象
    
    Parameters:
    
    cfgFileName - 配置文件URL路径
    
    Returns:
    
    返回配置文件分析器对象
    
    Throws:
    
    Exception - 可能产生的任何异常
  - getConfigFileParser
```
public IConfigFileParser getConfigFileParser()
```
    Description copied from interface: IConfigurationProvider
    
    返回当前配置文件分析器
    
    Specified by:
    
    getConfigFileParser in interface IConfigurationProvider
    
    Returns:
    
    配置文件分析器
  - reload
```
public void reload()
            throws Exception
```
    Description copied from interface: IConfigurationProvider
    
    重新加载配置文件内容
    
    Specified by:
    
    reload in interface IConfigurationProvider
    
    Throws:
    
    Exception - 加载配置文件可能产生的异常
  - getCfgFileName
```
public String getCfgFileName()
```
    Description copied from interface: IConfigurationProvider
    
    获取当前加载的配置文件路径
    
    Specified by:
    
    getCfgFileName in interface IConfigurationProvider
    
    Returns:
    
    返回文件路径名称
  - getString
```
public String getString(String key)
```
    Description copied from interface: IConfigReader
    
    获得对应的文字值
    
    Specified by:
    
    getString in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    属性值
  - getString
```
public String getString(String key,
                        String defaultValue)
```
    Description copied from interface: IConfigReader
    
    获得对应的文字值，若为空则返回指定默认值
    
    Specified by:
    
    getString in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    属性值
  - getString
```
public String getString(String category,
                        String key,
                        String defaultValue)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键对应的文字值，若为空则返回指定默认值
    
    Specified by:
    
    getString in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    属性值
  - getList
```
public List<String> getList(String key)
```
    Description copied from interface: IConfigReader
    
    获得对应的文字值列表，其中匹配以key开头的键串
    
    Specified by:
    
    getList in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    文字值列表
  - getList
```
public List<String> getList(String category,
                            String key)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的对应的文字值列表，其中匹配以key开头的键串
    
    Specified by:
    
    getList in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    Returns:
    
    属性集合
  - getMap
```
public Map<String,String> getMap(String key)
```
    Description copied from interface: IConfigReader
    
    获取键值映射
    
    Specified by:
    
    getMap in interface IConfigReader
    
    Parameters:
    
    key - 键头标识
    
    Returns:
    
    键值映射
  - getMap
```
public Map<String,String> getMap(String category,
                                 String key)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的键值映射
    
    Specified by:
    
    getMap in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 键标识
    
    Returns:
    
    键值映射
  - getArray
```
public String[] getArray(String key)
```
    Description copied from interface: IConfigReader
    
    获取键值数组值
    
    Specified by:
    
    getArray in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    键值数组
  - getArray
```
public String[] getArray(String key,
                         String[] defaultValue)
```
    Description copied from interface: IConfigReader
    
    获取键值数组值
    
    Specified by:
    
    getArray in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    键值数组
  - getArray
```
public String[] getArray(String key,
                         boolean zeroSize)
```
    Description copied from interface: IConfigReader
    
    获取键值数组值
    
    Specified by:
    
    getArray in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    zeroSize - 是否返回空元素数组
    
    Returns:
    
    键值数组
  - getArray
```
public String[] getArray(String category,
                         String key,
                         boolean zeroSize)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的键值数组
    
    Specified by:
    
    getArray in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    zeroSize - 是否返回空元素数组
    
    Returns:
    
    键值数组
  - getInt
```
public int getInt(String key)
```
    Description copied from interface: IConfigReader
    
    获得对应的数字值
    
    Specified by:
    
    getInt in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    数字值
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    Description copied from interface: IConfigReader
    
    获得对应的数字值，若不存在则返回指定默认值
    
    Specified by:
    
    getInt in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    数字值
  - getInt
```
public int getInt(String category,
                  String key,
                  int defaultValue)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的对应的数字值，若为空则返回指定默认值
    
    Specified by:
    
    getInt in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    数字值
  - getBoolean
```
public boolean getBoolean(String key)
```
    Description copied from interface: IConfigReader
    
    获得对应的布尔值
    
    Specified by:
    
    getBoolean in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    布尔值
  - getBoolean
```
public boolean getBoolean(String key,
                          boolean defaultValue)
```
    Description copied from interface: IConfigReader
    
    获得对应的布尔值，若不存在则返回指定默认值
    
    Specified by:
    
    getBoolean in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    布尔值
  - getBoolean
```
public boolean getBoolean(String category,
                          String key,
                          boolean defaultValue)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的布尔值，若为空则返回指定默认值
    
    Specified by:
    
    getBoolean in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    布尔值
  - getLong
```
public long getLong(String key)
```
    Description copied from interface: IConfigReader
    
    获取长整数
    
    Specified by:
    
    getLong in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    长整数
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    Description copied from interface: IConfigReader
    
    获取长整数，若不存在则返回指定默认值
    
    Specified by:
    
    getLong in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    长整数
  - getLong
```
public long getLong(String category,
                    String key,
                    long defaultValue)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的长整数，若为空则返回指定默认值
    
    Specified by:
    
    getLong in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    长整数
  - getFloat
```
public float getFloat(String key)
```
    Description copied from interface: IConfigReader
    
    获取浮点数
    
    Specified by:
    
    getFloat in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    浮点数
  - getFloat
```
public float getFloat(String key,
                      float defaultValue)
```
    Description copied from interface: IConfigReader
    
    获取浮点数，若不存在则返回指定默认值
    
    Specified by:
    
    getFloat in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    浮点数
  - getFloat
```
public float getFloat(String category,
                      String key,
                      float defaultValue)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的浮点数，若为空则返回指定默认值
    
    Specified by:
    
    getFloat in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    浮点数
  - getDouble
```
public double getDouble(String key)
```
    Description copied from interface: IConfigReader
    
    获取双精度浮点数
    
    Specified by:
    
    getDouble in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    双精度浮点数
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    Description copied from interface: IConfigReader
    
    获取双精度浮点数，若不存在则返回指定默认值
    
    Specified by:
    
    getDouble in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    双精度浮点数
  - getClassImpl
```
public <T> T getClassImpl(String key,
                          Class<T> interfaceClass)
```
    Description copied from interface: IConfigReader
    
    获取接口实例类型
    
    Specified by:
    
    getClassImpl in interface IConfigReader
    
    Type Parameters:
    
    T - 类型
    
    Parameters:
    
    key - 属性键
    
    interfaceClass - 接口类型
    
    Returns:
    
    接口实例对象
  - getClassImpl
```
public <T> T getClassImpl(String key,
                          String defaultValue,
                          Class<T> interfaceClass)
```
    Description copied from interface: IConfigReader
    
    获取接口实例类型，若不存在则返回指定默认值
    
    Specified by:
    
    getClassImpl in interface IConfigReader
    
    Type Parameters:
    
    T - 类型
    
    Parameters:
    
    key - 属性键
    
    defaultValue - 默认值
    
    interfaceClass - 接口类型
    
    Returns:
    
    接口实例对象
  - getClassImpl
```
public <T> T getClassImpl(String category,
                          String key,
                          String defaultValue,
                          Class<T> interfaceClass)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的接口实例类型，若不存在则返回指定默认值
    
    Specified by:
    
    getClassImpl in interface IConfigurationProvider
    
    Type Parameters:
    
    T - 类型
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键ø
    
    defaultValue - 默认值
    
    interfaceClass - 接口类型
    
    Returns:
    
    接口实例对象
  - getDouble
```
public double getDouble(String category,
                        String key,
                        double defaultValue)
```
    Description copied from interface: IConfigurationProvider
    
    获取指定分类中键的双精度浮点数，若为空则返回指定默认值
    
    Specified by:
    
    getDouble in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    key - 属性键
    
    defaultValue - 默认值
    
    Returns:
    
    双精度浮点数
  - toMap
```
public Map<String,String> toMap()
```
    Description copied from interface: IConfigReader
    
    获得配置对象内部加载的配置项映射
    
    Specified by:
    
    toMap in interface IConfigReader
    
    Returns:
    
    配置项映射
  - toMap
```
public Map<String,String> toMap(String category)
```
    Description copied from interface: IConfigurationProvider
    
    获得配置对象内部加载的配置项映射
    
    Specified by:
    
    toMap in interface IConfigurationProvider
    
    Parameters:
    
    category - 分类名称
    
    Returns:
    
    配置项映射
  - getCategoryNames
```
public List<String> getCategoryNames()
```
    Description copied from interface: IConfigurationProvider
    
    获取分类的名称集合
    
    Specified by:
    
    getCategoryNames in interface IConfigurationProvider
    
    Returns:
    
    名称集合
  - contains
```
public boolean contains(String key)
```
    Description copied from interface: IConfigReader
    
    判断键key的配置项是否存在
    
    Specified by:
    
    contains in interface IConfigReader
    
    Parameters:
    
    key - 属性键
    
    Returns:
    
    如果存在配置项那么返回true，否则返回false
  - contains
```
public boolean contains(String category,
                        String key)
```
    Description copied from interface: IConfigurationProvider
    
    判断键key的配置项是否存在
    
    Specified by:
    
    contains in interface IConfigurationProvider
    
    Parameters:
    
    category - 集合名称
    
    key - 属性键
    
    Returns:
    
    如果存在配置项那么返回true，否则返回false

Class AbstractConfigurationProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.ymate.platform.core.configuration.IConfigurationProvider

Constructor Detail

AbstractConfigurationProvider

Method Detail

load

buildConfigFileParser

getConfigFileParser

reload

getCfgFileName

getString

getString

getString

getList

getList

getMap

getMap

getArray

getArray

getArray

getArray

getInt

getInt

getInt

getBoolean

getBoolean

getBoolean

getLong

getLong

getLong

getFloat

getFloat

getFloat

getDouble

getDouble

getClassImpl

getClassImpl

getClassImpl

getDouble

toMap

toMap

getCategoryNames

contains

contains