Package org.hobbit.utils.config

Class HobbitConfiguration

java.lang.Object
org.apache.commons.configuration2.event.BaseEventSource
org.apache.commons.configuration2.AbstractConfiguration
org.apache.commons.configuration2.CompositeConfiguration
org.hobbit.utils.config.HobbitConfiguration
All Implemented Interfaces:
Cloneable, org.apache.commons.configuration2.Configuration, org.apache.commons.configuration2.event.EventSource, org.apache.commons.configuration2.ImmutableConfiguration, org.apache.commons.configuration2.sync.SynchronizerSupport
public class HobbitConfiguration extends org.apache.commons.configuration2.CompositeConfiguration

  • Constructor Summary

    Constructors
    Constructor
    Description
    HobbitConfiguration()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getBoolean(String name)
    Returns the value of the environmental variable with the given name as boolean or throws an IllegalStateException if the variable can not be found or an error occurs.
    boolean
    getBoolean(String name, boolean defaultValue)
    Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
    boolean
    getBoolean(String name, boolean defaultValue, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
    boolean
    getBoolean(String name, Supplier<Boolean> defaultValueFactory)
    Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
    boolean
    getBoolean(String name, Supplier<Boolean> defaultValueFactory, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
    boolean
    getBoolean(String name, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as boolean or throws an IllegalStateException if the variable can not be found or an error occurs.
    protected boolean
    getBooleanValue(String name, boolean defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue)
    Internal method defining the default value factory function before calling getBooleanValue(String, Supplier, Logger, boolean).
    protected boolean
    getBooleanValue(String name, Supplier<Boolean> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing)
    Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
    int
    getInt(String name)
    Returns the value of the environmental variable with the given name as int or throws an IllegalStateException if the variable can not be found or an error occurs.
    int
    getInt(String name, int defaultValue)
    Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
    int
    getInt(String name, int defaultValue, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
    int
    getInt(String name, Supplier<Integer> defaultValueFactory)
    Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
    int
    getInt(String name, Supplier<Integer> defaultValueFactory, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
    int
    getInt(String name, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as int or throws an IllegalStateException if the variable can not be found or an error occurs.
    protected int
    getIntValue(String name, int defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue)
    Internal method defining the default value factory function before calling getIntValue(String, Supplier, Logger, boolean).
    protected int
    getIntValue(String name, Supplier<Integer> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing)
    Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
    long
    getLong(String name)
    Returns the value of the environmental variable with the given name as long or throws an IllegalStateException if the variable can not be found or an error occurs.
    long
    getLong(String name, long defaultValue)
    Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
    long
    getLong(String name, long defaultValue, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
    long
    getLong(String name, Supplier<Long> defaultValueFactory)
    Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
    long
    getLong(String name, Supplier<Long> defaultValueFactory, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
    long
    getLong(String name, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as long or throws an IllegalStateException if the variable can not be found or an error occurs.
    protected long
    getLongValue(String name, long defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue)
    Internal method defining the default value factory function before calling getLongValue(String, Supplier, Logger, boolean).
    protected long
    getLongValue(String name, Supplier<Long> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing)
    Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
    org.apache.jena.rdf.model.Model
    getModel(String name)
    Returns the value of the environmental variable with the given name as Model or throws an IllegalStateException if the variable can not be found or an error occurs.
    org.apache.jena.rdf.model.Model
    getModel(String name, Supplier<org.apache.jena.rdf.model.Model> defaultValueFactory)
    Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
    org.apache.jena.rdf.model.Model
    getModel(String name, Supplier<org.apache.jena.rdf.model.Model> defaultValueFactory, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
    org.apache.jena.rdf.model.Model
    getModel(String name, org.apache.jena.rdf.model.Model defaultValue)
    Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
    org.apache.jena.rdf.model.Model
    getModel(String name, org.apache.jena.rdf.model.Model defaultValue, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
    org.apache.jena.rdf.model.Model
    getModel(String name, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as Model or throws an IllegalStateException if the variable can not be found or an error occurs.
    protected org.apache.jena.rdf.model.Model
    getModelValue(String name, Supplier<org.apache.jena.rdf.model.Model> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing)
    Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
    protected org.apache.jena.rdf.model.Model
    getModelValue(String name, org.apache.jena.rdf.model.Model defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue)
    Internal method defining the default value factory function before calling getModelValue(String, Supplier, Logger, boolean).
    String
    getString(String name)
    Returns the value of the environmental variable with the given name as String or throws an IllegalStateException if the variable can not be found or an error occurs.
    String
    getString(String name, String defaultValue)
    Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
    String
    getString(String name, String defaultValue, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
    String
    getString(String name, Supplier<String> defaultValueFactory)
    Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
    String
    getString(String name, Supplier<String> defaultValueFactory, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
    String
    getString(String name, org.slf4j.Logger logger)
    Returns the value of the environmental variable with the given name as String or throws an IllegalStateException if the variable can not be found or an error occurs.
    protected String
    getStringValue(String name, String defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue)
    Internal method defining the default value factory function before calling getStringValue(String, Supplier, Logger, boolean).
    protected String
    getStringValue(String name, Supplier<String> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing)
    Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
    protected <T> T
    getVariableValue(String name, Function<String,T> conversion, Supplier<T> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing)
    Generic method for accessing an environmental variable which has the given name and will be transformed into the return type using the given conversion function.

    Methods inherited from class org.apache.commons.configuration2.CompositeConfiguration

    addConfiguration, addConfiguration, addPropertyDirect, clearInternal, clearPropertyDirect, clone, containsKeyInternal, getConfiguration, getInMemoryConfiguration, getKeysInternal, getKeysInternal, getList, getNumberOfConfigurations, getPropertyInternal, getSource, getStringArray, isEmptyInternal, removeConfiguration, setListDelimiterHandler

    Methods inherited from class org.apache.commons.configuration2.AbstractConfiguration

    addErrorLogListener, addProperty, addPropertyInternal, append, beginRead, beginWrite, clear, clearProperty, cloneInterpolator, containsKey, copy, endRead, endWrite, get, get, getArray, getArray, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getByte, getByte, getByte, getCollection, getCollection, getConfigurationDecoder, getConversionHandler, getDouble, getDouble, getDouble, getEncodedString, getEncodedString, getFloat, getFloat, getFloat, getInteger, getInterpolator, getKeys, getKeys, getList, getList, getList, getListDelimiterHandler, getLogger, getLong, getProperties, getProperties, getProperty, getShort, getShort, getShort, getSynchronizer, immutableSubset, initLogger, installInterpolator, interpolate, interpolate, interpolatedConfiguration, isEmpty, isScalarValue, isThrowExceptionOnMissing, lock, setConfigurationDecoder, setConversionHandler, setDefaultLookups, setInterpolator, setLogger, setParentInterpolator, setPrefixLookups, setProperty, setPropertyInternal, setSynchronizer, setThrowExceptionOnMissing, size, sizeInternal, subset, unlock

    Methods inherited from class org.apache.commons.configuration2.event.BaseEventSource

    addEventListener, clearErrorListeners, clearEventListeners, copyEventListeners, createErrorEvent, createEvent, fireError, fireEvent, getEventListenerRegistrations, getEventListeners, isDetailEvents, removeEventListener, setDetailEvents

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • HobbitConfiguration

      public HobbitConfiguration()

  • Method Details

    • getVariableValue

      protected <T> T getVariableValue(String name, Function<String,T> conversion, Supplier<T> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing) throws IllegalStateException
      Generic method for accessing an environmental variable which has the given name and will be transformed into the return type using the given conversion function. The behavior in case of an error is defined by the given default value and Logger objects. If a problem occurs and a Logger is available, the error will be logged using the Logger.error(String) method. If exceptionWhenFailing is set to true an IllegalStateException is thrown. Else, if a defaultValueFactory is available, a default value will be returned. Otherwise null is returned.
      Parameters:
      name - name of the environmental variable which should be accessed
      conversion - the function which is used to convert the String of the variable value into the expected value type. It is assumed that this function will throw an exception if an error occurs.
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getString

      public String getString(String name) throws IllegalStateException
      Returns the value of the environmental variable with the given name as String or throws an IllegalStateException if the variable can not be found or an error occurs.
      Specified by:
      getString in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getString in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getString

      public String getString(String name, String defaultValue)
      Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
      Specified by:
      getString in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getString in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getString

      public String getString(String name, Supplier<String> defaultValueFactory)
      Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getString

      public String getString(String name, org.slf4j.Logger logger) throws IllegalStateException
      Returns the value of the environmental variable with the given name as String or throws an IllegalStateException if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getString

      public String getString(String name, String defaultValue, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getString

      public String getString(String name, Supplier<String> defaultValueFactory, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as String or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getStringValue

      protected String getStringValue(String name, String defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue) throws IllegalStateException
      Internal method defining the default value factory function before calling getStringValue(String, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      hasDefaultValue - flag indicating whether a default value has been provided.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getStringValue

      protected String getStringValue(String name, Supplier<String> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing) throws IllegalStateException
      Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getModel

      public org.apache.jena.rdf.model.Model getModel(String name) throws IllegalStateException
      Returns the value of the environmental variable with the given name as Model or throws an IllegalStateException if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getModel

      public org.apache.jena.rdf.model.Model getModel(String name, org.apache.jena.rdf.model.Model defaultValue)
      Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getModel

      public org.apache.jena.rdf.model.Model getModel(String name, Supplier<org.apache.jena.rdf.model.Model> defaultValueFactory)
      Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getModel

      public org.apache.jena.rdf.model.Model getModel(String name, org.slf4j.Logger logger) throws IllegalStateException
      Returns the value of the environmental variable with the given name as Model or throws an IllegalStateException if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getModel

      public org.apache.jena.rdf.model.Model getModel(String name, org.apache.jena.rdf.model.Model defaultValue, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getModel

      public org.apache.jena.rdf.model.Model getModel(String name, Supplier<org.apache.jena.rdf.model.Model> defaultValueFactory, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as Model or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getModelValue

      protected org.apache.jena.rdf.model.Model getModelValue(String name, org.apache.jena.rdf.model.Model defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue) throws IllegalStateException
      Internal method defining the default value factory function before calling getModelValue(String, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      hasDefaultValue - flag indicating whether a default value has been provided.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getModelValue

      protected org.apache.jena.rdf.model.Model getModelValue(String name, Supplier<org.apache.jena.rdf.model.Model> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing) throws IllegalStateException
      Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getInt

      public int getInt(String name) throws IllegalStateException
      Returns the value of the environmental variable with the given name as int or throws an IllegalStateException if the variable can not be found or an error occurs.
      Specified by:
      getInt in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getInt in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getInt

      public int getInt(String name, int defaultValue)
      Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
      Specified by:
      getInt in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getInt in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getInt

      public int getInt(String name, Supplier<Integer> defaultValueFactory)
      Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getInt

      public int getInt(String name, org.slf4j.Logger logger) throws IllegalStateException
      Returns the value of the environmental variable with the given name as int or throws an IllegalStateException if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getInt

      public int getInt(String name, int defaultValue, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getInt

      public int getInt(String name, Supplier<Integer> defaultValueFactory, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as int or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getIntValue

      protected int getIntValue(String name, int defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue) throws IllegalStateException
      Internal method defining the default value factory function before calling getIntValue(String, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      hasDefaultValue - flag indicating whether a default value has been provided.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getIntValue

      protected int getIntValue(String name, Supplier<Integer> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing) throws IllegalStateException
      Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getLong

      public long getLong(String name) throws IllegalStateException
      Returns the value of the environmental variable with the given name as long or throws an IllegalStateException if the variable can not be found or an error occurs.
      Specified by:
      getLong in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getLong in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getLong

      public long getLong(String name, long defaultValue)
      Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
      Specified by:
      getLong in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getLong in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getLong

      public long getLong(String name, Supplier<Long> defaultValueFactory)
      Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getLong

      public long getLong(String name, org.slf4j.Logger logger) throws IllegalStateException
      Returns the value of the environmental variable with the given name as long or throws an IllegalStateException if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getLong

      public long getLong(String name, long defaultValue, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getLong

      public long getLong(String name, Supplier<Long> defaultValueFactory, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as long or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getLongValue

      protected long getLongValue(String name, long defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue) throws IllegalStateException
      Internal method defining the default value factory function before calling getLongValue(String, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      hasDefaultValue - flag indicating whether a default value has been provided.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getLongValue

      protected long getLongValue(String name, Supplier<Long> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing) throws IllegalStateException
      Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getBoolean

      public boolean getBoolean(String name) throws IllegalStateException
      Returns the value of the environmental variable with the given name as boolean or throws an IllegalStateException if the variable can not be found or an error occurs.
      Specified by:
      getBoolean in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getBoolean in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getBoolean

      public boolean getBoolean(String name, boolean defaultValue)
      Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
      Specified by:
      getBoolean in interface org.apache.commons.configuration2.ImmutableConfiguration
      Overrides:
      getBoolean in class org.apache.commons.configuration2.AbstractConfiguration
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getBoolean

      public boolean getBoolean(String name, Supplier<Boolean> defaultValueFactory)
      Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getBoolean

      public boolean getBoolean(String name, org.slf4j.Logger logger) throws IllegalStateException
      Returns the value of the environmental variable with the given name as boolean or throws an IllegalStateException if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value
      Throws:
      IllegalStateException - if the variable can not be found or an error occurs.

    • getBoolean

      public boolean getBoolean(String name, boolean defaultValue, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getBoolean

      public boolean getBoolean(String name, Supplier<Boolean> defaultValueFactory, org.slf4j.Logger logger)
      Returns the value of the environmental variable with the given name as boolean or the default value if the variable can not be found or an error occurs.
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      Returns:
      the variable value or the default value if an error occurred and a default value is available.

    • getBooleanValue

      protected boolean getBooleanValue(String name, boolean defaultValue, org.slf4j.Logger logger, boolean exceptionWhenFailing, boolean hasDefaultValue) throws IllegalStateException
      Internal method defining the default value factory function before calling getBooleanValue(String, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValue - the default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      hasDefaultValue - flag indicating whether a default value has been provided.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.

    • getBooleanValue

      protected boolean getBooleanValue(String name, Supplier<Boolean> defaultValueFactory, org.slf4j.Logger logger, boolean exceptionWhenFailing) throws IllegalStateException
      Internal method defining the conversion function before calling getVariableValue(String, Function, Supplier, Logger, boolean).
      Parameters:
      name - name of the environmental variable which should be accessed
      defaultValueFactory - A factory method which can be used to generate a default value which will be returned if the variable can not be found or if an error occurs.
      logger - the Logger which will be used to log errors if they occur.
      exceptionWhenFailing - flag indicating whether an exception should be thrown if an error occurs.
      Returns:
      the variable value converted to the expected value or the default value if an error occurred and a default value is available.
      Throws:
      IllegalStateException - if exceptionWhenFailing is set to true and one of the following two errors occurs: 1) the variable is not available or 2) the conversion function throws an exception.