net.ymate.platform.core.configuration

Interface IConfiguration

All Superinterfaces:

IConfigReader

All Known Implementing Classes:

DefaultConfiguration

@Ignored
public interface IConfiguration
extends IConfigReader

配置对象接口定义

Author:

刘镇 (suninformation@163.com) on 2011-8-27 上午12:20:51

Method Summary

Modifier and Type	Method and Description
boolean	contains(String category, String key) 判断指定分类中是否包含指定的键
String[]	getArray(String category, String key, boolean zeroSize) 获取指定分类中键的数组值
boolean	getBoolean(String category, String key, boolean defaultValue) 获取指定分类中键的对应的布尔值，若不存在则返回指定默认值
List<String>	getCategoryNames() 获取分类的名称集合
int	getInt(String category, String key, int defaultValue) 获取指定分类中键的对应的数字值，若不存在则返回指定默认值
List<String>	getList(String category, String key) 获取指定分类中键的对应的文字值列表，其中匹配以key开头的键串
Map<String,String>	getMap(String category, String keyHead) 获取指定分类中键的键值映射
IConfigFileParser.Property	getProperty(String key) 获取指定键名的属性对象
IConfigFileParser.Property	getProperty(String category, String key) 获取指定分类中键的指定键名的属性对象
String	getString(String category, String key, String defaultValue) 获取指定分类中键的对应的文字值，若为空则返回指定默认值
String	getTagName() 获得配置文件自定义标签名称
void	initialize(IConfigurationProvider provider) 初始化配置项，一般用来从provider中获取配置项，是实现自定义的配置项进入内存的位置
void	reload() 重新加载配置文件内容
Map<String,String>	toMap(String category) 获取指定分类中键的配置对象内部加载的配置项映射

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

contains, getArray, getArray, getArray, getBoolean, getBoolean, getClassImpl, getClassImpl, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getList, getLong, getLong, getMap, getString, getString, toMap

Method Detail

getProperty

IConfigFileParser.Property getProperty(String category,
                                       String key)

获取指定分类中键的指定键名的属性对象

Parameters:

category - 分类名称

key - 属性键

Returns:

属性对象

getProperty

IConfigFileParser.Property getProperty(String key)

获取指定键名的属性对象

Parameters:

key - 属性键

Returns:

属性对象

getString

String getString(String category,
                 String key,
                 String defaultValue)

获取指定分类中键的对应的文字值，若为空则返回指定默认值

Parameters:

category - 分类名称

key - 属性键

defaultValue - 默认值

Returns:

属性值

getList

List<String> getList(String category,
                     String key)

获取指定分类中键的对应的文字值列表，其中匹配以key开头的键串

Parameters:

category - 分类名称

key - 属性键

Returns:

文字值列表

getMap

Map<String,String> getMap(String category,
                          String keyHead)

获取指定分类中键的键值映射

Parameters:

category - 分类名称

keyHead - 键头标识

Returns:

键值映射

getArray

String[] getArray(String category,
                  String key,
                  boolean zeroSize)

获取指定分类中键的数组值

Parameters:

category - 分类名称

key - 属性键

zeroSize - 是否返回空元素数组

Returns:

键值数组

getInt

int getInt(String category,
           String key,
           int defaultValue)

获取指定分类中键的对应的数字值，若不存在则返回指定默认值

Parameters:

category - 分类名称

key - 属性键

defaultValue - 默认值

Returns:

数字值

getBoolean

boolean getBoolean(String category,
                   String key,
                   boolean defaultValue)

获取指定分类中键的对应的布尔值，若不存在则返回指定默认值

Parameters:

category - 分类名称

key - 属性键

defaultValue - 默认值

Returns:

布尔值

toMap

Map<String,String> toMap(String category)

获取指定分类中键的配置对象内部加载的配置项映射

Parameters:

category - 分类名称

Returns:

配置项映射

getCategoryNames

List<String> getCategoryNames()

获取分类的名称集合

Returns:

分类名称集合

contains

boolean contains(String category,
                 String key)

判断指定分类中是否包含指定的键

Parameters:

category - 分类名称

key - 键名

Returns:

返回是否存在

initialize

void initialize(IConfigurationProvider provider)

初始化配置项，一般用来从provider中获取配置项，是实现自定义的配置项进入内存的位置

Parameters:

provider - 配置提供者

reload

void reload()
     throws Exception

重新加载配置文件内容

Throws:

Exception - 加载配置文件可能产生的异常

getTagName

String getTagName()

获得配置文件自定义标签名称

Returns:

返回值加在配置文件名与扩展名中间，形成XXXX.YYY.xml形式，其中需要返回.YYY