RaftProperties (Apache Ratis Common 2.0.0 API)

java.lang.Object
- org.apache.ratis.conf.RaftProperties

```
public class RaftProperties
extends Object
```
Provides access to configuration parameters. The current implementation is a simplified version of hadoop's Configuration.

构造器概要

构造器
构造器和说明
`RaftProperties()` A new configuration.
`RaftProperties(boolean loadDefaults)` A new configuration where the behavior of reading from the default resources can be turned off.
`RaftProperties(RaftProperties other)` A new RaftProperties with the same settings cloned from another.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static void`	`addDefaultResource(String name)` Add a default resource.
`void`	`addResource(InputStream in)` Add a configuration resource.
`void`	`addResource(InputStream in, String name)` Add a configuration resource.
`void`	`addResource(RaftProperties conf)` Add a configuration resource.
`void`	`addResource(String name)` Add a configuration resource.
`void`	`addResource(URL path)`
`void`	`clear()` Clears all keys from the configuration.
`String`	`get(String name)` Get the value of the `name` property, `null` if no such property exists.
`String`	`get(String name, String defaultValue)` Get the value of the `name`.
`boolean`	`getBoolean(String name, boolean defaultValue)` Get the value of the `name` property as a `boolean`.
`Class<?>`	`getClass(String name, Class<?> defaultValue)` Get the value of the `name` property as a `Class`.
`<BASE> Class<? extends BASE>`	`getClass(String name, Class<? extends BASE> defaultValue, Class<BASE> xface)` Get the value of the `name` property as a `Class` implementing the interface specified by `xface`.
`Class<?>[]`	`getClasses(String name, Class<?>... defaultValue)` Get the value of the `name` property as an array of `Class`.
`double`	`getDouble(String name, double defaultValue)` Get the value of the `name` property as a `double`.
`<T extends Enum<T>> T`	`getEnum(String name, T defaultValue)` Return value matching this enumerated type.
`File`	`getFile(String name, File defaultValue)`
`List<File>`	`getFiles(String name, List<File> defaultValue)` Get the value of the `name` property as a list of `File`.
`float`	`getFloat(String name, float defaultValue)` Get the value of the `name` property as a `float`.
`int`	`getInt(String name, int defaultValue)` Get the value of the `name` property as an `int`.
`int[]`	`getInts(String name)` Get the value of the `name` property as a set of comma-delimited `int` values.
`long`	`getLong(String name, long defaultValue)` Get the value of the `name` property as a `long`.
`Pattern`	`getPattern(String name, Pattern defaultValue)` Get the value of the `name` property as a `Pattern`.
`protected Properties`	`getProps()`
`String`	`getRaw(String name)` Get the value of the `name` property, without doing variable expansion.If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null.
`SizeInBytes`	`getSizeInBytes(String name, SizeInBytes defaultValue)`
`TimeDuration`	`getTimeDuration(String name, TimeDuration defaultValue, TimeUnit defaultUnit)` Return time duration in the given time unit.
`BiFunction<String,TimeDuration,TimeDuration>`	`getTimeDuration(TimeUnit defaultUnit)`
`String`	`getTrimmed(String name)` Get the value of the `name` property as a trimmed `String`, `null` if no such property exists.
`String`	`getTrimmed(String name, String defaultValue)` Get the value of the `name` property as a trimmed `String`, `defaultValue` if no such property exists.
`String[]`	`getTrimmedStrings(String name)` Get the comma delimited values of the `name` property as an array of `String`s, trimmed of the leading and trailing whitespace.
`Map<String,String>`	`getValByRegex(String regex)` get keys matching the the regex
`void`	`reloadConfiguration()` Reload configuration from previously added resources.
`void`	`set(String name, String value)` Set the `value` of the `name` property.
`void`	`setBoolean(String name, boolean value)` Set the value of the `name` property to a `boolean`.
`void`	`setBooleanIfUnset(String name, boolean value)` Set the given property, if it is currently unset.
`void`	`setClass(String name, Class<?> theClass, Class<?> xface)` Set the value of the `name` property to the name of a `theClass` implementing the given interface `xface`.
`void`	`setDouble(String name, double value)` Set the value of the `name` property to a `double`.
`<T extends Enum<T>> void`	`setEnum(String name, T value)` Set the value of the `name` property to the given type.
`void`	`setFile(String name, File value)`
`void`	`setFiles(String name, List<File> value)`
`void`	`setFloat(String name, float value)` Set the value of the `name` property to a `float`.
`void`	`setIfUnset(String name, String value)` Sets a property if it is currently unset.
`void`	`setInt(String name, int value)` Set the value of the `name` property to an `int`.
`void`	`setLong(String name, long value)` Set the value of the `name` property to a `long`.
`void`	`setPattern(String name, Pattern pattern)` Set the given property to `Pattern`.
`void`	`setTimeDuration(String name, TimeDuration value)` Set the value of `name` to the given time duration.
`int`	`size()` Return the number of keys in the configuration.
`String`	`toString()`
`void`	`unset(String name)` Unset a previously set property.
`void`	`writeXml(OutputStream out)` Write out the non-default properties in this configuration to the given `OutputStream` using UTF-8 encoding.
`void`	`writeXml(Writer out)` Write out the non-default properties in this configuration to the given `Writer`.

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

- 构造器详细资料
  - RaftProperties
```
public RaftProperties()
```
    A new configuration.
  - RaftProperties
```
public RaftProperties(boolean loadDefaults)
```
    A new configuration where the behavior of reading from the default resources can be turned off. If the parameter loadDefaults is false, the new instance will not load resources from the default files.
    
    参数:
    
    loadDefaults - specifies whether to load from the default files
  - RaftProperties
```
public RaftProperties(RaftProperties other)
```
    A new RaftProperties with the same settings cloned from another.
    
    参数:
    
    other - the RaftProperties from which to clone settings.
- 方法详细资料
  - addDefaultResource
```
public static void addDefaultResource(String name)
```
    Add a default resource. Resources are loaded in the order of the resources added.
    
    参数:
    
    name - file name. File should be present in the classpath.
  - addResource
```
public void addResource(String name)
```
    Add a configuration resource. The properties of this resource will override properties of previously added resources, unless they were marked final.
    
    参数:
    
    name - resource to be added, the classpath is examined for a file with that name.
  - addResource
```
public void addResource(URL path)
```
  - addResource
```
public void addResource(InputStream in)
```
    Add a configuration resource. The properties of this resource will override properties of previously added resources, unless they were marked final. WARNING: The contents of the InputStream will be cached, by this method. So use this sparingly because it does increase the memory consumption.
    
    参数:
    
    in - InputStream to deserialize the object from. In will be read from when a get or set is called next. After it is read the stream will be closed.
  - addResource
```
public void addResource(InputStream in,
                        String name)
