org.aoju.bus.setting

Class Builder

java.lang.Object

org.aoju.bus.setting.Builder

public class Builder
extends Object

构建器创建IniSetting示例 非线程安全

Since:

JDK 1.8+

Version:

6.3.5

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Builder.IniCommentCreator section create function
static interface	Builder.IniPropertyCreator property create function
static interface	Builder.IniSectionCreator section create function

Constructor Summary

Constructors

Constructor and Description
Builder()
Builder(Supplier<List<IniElement>> listSupplier)

Method Summary

Modifier and Type	Method and Description
IniSetting	build()
Builder	commentCreator(Builder.IniCommentCreator iniCommentCreator) 设置评论创建者功能
static void	dump(Object object, Writer writer) 将Bean对象或者Map写出到Writer
static void	dump(Object object, Writer writer, org.yaml.snakeyaml.DumperOptions dumperOptions) 将Bean对象或者Map写出到Writer
static Properties	getProperties(String name) 获取当前环境下的配置文件 name可以为不包括扩展名的文件名（默认.properties），也可以是文件名全称
static <T> T	load(InputStream in, Class<T> type) 从流中加载YAML
static org.aoju.bus.core.lang.Dict	load(Reader reader) 加载YAML，加载完毕后关闭Reader
static <T> T	load(Reader reader, Class<T> type) 加载YAML，加载完毕后关闭Reader
static <T> T	load(Reader reader, Class<T> type, boolean isCloseReader) 加载YAML
static org.aoju.bus.core.lang.Dict	load(String path) 从classpath或绝对路径加载YAML文件
static <T> T	load(String path, Class<T> type) 从classpath或绝对路径加载YAML文件
static void	parsePropsMap(Map<String,Object> result, String content) 解析PROPS
static void	parseYamlMap(Map<String,Object> result, String content) 解析YAML
static void	parseYamlMap(String prefix, Map<String,Object> result, Map<String,Object> content) 解析YAML
Builder	plus(Builder otherBuilder) Plus other builder
Builder	plus(List<IniElement> elements) Plus iniElement list
Builder	plusComment(String value)
Builder	plusProperties(Properties properties) Plus properties
Builder	plusProperties(Properties properties, IniComment comment) Plus properties
Builder	plusProperties(Properties properties, String commentValue) Plus properties
Builder	plusProperty(String key, String value) Plus a property
Builder	plusProperty(String key, String value, IniComment comment) Plus a property
Builder	plusProperty(String key, String value, String commentValue) Plus a property
Builder	plusSection(String value) Plus a section
Builder	plusSection(String value, IniComment comment) Plus a section with comment
Builder	plusSection(String value, String commentValue) Plus a section with comment
Builder	propertyCreator(Builder.IniPropertyCreator iniPropertyCreator) 设置属性创建器功能
static String	replaceRefValue(Properties properties, String value) 替换本地变量占位符
Builder	sectionCreator(Builder.IniSectionCreator iniSectionCreator) 设置分区创建者功能
Builder	skipLine(int length) 跳过线，向行添加空值

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder

public Builder(Supplier<List<IniElement>> listSupplier)

Method Detail

getProperties

public static Properties getProperties(String name)

获取当前环境下的配置文件
name可以为不包括扩展名的文件名（默认.properties），也可以是文件名全称

Parameters:

name - 文件名，如果没有扩展名，默认为.properties

Returns:

当前环境下配置文件

load

public static org.aoju.bus.core.lang.Dict load(String path)

从classpath或绝对路径加载YAML文件

Parameters:

path - YAML路径，相对路径相对classpath

Returns:

加载的内容，默认Map

load

public static <T> T load(String path,
                         Class<T> type)

从classpath或绝对路径加载YAML文件

Type Parameters:

T - Bean类型，默认map

Parameters:

path - YAML路径，相对路径相对classpath

type - 加载的Bean类型，即转换为的bean

Returns:

加载的内容，默认Map

load

public static <T> T load(InputStream in,
                         Class<T> type)

从流中加载YAML

Type Parameters:

T - Bean类型，默认map

Parameters:

in - 流

type - 加载的Bean类型，即转换为的bean

Returns:

加载的内容，默认Map

load

public static org.aoju.bus.core.lang.Dict load(Reader reader)

加载YAML，加载完毕后关闭Reader

Parameters:

reader - Reader

Returns:

加载的Map

load

public static <T> T load(Reader reader,
                         Class<T> type)

