Settings (milky-common 1.0.1 API)

java.lang.Object
- cn.sliew.milky.common.settings.Settings

public final class Settings
extends Object

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static SettingsBuilder`	`builder()` Returns a builder to be used in order to build settings.
`boolean`	`equals(Object o)`
`Settings`	`filter(Predicate<String> predicate)` Returns a new settings object that contains all setting of the current one filtered by the given settings key predicate.
`String`	`get(String setting)` Returns the setting value associated with the setting key.
`String`	`get(String setting, String defaultValue)` Returns the setting value associated with the setting key.
`Boolean`	`getAsBoolean(String setting, Boolean defaultValue)` Returns the setting value (as boolean) associated with the setting key.
`Double`	`getAsDouble(String setting, Double defaultValue)` Returns the setting value (as double) associated with the setting key.
`Float`	`getAsFloat(String setting, Float defaultValue)` Returns the setting value (as float) associated with the setting key.
`Map<String,Settings>`	`getAsGroups()` Returns group settings for the given setting prefix.
`Integer`	`getAsInt(String setting, Integer defaultValue)` Returns the setting value (as int) associated with the setting key.
`List<String>`	`getAsList(String key)` The values associated with a setting key as an immutable list.
`List<String>`	`getAsList(String key, List<String> defaultValue)` The values associated with a setting key as an immutable list.
`List<String>`	`getAsList(String key, List<String> defaultValue, Boolean commaDelimited)` The values associated with a setting key as an immutable list.
`Long`	`getAsLong(String setting, Long defaultValue)` Returns the setting value (as long) associated with the setting key.
`Settings`	`getAsSettings(String setting)` Returns the settings mapped to the given setting name.
`Settings`	`getByPrefix(String prefix)` A settings that are filtered (and key is removed) with the specified prefix.
`Map<String,Settings>`	`getGroups(String settingPrefix)` Returns group settings for the given setting prefix.
`Map<String,Settings>`	`getGroups(String settingPrefix, boolean ignoreNonGrouped)` Returns group settings for the given setting prefix.
`int`	`hashCode()`
`boolean`	`hasValue(String key)` Returns `true` iff the given key has a value in this settings object.
`boolean`	`isEmpty()` Returns `true` if this settings object contains no settings.
`Set<String>`	`keySet()` Returns the fully qualified setting names contained in this settings object.
`Set<String>`	`names()`
`int`	`size()` Returns the number of settings in this settings object.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this settings object contains no settings.
    
    返回:
    
    true if this settings object contains no settings
  - size
```
public int size()
```
    Returns the number of settings in this settings object.
  - keySet
```
public Set<String> keySet()
```
    Returns the fully qualified setting names contained in this settings object.
  - names
```
public Set<String> names()
```
    返回:
    
    The direct keys of this settings
  - hasValue
```
public boolean hasValue(String key)
```
    Returns true iff the given key has a value in this settings object.
  - get
```
public String get(String setting)
```
    Returns the setting value associated with the setting key.
    
    参数:
    
    setting - The setting key
    
    返回:
    
    The setting value, null if it does not exists.
  - get
```
public String get(String setting,
                  String defaultValue)
```
    Returns the setting value associated with the setting key. If it does not exists, returns the default value provided.
  - getByPrefix
```
public Settings getByPrefix(String prefix)
```
    A settings that are filtered (and key is removed) with the specified prefix.
  - getAsSettings
```
public Settings getAsSettings(String setting)
```
    Returns the settings mapped to the given setting name.
  - filter
```
public Settings filter(Predicate<String> predicate)
```
    Returns a new settings object that contains all setting of the current one filtered by the given settings key predicate.
  - getAsFloat
```
public Float getAsFloat(String setting,
                        Float defaultValue)
```
    Returns the setting value (as float) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsDouble
```
public Double getAsDouble(String setting,
                          Double defaultValue)
```
    Returns the setting value (as double) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsInt
```
public Integer getAsInt(String setting,
                        Integer defaultValue)
```
    Returns the setting value (as int) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsLong
```
public Long getAsLong(String setting,
                      Long defaultValue)
```
    Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsBoolean
```
public Boolean getAsBoolean(String setting,
                            Boolean defaultValue)
```
    Returns the setting value (as boolean) associated with the setting key. If it does not exists, returns the default value provided.
  - getAsList
```
public List<String> getAsList(String key)
                       throws SettingsException
```
    The values associated with a setting key as an immutable list.
    It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format.
    
    参数:
    
    key - The setting key to load the list by
    
    返回:
    
    The setting list values
    
    抛出:
    
    SettingsException
  - getAsList
```
public List<String> getAsList(String key,
                              List<String> defaultValue)
                       throws SettingsException
```
    The values associated with a setting key as an immutable list.
    If commaDelimited is true, it will automatically load a comma separated list under the settingPrefix and merge with the numbered format.
    
    参数:
    
    key - The setting key to load the list by
    
    返回:
    
    The setting list values
    
    抛出:
    
    SettingsException
  - getAsList
```
public List<String> getAsList(String key,
                              List<String> defaultValue,
                              Boolean commaDelimited)
                       throws SettingsException
```
    The values associated with a setting key as an immutable list.
    It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format.
    
    参数:
    
    key - The setting key to load the list by
    
    defaultValue - The default value to use if no value is specified
    
    commaDelimited - Whether to try to parse a string as a comma-delimited value
    
    返回:
    
    The setting list values
    
    抛出:
    
    SettingsException
  - getAsGroups
```
public Map<String,Settings> getAsGroups()
                                 throws SettingsException
```
    Returns group settings for the given setting prefix.
    
    抛出:
    
    SettingsException
  - getGroups
```
public Map<String,Settings> getGroups(String settingPrefix)
                               throws SettingsException
```
    Returns group settings for the given setting prefix.
    
    抛出:
    
    SettingsException
  - getGroups
```
public Map<String,Settings> getGroups(String settingPrefix,
                                      boolean ignoreNonGrouped)
                               throws SettingsException
```
    Returns group settings for the given setting prefix.
    
    抛出:
    
    SettingsException
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - builder
```
public static SettingsBuilder builder()
```
    Returns a builder to be used in order to build settings.

类 Settings

方法概要

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

方法详细资料

isEmpty

size

keySet

names

hasValue

get

get

getByPrefix

getAsSettings

filter

getAsFloat

getAsDouble

getAsInt

getAsLong

getAsBoolean

getAsList

getAsList

getAsList

getAsGroups

getGroups

getGroups

equals

hashCode

builder