```
    Add a configuration resource. The properties of this resource will override properties of previously added resources, unless they were marked final.
    
    参数:
    
    in - InputStream to deserialize the object from.
    
    name - the name of the resource because InputStream.toString is not very descriptive some times.
  - addResource
```
public void addResource(RaftProperties conf)
```
    Add a configuration resource. The properties of this resource will override properties of previously added resources, unless they were marked final.
    
    参数:
    
    conf - Configuration object from which to load properties
  - reloadConfiguration
```
public void reloadConfiguration()
```
    Reload configuration from previously added resources. This method will clear all the configuration read from the added resources, and final parameters. This will make the resources to be read again before accessing the values. Values that are added via set methods will overlay values read from the resources.
  - get
```
public String get(String name)
```
    Get the value of the name property, null if no such property exists. If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null. Values are processed for variable expansion before being returned.
    
    参数:
    
    name - the property name, will be trimmed before get value.
    
    返回:
    
    the value of the name or its replacing property, or null if no such property exists.
  - getTrimmed
```
public String getTrimmed(String name)
```
    Get the value of the name property as a trimmed String, null if no such property exists. If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null Values are processed for variable expansion before being returned.
    
    参数:
    
    name - the property name.
    
    返回:
    
    the value of the name or its replacing property, or null if no such property exists.
  - getTrimmed
```
public String getTrimmed(String name,
                         String defaultValue)