加载YAML，加载完毕后关闭Reader

Type Parameters:

T - Bean类型，默认map

Parameters:

reader - Reader

type - 加载的Bean类型，即转换为的bean

Returns:

加载的内容，默认Map

load

public static <T> T load(Reader reader,
                         Class<T> type,
                         boolean isCloseReader)

加载YAML

Type Parameters:

T - Bean类型，默认map

Parameters:

reader - Reader

type - 加载的Bean类型，即转换为的bean

isCloseReader - 加载完毕后是否关闭Reader

Returns:

加载的内容，默认Map

parsePropsMap

public static void parsePropsMap(Map<String,Object> result,
                                 String content)

解析PROPS

Parameters:

result - 数据结果

content - 数据内容

parseYamlMap

public static void parseYamlMap(Map<String,Object> result,
                                String content)

解析YAML

Parameters:

result - 数据结果

content - 数据内容

parseYamlMap

public static void parseYamlMap(String prefix,
                                Map<String,Object> result,
                                Map<String,Object> content)

解析YAML

Parameters:

prefix - 前缀信息

result - 数据结果

content - 数据内容

replaceRefValue

public static String replaceRefValue(Properties properties,
                                     String value)

替换本地变量占位符

Parameters:

properties - 属性信息

value - 值信息

Returns:

替换后的信息

dump

public static void dump(Object object,
                        Writer writer)

将Bean对象或者Map写出到Writer

Parameters:

object - 对象

writer - Writer

dump

public static void dump(Object object,
                        Writer writer,
                        org.yaml.snakeyaml.DumperOptions dumperOptions)

将Bean对象或者Map写出到Writer

Parameters:

object - 对象

writer - Writer

dumperOptions - 输出风格

sectionCreator

public Builder sectionCreator(Builder.IniSectionCreator iniSectionCreator)

设置分区创建者功能

Parameters:

iniSectionCreator - Builder.IniSectionCreator

Returns:

当前类对象信息

commentCreator

public Builder commentCreator(Builder.IniCommentCreator iniCommentCreator)

设置评论创建者功能

Parameters:

iniCommentCreator - Builder.IniCommentCreator

Returns:

当前类对象信息

propertyCreator

public Builder propertyCreator(Builder.IniPropertyCreator iniPropertyCreator)

设置属性创建器功能

Parameters:

iniPropertyCreator - Builder.IniPropertyCreator

Returns:

当前类对象信息

skipLine

public Builder skipLine(int length)

跳过线，向行添加空值

Parameters:

length - 跳过线

Returns:

当前类对象信息

plus

public Builder plus(Builder otherBuilder)

Plus other builder

Parameters:

otherBuilder - other builder

Returns:

当前类对象信息

plus

public Builder plus(List<IniElement> elements)

Plus iniElement list

Parameters:

elements - IniElement list

Returns:

当前类对象信息

plusSection

public Builder plusSection(String value)

Plus a section

Parameters:

value - section value

Returns:

当前类对象信息

plusSection

public Builder plusSection(String value,
                           IniComment comment)

Plus a section with comment

Parameters:

value - section value

comment - comment

Returns:

当前类对象信息

plusSection

public Builder plusSection(String value,
                           String commentValue)

Plus a section with comment

Parameters:

value - section value

commentValue - comment value

Returns:

当前类对象信息

plusProperty

public Builder plusProperty(String key,
                            String value)

Plus a property

Parameters:

key - key

value - value

Returns:

当前类对象信息

plusProperty

public Builder plusProperty(String key,
                            String value,
                            IniComment comment)

Plus a property

Parameters:

key - key

value - value

comment - 描述信息

Returns:

当前类对象信息

plusProperty

public Builder plusProperty(String key,
                            String value,
                            String commentValue)

Plus a property

Parameters:

key - key

value - value

commentValue - 描述信息

Returns:

当前类对象信息

plusProperties

public Builder plusProperties(Properties properties)

Plus properties

Parameters:

properties - properties

Returns:

当前类对象信息

plusProperties

public Builder plusProperties(Properties properties,
                              IniComment comment)

Plus properties

Parameters:

properties - properties

comment - 描述信息

Returns:

当前类对象信息

plusProperties

public Builder plusProperties(Properties properties,
                              String commentValue)

Plus properties

Parameters:

properties - properties

commentValue - 描述信息

Returns:

当前类对象信息

plusComment

public Builder plusComment(String value)

build

public IniSetting build()