cn.hutool.setting.yaml

类 YamlUtil

java.lang.Object

cn.hutool.setting.yaml.YamlUtil

public class YamlUtil
extends Object

基于Snakeyaml的的YAML读写工具

从以下版本开始:

5.7.14

作者:

looly

构造器概要

构造器

构造器和说明
YamlUtil()

方法概要

限定符和类型	方法和说明
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 <T> T	load(InputStream in, Class<T> type) 从流中加载YAML
static 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 Dict	loadByPath(String path) 从classpath或绝对路径加载YAML文件
static <T> T	loadByPath(String path, Class<T> type) 从classpath或绝对路径加载YAML文件

从类继承的方法 java.lang.Object

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

构造器详细资料

YamlUtil

public YamlUtil()

方法详细资料

loadByPath

public static Dict loadByPath(String path)

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

参数:

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

返回:

加载的内容，默认Map

loadByPath

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

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

类型参数:

T - Bean类型，默认map

参数:

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

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

返回:

加载的内容，默认Map

load

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

从流中加载YAML

类型参数:

T - Bean类型，默认map

参数:

in - 流

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

返回:

加载的内容，默认Map

load

public static Dict load(Reader reader)

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

参数:

reader - Reader

返回:

加载的Map

load

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

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

类型参数:

T - Bean类型，默认map

参数:

reader - Reader

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

返回:

加载的内容，默认Map

load

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

加载YAML

类型参数:

T - Bean类型，默认map

参数:

reader - Reader

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

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

返回:

加载的内容，默认Map

dump

public static void dump(Object object,
                        Writer writer)

将Bean对象或者Map写出到Writer

参数:

object - 对象

writer - Writer

dump

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

将Bean对象或者Map写出到Writer

参数:

object - 对象

writer - Writer

dumperOptions - 输出风格