```
    Get the value of the name property as a trimmed String, defaultValue if no such property exists. See @{Configuration#getTrimmed} for more details.
    
    参数:
    
    name - the property name.
    
    defaultValue - the property default value.
    
    返回:
    
    the value of the name or defaultValue if it is not set.
  - getRaw
```
public String getRaw(String name)
```
    Get the value of the name property, without doing variable expansion.If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null.
    
    参数:
    
    name - the property name.
    
    返回:
    
    the value of the name property or its replacing property and null if no such property exists.
  - set
```
public void set(String name,
                String value)
```
    Set the value of the name property. If name is deprecated, it also sets the value to the keys that replace the deprecated key. Name will be trimmed before put into configuration.
    
    参数:
    
    name - property name.
    
    value - property value.
    
    抛出:
    
    IllegalArgumentException - when the value or name is null.
  - unset
```
public void unset(String name)
```
    Unset a previously set property.
  - setIfUnset
```
public void setIfUnset(String name,
                       String value)
```
    Sets a property if it is currently unset.
    
    参数:
    
    name - the property name
    
    value - the new value
  - get
```
public String get(String name,
                  String defaultValue)
```
    Get the value of the name. If the key is deprecated, it returns the value of the first key which replaces the deprecated key and is not null. If no such property exists, then defaultValue is returned.
    
    参数:
    
    name - property name, will be trimmed before get value.
    
    defaultValue - default value.
    
    返回:
    
    property value, or defaultValue if the property doesn't exist.
  - getInt
```
public int getInt(String name,
                  int defaultValue)
```
    Get the value of the name property as an int. If no such property exists, the provided default value is returned, or if the specified value is not a valid int, then an error is thrown.
    
    参数:
    
    name - property name.
    
    defaultValue - default value.
    
    返回:
    
    property value as an int, or defaultValue.
    
    抛出:
    
    NumberFormatException - when the value is invalid
  - getInts
```
public int[] getInts(String name)
```
    Get the value of the name property as a set of comma-delimited int values. If no such property exists, an empty array is returned.
    
    参数:
    
    name - property name
    
    返回:
    
    property value interpreted as an array of comma-delimited int values
  - setInt
```
public void setInt(String name,
                   int value)
```
    Set the value of the name property to an int.
    
    参数:
    
    name - property name.
    
    value - int value of the property.
  - getLong
```
public long getLong(String name,
                    long defaultValue)
```
    Get the value of the name property as a long. If no such property exists, the provided default value is returned, or if the specified value is not a valid long, then an error is thrown.
    
    参数:
    
    name - property name.
    
    defaultValue - default value.
    
    返回:
    
    property value as a long, or defaultValue.
    
    抛出:
    
    NumberFormatException - when the value is invalid
  - getFile
```
public File getFile(String name,
                    File defaultValue)
```
    返回:
    
    property value; if it is not set, return the default value.
  - getFiles
```
public List<File> getFiles(String name,
                           List<File> defaultValue)
```
    Get the value of the name property as a list of File. The value of the property specifies a list of comma separated path names. If no such property is specified, then defaultValue is returned.
    
    参数:
    
    name - the property name.
    
    defaultValue - default value.
    
    返回:
    
    property value as a List of File, or defaultValue.
  - setFile
```
public void setFile(String name,
                    File value)
```
  - setFiles
```
public void setFiles(String name,
                     List<File> value)
```
  - getSizeInBytes
```
public SizeInBytes getSizeInBytes(String name,
                                  SizeInBytes defaultValue)
```
    返回:
    
    property value; if it is not set, return the default value.
  - setLong
```
public void setLong(String name,
                    long value)
