net.ymate.platform.core.configuration

Interface IConfigFileParser

All Known Implementing Classes:

AbstractConfigFileParser, JSONConfigFileParser, PropertyConfigFileParser, XMLConfigFileParser

@Ignored
public interface IConfigFileParser

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IConfigFileParser.Attribute
static class	IConfigFileParser.Category
static class	IConfigFileParser.Property

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CATEGORY_NAME
static String	TAG_NAME_ATTRIBUTES
static String	TAG_NAME_CATEGORIES
static String	TAG_NAME_CATEGORY
static String	TAG_NAME_ITEM
static String	TAG_NAME_PROPERTIES
static String	TAG_NAME_PROPERTY
static String	TAG_NAME_VALUE

Method Summary

Modifier and Type	Method and Description
IConfigFileParser.Attribute	getAttribute(String key) 获取指定键的属性对象
Map<String,IConfigFileParser.Attribute>	getAttributes() 获取全部属性映射
Map<String,IConfigFileParser.Category>	getCategories() 获取全部分类映射
IConfigFileParser.Category	getCategory(String name) 获取指定名称的分类
IConfigFileParser.Category	getDefaultCategory() 获取默认分类对象
IConfigFileParser	load(boolean sorted) 开始分析配置文件
IJsonObjectWrapper	toJson() 输出为JSON对象
void	writeTo(File targetFile) 将配置文件内容写入到目标文件
void	writeTo(OutputStream outputStream) 将配置文件内容写入到输出流

Field Detail

DEFAULT_CATEGORY_NAME

static final String DEFAULT_CATEGORY_NAME

See Also:

Constant Field Values

TAG_NAME_PROPERTIES

static final String TAG_NAME_PROPERTIES

See Also:

Constant Field Values

TAG_NAME_CATEGORY

static final String TAG_NAME_CATEGORY

See Also:

Constant Field Values

TAG_NAME_PROPERTY

static final String TAG_NAME_PROPERTY

See Also:

Constant Field Values

TAG_NAME_ITEM

static final String TAG_NAME_ITEM

See Also:

Constant Field Values

TAG_NAME_VALUE

static final String TAG_NAME_VALUE

See Also:

Constant Field Values

TAG_NAME_CATEGORIES

static final String TAG_NAME_CATEGORIES

See Also:

Constant Field Values

TAG_NAME_ATTRIBUTES

static final String TAG_NAME_ATTRIBUTES

See Also:

Constant Field Values

Method Detail

load

IConfigFileParser load(boolean sorted)

开始分析配置文件

Parameters:

sorted - 是否保证顺序

Returns:

返回当前分析器对象

writeTo

void writeTo(File targetFile)
      throws IOException

将配置文件内容写入到目标文件

Parameters:

targetFile - 目标文件

Throws:

IOException - 可能产生的IO异常

writeTo

void writeTo(OutputStream outputStream)
      throws IOException

将配置文件内容写入到输出流

Parameters:

outputStream - 目标输出流

Throws:

IOException - 可能产生的IO异常

getAttribute

IConfigFileParser.Attribute getAttribute(String key)

获取指定键的属性对象

Parameters:

key - 属性键

Returns:

属性对象

getAttributes

Map<String,IConfigFileParser.Attribute> getAttributes()

获取全部属性映射

Returns:

返回属性映射

getDefaultCategory

IConfigFileParser.Category getDefaultCategory()

获取默认分类对象

Returns:

返回分类对象

getCategory

IConfigFileParser.Category getCategory(String name)

获取指定名称的分类

Parameters:

name - 分类名称

Returns:

返回分类对象

getCategories

Map<String,IConfigFileParser.Category> getCategories()

获取全部分类映射

Returns:

返回分类对象映射

toJson

IJsonObjectWrapper toJson()

输出为JSON对象

Returns:

返回JSON对象