cn.hutool.setting

Class GroupedSet

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,LinkedHashSet<String>>

cn.hutool.setting.GroupedSet

All Implemented Interfaces:

Serializable, Cloneable, Map<String,LinkedHashSet<String>>

public class GroupedSet
extends HashMap<String,LinkedHashSet<String>>

分组化的Set集合类
在配置文件中可以用中括号分隔不同的分组，每个分组会放在独立的Set中，用group区别
无分组的集合和`[]`分组集合会合并成员，重名的分组也会合并成员
分组配置文件如下：

 [group1]
 aaa
 bbb
 ccc
 
 [group2]
 aaa
 ccc
 ddd
 

Since:

3.1.0

Author:

Looly

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GroupedSet(Charset charset) 基本构造 需自定义初始化配置文件
GroupedSet(File configFile, Charset charset) 构造
GroupedSet(String pathBaseClassLoader) 构造
GroupedSet(String pathBaseClassLoader, Charset charset) 构造，使用相对于Class文件根目录的相对路径
GroupedSet(String path, Class<?> clazz, Charset charset) 构造，相对于classes读取文件
GroupedSet(URL url, Charset charset) 构造

Method Summary

Modifier and Type	Method and Description
boolean	contains(String group, Collection<String> values) 是否在给定分组的集合中全部包含指定值集合 如果给定分组对应集合不存在，则返回false
boolean	contains(String group, String value, String... otherValues) 是否在给定分组的集合中包含指定值 如果给定分组对应集合不存在，则返回false
Set<String>	getGroups()
String	getPath()
LinkedHashSet<String>	getValues(String group) 获得对应分组的所有值
boolean	init(URL groupedSetUrl, Charset charset) 初始化设定文件
boolean	load(InputStream settingStream) 加载设置文件。
boolean	load(URL groupedSetUrl) 加载设置文件
void	reload() 重新加载配置文件

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

GroupedSet

public GroupedSet(Charset charset)

基本构造
需自定义初始化配置文件

Parameters:

charset - 字符集

GroupedSet

public GroupedSet(String pathBaseClassLoader,
                  Charset charset)

构造，使用相对于Class文件根目录的相对路径

Parameters:

pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）

charset - 字符集

GroupedSet

public GroupedSet(File configFile,
                  Charset charset)

构造

Parameters:

configFile - 配置文件对象

charset - 字符集

GroupedSet

public GroupedSet(String path,
                  Class<?> clazz,
                  Charset charset)

构造，相对于classes读取文件

Parameters:

path - 相对路径

clazz - 基准类

charset - 字符集

GroupedSet

public GroupedSet(URL url,
                  Charset charset)

构造

Parameters:

url - 设定文件的URL

charset - 字符集

GroupedSet

public GroupedSet(String pathBaseClassLoader)

构造

Parameters:

pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）

Method Detail

init

public boolean init(URL groupedSetUrl,
                    Charset charset)

初始化设定文件

Parameters:

groupedSetUrl - 设定文件的URL

charset - 字符集

Returns:

成功初始化与否

load

public boolean load(URL groupedSetUrl)

加载设置文件

Parameters:

groupedSetUrl - 配置文件URL

Returns:

加载是否成功

reload

public void reload()

重新加载配置文件

load

public boolean load(InputStream settingStream)
             throws IOException

加载设置文件。 此方法不会关闭流对象

Parameters:

settingStream - 文件流

Returns:

加载成功与否

Throws:

IOException - IO异常

getPath

public String getPath()

Returns:

获得设定文件的路径

getGroups

public Set<String> getGroups()

Returns:

获得所有分组名

getValues

public LinkedHashSet<String> getValues(String group)

获得对应分组的所有值

Parameters:

group - 分组名

Returns:

分组的值集合

contains

public boolean contains(String group,
                        String value,
                        String... otherValues)

是否在给定分组的集合中包含指定值
如果给定分组对应集合不存在，则返回false

Parameters:

group - 分组名

value - 测试的值

otherValues - 其他值

Returns:

是否包含

contains

public boolean contains(String group,
                        Collection<String> values)

是否在给定分组的集合中全部包含指定值集合
如果给定分组对应集合不存在，则返回false

Parameters:

group - 分组名

values - 测试的值集合

Returns:

是否包含