```
    Set the value of the name property to a long.
    
    参数:
    
    name - property name.
    
    value - long value of the property.
  - getFloat
```
public float getFloat(String name,
                      float defaultValue)
```
    Get the value of the name property as a float. If no such property exists, the provided default value is returned, or if the specified value is not a valid float, then an error is thrown.
    
    参数:
    
    name - property name.
    
    defaultValue - default value.
    
    返回:
    
    property value as a float, or defaultValue.
    
    抛出:
    
    NumberFormatException - when the value is invalid
  - setFloat
```
public void setFloat(String name,
                     float value)
```
    Set the value of the name property to a float.
    
    参数:
    
    name - property name.
    
    value - property value.
  - getDouble
```
public double getDouble(String name,
                        double defaultValue)
```
    Get the value of the name property as a double. If no such property exists, the provided default value is returned, or if the specified value is not a valid double, then an error is thrown.
    
    参数:
    
    name - property name.
    
    defaultValue - default value.
    
    返回:
    
    property value as a double, or defaultValue.
    
    抛出:
    
    NumberFormatException - when the value is invalid
  - setDouble
```
public void setDouble(String name,
                      double value)
```
    Set the value of the name property to a double.
    
    参数:
    
    name - property name.
    
    value - property value.
  - getBoolean
```
public boolean getBoolean(String name,
                          boolean defaultValue)
```
    Get the value of the name property as a boolean. If no such property is specified, or if the specified value is not a valid boolean, then defaultValue is returned.
    
    参数:
    
    name - property name.
    
    defaultValue - default value.
    
    返回:
    
    property value as a boolean, or defaultValue.
  - setBoolean
```
public void setBoolean(String name,
                       boolean value)
```
    Set the value of the name property to a boolean.
    
    参数:
    
    name - property name.
    
    value - boolean value of the property.
  - setBooleanIfUnset
```
public void setBooleanIfUnset(String name,
                              boolean value)
```
    Set the given property, if it is currently unset.
    
    参数:
    
    name - property name
    
    value - new value
  - setEnum
```
public <T extends Enum<T>> void setEnum(String name,
                                        T value)
```
    Set the value of the name property to the given type. This is equivalent to set(<name>, value.toString()).
    
    参数:
    
    name - property name
    
    value - new value
  - getEnum
```
public <T extends Enum<T>> T getEnum(String name,
                                     T defaultValue)
```
    Return value matching this enumerated type. Note that the returned value is trimmed by this method.
    
    参数:
    
    name - Property name
    
    defaultValue - Value returned if no mapping exists
    
    抛出:
    
    IllegalArgumentException - If mapping is illegal for the type provided
  - setTimeDuration
```
public void setTimeDuration(String name,
                            TimeDuration value)
```
    Set the value of name to the given time duration. This is equivalent to set(<name>, value + <time suffix>).
    
    参数:
    
    name - Property name
    
    value - Time duration
  - getTimeDuration
```
public TimeDuration getTimeDuration(String name,
                                    TimeDuration defaultValue,
                                    TimeUnit defaultUnit)
```
    Return time duration in the given time unit. Valid units are encoded in properties as suffixes: nanoseconds (ns), microseconds (us), milliseconds (ms), seconds (s), minutes (m), hours (h), and days (d).
    
    参数:
    
    name - Property name
    
    defaultValue - Value returned if no mapping exists.
    
    抛出:
    
    NumberFormatException - If the property stripped of its unit is not a number
  - getTimeDuration
```
public BiFunction<String,TimeDuration,TimeDuration> getTimeDuration(TimeUnit defaultUnit)
```
  - getPattern
```
public Pattern getPattern(String name,
                          Pattern defaultValue)
```
    Get the value of the name property as a Pattern. If no such property is specified, or if the specified value is not a valid Pattern, then DefaultValue is returned. Note that the returned value is NOT trimmed by this method.
    
    参数:
    
    name - property name
    
    defaultValue - default value
    
    返回:
    
    property value as a compiled Pattern, or defaultValue
  - setPattern
```
public void setPattern(String name,
                       Pattern pattern)
