ImmutableSettings (serviceframework-common

java.lang.Object
- net.csdn.common.settings.ImmutableSettings

All Implemented Interfaces:

Settings
```
public class ImmutableSettings
extends Object
implements Settings
```
BlogInfo: william Date: 11-9-1 Time: 下午3:56

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableSettings.Builder` A builder allowing to put different settings and then `ImmutableSettings.Builder.build()` an immutable settings implementation.
`static class`	`ImmutableSettings.YamlSettingsLoader`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`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.
`String[]`	`getAsArray(String settingPrefix)` The values associated with a setting prefix as an array.
`String[]`	`getAsArray(String settingPrefix, String[] defaultArray)` The values associated with a setting prefix as an array.
`Boolean`	`getAsBoolean(String setting, Boolean defaultValue)` Returns the setting value (as boolean) associated with the setting key.
`ByteSizeValue`	`getAsBytesSize(String setting, ByteSizeValue defaultValue)` Returns the setting value (as size) associated with the setting key.
`<T> Class<? extends T>`	`getAsClass(String setting, Class<? extends T> defaultClazz)` Returns the setting value (as a class) associated with the setting key.
`<T> Class<? extends T>`	`getAsClass(String setting, Class<? extends T> defaultClazz, String prefixPackage, String suffixClassName)` Returns the setting value (as a class) 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.
`Integer`	`getAsInt(String setting, Integer defaultValue)` Returns the setting value (as int) associated with the setting key.
`Long`	`getAsLong(String setting, Long defaultValue)` Returns the setting value (as long) associated with the setting key.
`tech.mlsql.common.utils.collect.ImmutableMap<String,String>`	`getAsMap()` The settings as a `Map`.
`SizeValue`	`getAsSize(String setting, SizeValue defaultValue)` Returns the setting value (as size) associated with the setting key.
`TimeValue`	`getAsTime(String setting, TimeValue defaultValue)` Returns the setting value (as time) associated with the setting key.
`Settings`	`getByPrefix(String prefix)` A settings that are filtered (and key is removed) with the specified prefix.
`ClassLoader`	`getClassLoader()` The class loader associated with this settings.
`Map<String,Settings>`	`getGroups(String settingPrefix)` Returns group settings for the given setting prefix.
`int`	`hashCode()`
`static ImmutableSettings.Builder`	`settingsBuilder()` Returns a builder to be used in order to build settings.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Description copied from interface: Settings
    
    The class loader associated with this settings.
    
    Specified by:
    
    getClassLoader in interface Settings
  - getAsMap
```
public tech.mlsql.common.utils.collect.ImmutableMap<String,String> getAsMap()
```
    Description copied from interface: Settings
    
    The settings as a Map.
    
    Specified by:
    
    getAsMap in interface Settings
  - getByPrefix
```
public Settings getByPrefix(String prefix)
```
    Description copied from interface: Settings
    
    A settings that are filtered (and key is removed) with the specified prefix.
    
    Specified by:
    
    getByPrefix in interface Settings
  - get
```
public String get(String setting)
```
    Description copied from interface: Settings
    
    Returns the setting value associated with the setting key.
    
    Specified by:
    
    get in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    Returns:
    
    The setting value, null if it does not exists.
  - get
```
public String get(String setting,
                  String defaultValue)
```
    Description copied from interface: Settings
    
    Returns the setting value associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    get in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The setting value, or the default value if no value exists
  - getAsFloat
```
public Float getAsFloat(String setting,
                        Float defaultValue)
```
    Description copied from interface: Settings
    
    Returns the setting value (as float) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsFloat in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (float) value, or the default value if no value exists.
  - getAsDouble
```
public Double getAsDouble(String setting,
                          Double defaultValue)
```
    Description copied from interface: Settings
    
    Returns the setting value (as double) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsDouble in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (double) value, or the default value if no value exists.
  - getAsInt
```
public Integer getAsInt(String setting,
                        Integer defaultValue)
```
    Description copied from interface: Settings
    
    Returns the setting value (as int) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsInt in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (int) value, or the default value if no value exists.
  - getAsLong
```
public Long getAsLong(String setting,
                      Long defaultValue)
```
    Description copied from interface: Settings
    
    Returns the setting value (as long) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsLong in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (long) value, or the default value if no value exists.
  - getAsBoolean
```
public Boolean getAsBoolean(String setting,
                            Boolean defaultValue)
```
    Description copied from interface: Settings
    
    Returns the setting value (as boolean) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsBoolean in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (boolean) value, or the default value if no value exists.
  - getAsTime
```
public TimeValue getAsTime(String setting,
                           TimeValue defaultValue)
```
    Description copied from interface: Settings
    
    Returns the setting value (as time) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsTime in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (time) value, or the default value if no value exists.
  - getAsBytesSize
```
public ByteSizeValue getAsBytesSize(String setting,
                                    ByteSizeValue defaultValue)
                             throws SettingsException
```
    Description copied from interface: Settings
    
    Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsBytesSize in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (size) value, or the default value if no value exists.
    
    Throws:
    
    SettingsException - Failure to parse the setting
  - getAsSize
```
public SizeValue getAsSize(String setting,
                           SizeValue defaultValue)
                    throws SettingsException
```
    Description copied from interface: Settings
    
    Returns the setting value (as size) associated with the setting key. If it does not exists, returns the default value provided.
    
    Specified by:
    
    getAsSize in interface Settings
    
    Parameters:
    
    setting - The setting key
    
    defaultValue - The value to return if no value is associated with the setting
    
    Returns:
    
    The (size) value, or the default value if no value exists.
    
    Throws:
    
    SettingsException - Failure to parse the setting
  - getAsClass
```
public <T> Class<? extends T> getAsClass(String setting,
                                         Class<? extends T> defaultClazz)
                                  throws NoClassSettingsException
```
    Description copied from interface: Settings
    
    Returns the setting value (as a class) associated with the setting key. If it does not exists, returns the default class provided.
    
    Specified by:
    
    getAsClass in interface Settings
    
    Type Parameters:
    
    T - The type of the class
    
    Parameters:
    
    setting - The setting key
    
    defaultClazz - The class to return if no value is associated with the setting
    
    Returns:
    
    The class setting value, or the default class provided is no value exists
    
    Throws:
    
    NoClassSettingsException - Failure to load a class
  - getAsClass
```
public <T> Class<? extends T> getAsClass(String setting,
                                         Class<? extends T> defaultClazz,
                                         String prefixPackage,
                                         String suffixClassName)
                                  throws NoClassSettingsException
```
    Description copied from interface: Settings
    
    Returns the setting value (as a class) associated with the setting key. If the value itself fails to represent a loadable class, the value will be appended to the prefixPackage and suffixed with the suffixClassName and it will try to be loaded with it.
    
    Specified by:
    
    getAsClass in interface Settings
    
    Type Parameters:
    
    T - The type of the class
    
    Parameters:
    
    setting - The setting key
    
    defaultClazz - The class to return if no value is associated with the setting
    
    prefixPackage - The prefix package to prefix the value with if failing to load the class as is
    
    suffixClassName - The suffix class name to prefix the value with if failing to load the class as is
    
    Returns:
    
    The class represented by the setting value, or the default class provided if no value exists
    
    Throws:
    
    NoClassSettingsException - Failure to load the class
  - getAsArray
```
public String[] getAsArray(String settingPrefix)
                    throws SettingsException
```
    Description copied from interface: Settings
    
    The values associated with a setting prefix as an array. The settings array is in the format of: settingPrefix.[index].
    
    It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format.
    
    Specified by:
    
    getAsArray in interface Settings
    
    Parameters:
    
    settingPrefix - The setting prefix to load the array by
    
    Returns:
    
    The setting array values
    
    Throws:
    
    SettingsException
  - getAsArray
```
public String[] getAsArray(String settingPrefix,
                           String[] defaultArray)
                    throws SettingsException
```
    Description copied from interface: Settings
    
    The values associated with a setting prefix as an array. The settings array is in the format of: settingPrefix.[index].
    
    It will also automatically load a comma separated list under the settingPrefix and merge with the numbered format.
    
    Specified by:
    
    getAsArray in interface Settings
    
    Parameters:
    
    settingPrefix - The setting prefix to load the array by
    
    Returns:
    
    The setting array values
    
    Throws:
    
    SettingsException
  - getGroups
```
public Map<String,Settings> getGroups(String settingPrefix)
                               throws SettingsException
```
    Description copied from interface: Settings
    
    Returns group settings for the given setting prefix.
    
    Specified by:
    
    getGroups in interface Settings
    
    Throws:
    
    SettingsException
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - settingsBuilder
```
public static ImmutableSettings.Builder settingsBuilder()
```
    Returns a builder to be used in order to build settings.

Class ImmutableSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getClassLoader

getAsMap

getByPrefix

get

get

getAsFloat

getAsDouble

getAsInt

getAsLong

getAsBoolean

getAsTime

getAsBytesSize

getAsSize

getAsClass

getAsClass

getAsArray

getAsArray

getGroups

equals

hashCode

settingsBuilder