PropertiesReader (Catalyst API Reference (1.1.1))

Constructors
Constructor and Description
`PropertiesReader(Properties properties)`

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getBoolean(String property)` Reads a boolean property.
`boolean`	`getBoolean(String property, boolean defaultValue)` Reads a boolean property.
`Class<?>`	`getClass(String property)` Reads a class property.
`Class<?>`	`getClass(String property, Class<?> defaultValue)` Reads a class property.
`<T> Collection<T>`	`getCollection(String prefix, Function<String,T> factory)` Reads a collection of properties based on a prefix.
`double`	`getDouble(String property)` Reads a double property.
`double`	`getDouble(String property, double defaultValue)` Reads a double property.
`Duration`	`getDuration(String property)` Reads a duration property.
`Duration`	`getDuration(String property, Duration defaultValue)` Reads a duration property.
`<T extends Enum<T>> T`	`getEnum(String property, Class<T> type)` Reads an enum property.
`<T extends Enum<T>> T`	`getEnum(String property, Class<T> type, T defaultValue)` Reads an enum property.
`File`	`getFile(String property)` Reads a file property.
`File`	`getFile(String property, File defaultValue)` Reads a file property.
`float`	`getFloat(String property)` Reads a float property.
`float`	`getFloat(String property, float defaultValue)` Reads a float property.
`int`	`getInteger(String property)` Reads an integer property.
`int`	`getInteger(String property, int defaultValue)` Reads an integer property.
`long`	`getLong(String property)` Reads a long property.
`long`	`getLong(String property, long defaultValue)` Reads a long property.
`<K,V> Map<K,V>`	`getMap(String prefix, Function<String,K> keyFactory, Function<String,V> valueFactory)` Returns a map of properties for a given prefix.
`short`	`getShort(String property)` Reads a short property.
`short`	`getShort(String property, short defaultValue)` Reads a short property.
`String`	`getString(String property)` Reads a string property, returning a default value if the property is not present.
`String`	`getString(String property, String defaultValue)` Reads a string property, returning a default value if the property is not present.
`static PropertiesReader`	`load(String propertiesFile)` Loads a properties reader for the given properties file on the local filesystem.
`static PropertiesReader`	`loadFromClasspath(String propertiesFile)` Loads a properties reader for the given properties file on the classpath.
`Properties`	`properties()` Returns the underlying properties.

java.lang.Object
- io.atomix.catalyst.util.PropertiesReader

```
public final class PropertiesReader
extends Object
```
Utility for reading configuration information from properties.
Author:
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  PropertiesReader(Properties properties)
  
  Method Summary
  
  All Methods Static Methods Instance Methods Concrete Methods
  Modifier and Type Method and Description
  
  boolean getBoolean(String property)
  Reads a boolean property.
  
  boolean getBoolean(String property, boolean defaultValue)
  Reads a boolean property.
  
  Class<?> getClass(String property)
  Reads a class property.
  
  Class<?> getClass(String property, Class<?> defaultValue)
  Reads a class property.
  
  <T> Collection<T> getCollection(String prefix, Function<String,T> factory)
  Reads a collection of properties based on a prefix.
  
  double getDouble(String property)
  Reads a double property.
  
  double getDouble(String property, double defaultValue)
  Reads a double property.
  
  Duration getDuration(String property)
  Reads a duration property.
  
  Duration getDuration(String property, Duration defaultValue)
  Reads a duration property.
  
  <T extends Enum<T>> T getEnum(String property, Class<T> type)
  Reads an enum property.
  
  <T extends Enum<T>> T getEnum(String property, Class<T> type, T defaultValue)
  Reads an enum property.
  
  File getFile(String property)
  Reads a file property.
  
  File getFile(String property, File defaultValue)
  Reads a file property.
  
  float getFloat(String property)
  Reads a float property.
  
  float getFloat(String property, float defaultValue)
  Reads a float property.
  
  int getInteger(String property)
  Reads an integer property.
  
  int getInteger(String property, int defaultValue)
  Reads an integer property.
  
  long getLong(String property)
  Reads a long property.
  
  long getLong(String property, long defaultValue)
  Reads a long property.
  
  <K,V> Map<K,V> getMap(String prefix, Function<String,K> keyFactory, Function<String,V> valueFactory)
  Returns a map of properties for a given prefix.
  
  short getShort(String property)
  Reads a short property.
  
  short getShort(String property, short defaultValue)
  Reads a short property.
  
  String getString(String property)
  Reads a string property, returning a default value if the property is not present.
  
  String getString(String property, String defaultValue)
  Reads a string property, returning a default value if the property is not present.
  
  static PropertiesReader load(String propertiesFile)
  Loads a properties reader for the given properties file on the local filesystem.
  
  static PropertiesReader loadFromClasspath(String propertiesFile)
  Loads a properties reader for the given properties file on the classpath.
  
  Properties properties()
  Returns the underlying properties.
  
  Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PropertiesReader
```
public PropertiesReader(Properties properties)
```
- Method Detail
  - load
```
public static PropertiesReader load(String propertiesFile)
```
    Loads a properties reader for the given properties file on the local filesystem.
    
    Parameters:
    
    propertiesFile - The properties file for which to load the reader.
    
    Returns:
    
    A new properties reader.
  - loadFromClasspath
```
public static PropertiesReader loadFromClasspath(String propertiesFile)
```
    Loads a properties reader for the given properties file on the classpath.
    
    Parameters:
    
    propertiesFile - The properties file for which to load the reader.
    
    Returns:
    
    A new properties reader.
  - properties
```
public Properties properties()
```
    Returns the underlying properties.
    
    Returns:
    
    The underlying properties.
  - getCollection
```
public <T> Collection<T> getCollection(String prefix,
                                       Function<String,T> factory)