```
    Set the given property to Pattern. If the pattern is passed as null, sets the empty pattern which results in further calls to getPattern(...) returning the default value.
    
    参数:
    
    name - property name
    
    pattern - new value
  - getTrimmedStrings
```
public String[] getTrimmedStrings(String name)
```
    Get the comma delimited values of the name property as an array of Strings, trimmed of the leading and trailing whitespace. If no such property is specified then an empty array is returned.
    
    参数:
    
    name - property name.
    
    返回:
    
    property value as an array of trimmed Strings, or empty array.
  - getClasses
```
public Class<?>[] getClasses(String name,
                             Class<?>... defaultValue)
```
    Get the value of the name property as an array of Class. The value of the property specifies a list of comma separated class names. If no such property is specified, then defaultValue is returned.
    
    参数:
    
    name - the property name.
    
    defaultValue - default value.
    
    返回:
    
    property value as a Class[], or defaultValue.
  - getClass
```
public Class<?> getClass(String name,
                         Class<?> defaultValue)
```
    Get the value of the name property as a Class. If no such property is specified, then defaultValue is returned.
    
    参数:
    
    name - the class name.
    
    defaultValue - default value.
    
    返回:
    
    property value as a Class, or defaultValue.
  - getClass
```
public <BASE> Class<? extends BASE> getClass(String name,
                                             Class<? extends BASE> defaultValue,
                                             Class<BASE> xface)
```
    Get the value of the name property as a Class implementing the interface specified by xface. If no such property is specified, then defaultValue is returned. An exception is thrown if the returned class does not implement the named interface.
    
    参数:
    
    name - the class name.
    
    defaultValue - default value.
    
    xface - the interface implemented by the named class.
    
    返回:
    
    property value as a Class, or defaultValue.
  - setClass
```
public void setClass(String name,
                     Class<?> theClass,
                     Class<?> xface)
```
    Set the value of the name property to the name of a theClass implementing the given interface xface. An exception is thrown if theClass does not implement the interface xface.
    
    参数:
    
    name - property name.
    
    theClass - property value.
    
    xface - the interface implemented by the named class.
  - getProps
```
protected Properties getProps()
```
  - size
```
public int size()
```
    Return the number of keys in the configuration.
    
    返回:
    
    number of keys in the configuration.
  - clear
```
public void clear()
```
    Clears all keys from the configuration.
  - writeXml
```
public void writeXml(OutputStream out)
              throws IOException
```
    Write out the non-default properties in this configuration to the given OutputStream using UTF-8 encoding.
    
    参数:
    
    out - the output stream to write to.
    
    抛出:
    
    IOException
  - writeXml
```
public void writeXml(Writer out)
              throws IOException
```
    Write out the non-default properties in this configuration to the given Writer.
    
    参数:
    
    out - the writer to write to.
    
    抛出:
    
    IOException
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getValByRegex
```
public Map<String,String> getValByRegex(String regex)
```
    get keys matching the the regex
    
    返回:
    
    a map with matching keys

类 RaftProperties

构造器概要

方法概要

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

构造器详细资料

RaftProperties

RaftProperties

RaftProperties

方法详细资料

addDefaultResource

addResource

addResource

addResource

addResource

addResource

reloadConfiguration

get

getTrimmed

getTrimmed

getRaw

set

unset

setIfUnset

get

getInt

getInts

setInt

getLong

getFile

getFiles

setFile

setFiles

getSizeInBytes

setLong

getFloat

setFloat

getDouble

setDouble

getBoolean

setBoolean

setBooleanIfUnset

setEnum

getEnum

setTimeDuration

getTimeDuration

getTimeDuration

getPattern

setPattern

getTrimmedStrings

getClasses

getClass

getClass

setClass

getProps

size

clear

writeXml

writeXml

toString

getValByRegex