cn.songxinqiang.stool.conf

Class ConfFileUtil

java.lang.Object

cn.songxinqiang.stool.conf.ConfFileUtil

public class ConfFileUtil
extends Object

配置文件操作工具类，实现对配置文件读取、写入
要注意的是，由于忽略了注释和空行，所以即使简单的直接读入再写回，那么也会使得文件内容变化（丢失注释和空行）
对于有节点的文件读取，节点使用[判断，所以任何以[开头的行都会整体作为一个键节点

Author:

阿信sxq

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR_EQUAL 分隔符, 等号("=")

Constructor Summary

Constructors

Constructor and Description
ConfFileUtil()

Method Summary

Modifier and Type	Method and Description
static Map<String,Map<String,String>>	readFileRecordWithNode(File file) 读取配置文件的信息，以键值对的形式返回读取到的信息 会忽略空行和以COMMENT_LINE_START指定内容开头的注释行， 对于由 NODE_START表示的字符串开头的行，将整行去掉首尾空格后作为键， 值也是一个键值对的形式，这些值都是这个节点之后、下一个节点之前的配置项， 配置项采用 分隔符(SEPARATOR_EQUAL)进行分隔，分隔符前面的部分作为键后面的部分作为值， 数据均采用 LinkedHashMap存储，会保留配置在文件中的记录顺序
static Map<String,Map<String,String>>	readFileRecordWithNode(String file) 读取配置文件的信息，等价于readFileRecordWithNode(new File(file))
static Map<String,String>	readFileRecordWithoutNode(File file) 读取配置文件的信息，将信息以键值对的形式返回 本方法读取的配置文件不应该包含有使用[]表示出来的节点，配置项采用 分隔符(SEPARATOR_EQUAL)进行分隔,分隔符前面的部分作为键后面的部分作为值， 如果配置没有对应的值，那么会在结果的键值对记录中存储null值
static Map<String,String>	readFileRecordWithoutNode(String file) 读取配置文件的信息，等价于readFileRecordWithoutNode(new File(file))
static void	writeFileRecordWithNode(String file, Map<String,Map<String,String>> map) 将配置信息写入配置文件
static void	writeFileRecordWithNode(String file, Map<String,Map<String,String>> map, boolean withSpace) 将配置信息写入到文件中，覆盖原文件信息，指定的文件若不存在会新建文件,会对节点不加处理，值会紧随键之后， 在键和值中间加入分隔符，分隔符使用(SEPARATOR_EQUAL, 在最后加入换行符(由System.getProperty("line.separator");确定)
static void	writeFileRecordWithoutNode(String file, Map<String,String> map) 将配置信息写入文件，分隔符两边不带空格
static void	writeFileRecordWithoutNode(String file, Map<String,String> map, boolean withSpace) 将配置信息写入到文件中，覆盖原文件信息，指定的文件若不存在会新建文件,值会紧随键之后， 在键和值中间加入分隔符，分隔符使用(SEPARATOR_EQUAL, 在最后加入换行符(由System.getProperty("line.separator");确定) 本方法输出的文件不包含节点

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR_EQUAL

public static final String SEPARATOR_EQUAL

分隔符, 等号("=")

See Also:

Constant Field Values

Constructor Detail

ConfFileUtil

public ConfFileUtil()

Method Detail

readFileRecordWithNode

public static final Map<String,Map<String,String>> readFileRecordWithNode(String file)

读取配置文件的信息，等价于readFileRecordWithNode(new File(file))

Parameters:

file - 文件的完整限定名

Returns:

键值对的形式返回配置信息，值为具体的节点的配置信息

See Also:

readFileRecordWithNode(File)

readFileRecordWithNode

public static final Map<String,Map<String,String>> readFileRecordWithNode(File file)

读取配置文件的信息，以键值对的形式返回读取到的信息
会忽略空行和以COMMENT_LINE_START指定内容开头的注释行， 对于由 NODE_START表示的字符串开头的行，将整行去掉首尾空格后作为键， 值也是一个键值对的形式，这些值都是这个节点之后、下一个节点之前的配置项， 配置项采用 分隔符(SEPARATOR_EQUAL)进行分隔，分隔符前面的部分作为键后面的部分作为值， 数据均采用 LinkedHashMap存储，会保留配置在文件中的记录顺序

Parameters:

file - 文件信息描述

Returns:

键值对的形式返回配置信息，值为具体的节点的配置信息

readFileRecordWithoutNode

public static final Map<String,String> readFileRecordWithoutNode(String file)

读取配置文件的信息，等价于readFileRecordWithoutNode(new File(file))

Parameters:

file - 需要读取的配置文件的完整路径

Returns:

配置文件中记录的配置信息的键值对

See Also:

readFileRecordWithoutNode(File)

readFileRecordWithoutNode

public static final Map<String,String> readFileRecordWithoutNode(File file)

读取配置文件的信息，将信息以键值对的形式返回
本方法读取的配置文件不应该包含有使用[]表示出来的节点，配置项采用 分隔符(SEPARATOR_EQUAL)进行分隔,分隔符前面的部分作为键后面的部分作为值， 如果配置没有对应的值，那么会在结果的键值对记录中存储null值

Parameters:

file - 需要读取的配置文件的信息描述

Returns:

配置文件中记录的配置信息的键值对

writeFileRecordWithNode

public static final void writeFileRecordWithNode(String file,
                                                 Map<String,Map<String,String>> map)

将配置信息写入配置文件

Parameters:

file - 文件路径

map - 配置信息

See Also:

writeFileRecordWithNode(String, Map, boolean)

writeFileRecordWithNode

public static final void writeFileRecordWithNode(String file,
                                                 Map<String,Map<String,String>> map,
                                                 boolean withSpace)

将配置信息写入到文件中，覆盖原文件信息，指定的文件若不存在会新建文件,会对节点不加处理，值会紧随键之后， 在键和值中间加入分隔符，分隔符使用(SEPARATOR_EQUAL, 在最后加入换行符(由System.getProperty("line.separator");确定)

Parameters:

file - 文件的完整限定名，若文件不存在会新建文件

map - 配置信息，键值对，值为配置详细的键值对

withSpace - 是否在分隔符两边加上空格

See Also:

FileIO.writeFile(String, List)

writeFileRecordWithoutNode

public static final void writeFileRecordWithoutNode(String file,
                                                    Map<String,String> map)

将配置信息写入文件，分隔符两边不带空格

Parameters:

file - 文件路径

map - 配置信息

writeFileRecordWithoutNode

public static final void writeFileRecordWithoutNode(String file,
                                                    Map<String,String> map,
                                                    boolean withSpace)

将配置信息写入到文件中，覆盖原文件信息，指定的文件若不存在会新建文件,值会紧随键之后， 在键和值中间加入分隔符，分隔符使用(SEPARATOR_EQUAL, 在最后加入换行符(由System.getProperty("line.separator");确定)
本方法输出的文件不包含节点

Parameters:

file - 输出到的目标文件，不存在的化会新建

map - 需要输出到目标文件的值，输出时会保留顺序

withSpace - 是否在分隔符两边加上空格

See Also:

输出到文件