RaftProperties (Apache Ratis Common 2.3.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.

Constructor Summary

Constructors
Constructor and Description

RaftProperties()
A new configuration.

RaftProperties(RaftProperties other)
A new RaftProperties with the same settings cloned from another.

Constructors
Constructor and Description
`RaftProperties()` A new configuration.
`RaftProperties(RaftProperties other)` A new RaftProperties with the same settings cloned from another.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`.
`int`	`getInt(String name, int defaultValue)` Get the value of the `name` property as an `int`.
`long`	`getLong(String name, long defaultValue)` Get the value of the `name` property as a `long`.
`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[]`	`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.
`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`	`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`	`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`	`setTimeDuration(String name, TimeDuration value)` Set the value of `name` to the given time duration.
`int`	`size()`
`String`	`toString()`
`void`	`unset(String name)` Unset a previously set property.

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

- Constructor Detail
  - RaftProperties
```
public RaftProperties()
```
    A new configuration.
  - RaftProperties
```
public RaftProperties(RaftProperties other)
```
    A new RaftProperties with the same settings cloned from another.
    
    Parameters:
    
    other - the RaftProperties from which to clone settings.
- Method Detail
  - 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.
    
    Parameters:
    
    name - the property name, will be trimmed before get value.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - the property name.
    
    Returns:
    
    the value of the name or its replacing property, or null if no such property exists.
  - 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.
    
    Parameters:
    
    name - the property name.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - property name.
    
    value - property value.
    
    Throws:
    
    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.
    
    Parameters:
    
    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.
    
    Parameters:
    
    name - property name, will be trimmed before get value.
    
    defaultValue - default value.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - property name.
    
    defaultValue - default value.
    
    Returns:
    
    property value as an int, or defaultValue.
    
    Throws:
    
    NumberFormatException - when the value is invalid
  - setInt
```
public void setInt(String name,
                   int value)
```
    Set the value of the name property to an int.
    
    Parameters:
    
    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.
    
    Parameters:
    
    name - property name.
    
    defaultValue - default value.
    
    Returns:
    
    property value as a long, or defaultValue.
    
    Throws:
    
    NumberFormatException - when the value is invalid
  - getFile
```
public File getFile(String name,
                    File defaultValue)
```
    Returns:
    
    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.
    
    Parameters:
    
    name - the property name.
    
    defaultValue - default value.
    
    Returns:
    
    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)
```
    Returns:
    
    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.
    
    Parameters:
    
    name - property name.
    
    value - long value of the property.
  - 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.
    
    Parameters:
    
    name - property name.
    
    defaultValue - default value.
    
    Returns:
    
    property value as a double, or defaultValue.
    
    Throws:
    
    NumberFormatException - when the value is invalid
  - setDouble
```
public void setDouble(String name,
                      double value)
```
    Set the value of the name property to a double.
    
    Parameters:
    
    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.
    
    Parameters:
    
    name - property name.
    
    defaultValue - default value.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - property name.
    
    value - boolean value of the property.
  - 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()).
    
    Parameters:
    
    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.
    
    Parameters:
    
    name - Property name
    
    defaultValue - Value returned if no mapping exists
    
    Throws:
    
    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>).
    
    Parameters:
    
    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).
    
    Parameters:
    
    name - Property name
    
    defaultValue - Value returned if no mapping exists.
    
    Throws:
    
    NumberFormatException - If the property stripped of its unit is not a number
  - getTimeDuration
```
public BiFunction<String,TimeDuration,TimeDuration> getTimeDuration(TimeUnit defaultUnit)
```
  - 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.
    
    Parameters:
    
    name - property name.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - the property name.
    
    defaultValue - default value.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - the class name.
    
    defaultValue - default value.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - the class name.
    
    defaultValue - default value.
    
    xface - the interface implemented by the named class.
    
    Returns:
    
    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.
    
    Parameters:
    
    name - property name.
    
    theClass - property value.
    
    xface - the interface implemented by the named class.
  - size
```
public int size()
```
    Returns:
    
    number of keys in the properties.
  - clear
```
public void clear()
```
    Clears all keys from the configuration.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RaftProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RaftProperties

RaftProperties

Method Detail

get

getTrimmed

getRaw

set

unset

setIfUnset

get

getInt

setInt

getLong

getFile

getFiles

setFile

setFiles

getSizeInBytes

setLong

getDouble

setDouble

getBoolean

setBoolean

setEnum

getEnum

setTimeDuration

getTimeDuration

getTimeDuration

getTrimmedStrings

getClasses

getClass

getClass

setClass

size

clear

toString