```
    Reads a collection of properties based on a prefix.
    
    Type Parameters:
    
    T - The collection value type.
    
    Parameters:
    
    prefix - The prefix for which to read properties.
    
    factory - The factory to call for each property name in the collection.
    
    Returns:
    
    The collection.
  - getMap
```
public <K,V> Map<K,V> getMap(String prefix,
                             Function<String,K> keyFactory,
                             Function<String,V> valueFactory)
```
    Returns a map of properties for a given prefix.
    
    Type Parameters:
    
    K - The map key type.
    
    V - The map value type.
    
    Parameters:
    
    prefix - The prefix for which to return a map of property values.
    
    keyFactory - A converter function to convert the map keys.
    
    valueFactory - A converter function to convert the map values.
    
    Returns:
    
    The map.
  - getClass
```
public Class<?> getClass(String property)
```
    Reads a class property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getClass
```
public Class<?> getClass(String property,
                         Class<?> defaultValue)
```
    Reads a class property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getFile
```
public File getFile(String property)
```
    Reads a file property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getFile
```
public File getFile(String property,
                    File defaultValue)
```
    Reads a file property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getEnum
```
public <T extends Enum<T>> T getEnum(String property,
                                     Class<T> type)
```
    Reads an enum property.
    
    Type Parameters:
    
    T - The enum type.
    
    Parameters:
    
    property - The property name.
    
    type - The enum type.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getEnum
```
public <T extends Enum<T>> T getEnum(String property,
                                     Class<T> type,
                                     T defaultValue)
```
    Reads an enum property.
    
    Type Parameters:
    
    T - The enum type.
    
    Parameters:
    
    property - The property name.
    
    type - The enum type.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getString
```
public String getString(String property)
```
    Reads a string property, returning a default value if the property is not present.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getString
```
public String getString(String property,
                        String defaultValue)
```
    Reads a string property, returning a default value if the property is not present.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present.
    
    Returns:
    
    The property value.
  - getBoolean
```
public boolean getBoolean(String property)
```
    Reads a boolean property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getBoolean
```
public boolean getBoolean(String property,
                          boolean defaultValue)
```
    Reads a boolean property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getShort
```
public short getShort(String property)
```
    Reads a short property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getShort
```
public short getShort(String property,
                      short defaultValue)
```
    Reads a short property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getInteger
```
public int getInteger(String property)
```
    Reads an integer property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getInteger
```
public int getInteger(String property,
                      int defaultValue)
```
    Reads an integer property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getLong
```
public long getLong(String property)
```
    Reads a long property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getLong
```
public long getLong(String property,
                    long defaultValue)
```
    Reads a long property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getFloat
```
public float getFloat(String property)
```
    Reads a float property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getFloat
```
public float getFloat(String property,
                      float defaultValue)
```
    Reads a float property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getDouble
```
public double getDouble(String property)
```
    Reads a double property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getDouble
```
public double getDouble(String property,
                        double defaultValue)
```
    Reads a double property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.
  - getDuration
```
public Duration getDuration(String property)
```
    Reads a duration property.
    
    Parameters:
    
    property - The property name.
    
    Returns:
    
    The property value.
    
    Throws:
    
    ConfigurationException - if the property is not present
  - getDuration
```
public Duration getDuration(String property,
                            Duration defaultValue)
```
    Reads a duration property.
    
    Parameters:
    
    property - The property name.
    
    defaultValue - The default value to return if the property is not present
    
    Returns:
    
    The property value.

Class PropertiesReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropertiesReader

Method Detail

load

loadFromClasspath

properties

getCollection

getMap

getClass

getClass

getFile

getFile

getEnum

getEnum

getString

getString

getBoolean

getBoolean

getShort

getShort

getInteger

getInteger

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getDuration

getDuration