implicit final class ApsoConfig extends AnyVal
- Alphabetic
- By Inheritance
- ApsoConfig
- AnyVal
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ApsoConfig(conf: Config)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- Any
-
final
def
##(): Int
- Definition Classes
- Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val conf: Config
-
def
get[T](path: String)(implicit configReader: ConfigReader[T]): T
Gets a value from this
Config.Gets a value from this
Config.- T
the type of the value to extract
- path
the path in the config
- returns
the value.
-
def
getBooleanListOption(path: String): Option[List[Boolean]]
Gets the value as a boolean list wrapped in a
Someif one is defined andNoneif not.Gets the value as a boolean list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a boolean list wrapped in a
Someif one is defined andNoneif not.
-
def
getBooleanOption(path: String): Option[Boolean]
Gets the value as a boolean wrapped in a
Someif one is defined andNoneif not.Gets the value as a boolean wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a boolean wrapped in a
Someif one is defined andNoneif not.
-
def
getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
-
def
getConfigListOption(path: String): Option[List[Config]]
Gets the value as a config list wrapped in a
Someif one is defined andNoneif not.Gets the value as a config list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a config list wrapped in a
Someif one is defined andNoneif not.
-
def
getConfigMap(path: String): Map[String, Config]
Gets the value as a Map[String, Config]
Gets the value as a Map[String, Config]
- path
the path in the config
- returns
the Map value
-
def
getConfigMapOption(path: String): Option[Map[String, Config]]
Gets the value as a Map[String, Config] wrapped in a
Someif it is defined andNoneif not.Gets the value as a Map[String, Config] wrapped in a
Someif it is defined andNoneif not.- path
the path in the config
- returns
the Map wrapped in a
Someif one is defined andNoneif not
-
def
getConfigOption(path: String): Option[Config]
Gets the value as a
Configwrapped in aSomeif one is defined andNoneif not.Gets the value as a
Configwrapped in aSomeif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a
Configwrapped in aSomeif one is defined andNoneif not.
-
def
getDoubleListOption(path: String): Option[List[Double]]
Gets the value as a double list wrapped in a
Someif one is defined andNoneif not.Gets the value as a double list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a double list wrapped in a
Someif one is defined andNoneif not.
-
def
getDoubleOption(path: String): Option[Double]
Gets the value as a double wrapped in a
Someif one is defined andNoneif not.Gets the value as a double wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a double wrapped in a
Someif one is defined andNoneif not.
-
def
getDurationListOption(path: String): Option[List[FiniteDuration]]
Gets the value as a duration list wrapped in a
Someif one is defined andNoneif not.Gets the value as a duration list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a duration list wrapped in a
Someif one is defined andNoneif not.
-
def
getDurationOption(path: String): Option[FiniteDuration]
Gets the value as a duration wrapped in a
Someif one is defined andNoneif not.Gets the value as a duration wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a duration wrapped in a
Someif one is defined andNoneif not.
-
def
getFlattenedMap[T](path: String)(implicit configReader: ConfigReader[T]): Map[String, T]
Gets the value as a deep flattened Map[String, T]
Gets the value as a deep flattened Map[String, T]
- T
the return type of the Map
- path
the path in the config
- returns
the Map value
-
def
getFlattenedMapOption[T](path: String)(implicit configReader: ConfigReader[T]): Option[Map[String, T]]
Gets the value as a deep flattened Map[String, T] wrapped in a
Someif it is defined andNoneif not.Gets the value as a deep flattened Map[String, T] wrapped in a
Someif it is defined andNoneif not.- T
the return type of the Map
- path
the path in the config
- returns
the Map wrapped in a
Someif one is defined andNoneif not
-
def
getIntListOption(path: String): Option[List[Integer]]
Gets the value as a int list wrapped in a
Someif one is defined andNoneif not.Gets the value as a int list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a int list wrapped in a
Someif one is defined andNoneif not.
-
def
getIntOption(path: String): Option[Int]
Gets the value as a int wrapped in a
Someif one is defined andNoneif not.Gets the value as a int wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a int wrapped in a
Someif one is defined andNoneif not.
-
def
getListOption(path: String): Option[List[ConfigValue]]
Gets the value as a list wrapped in a
Someif one is defined andNoneif not.Gets the value as a list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a list wrapped in a
Someif one is defined andNoneif not.
-
def
getLongListOption(path: String): Option[List[Long]]
Gets the value as a long list wrapped in a
Someif one is defined andNoneif not.Gets the value as a long list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a long list wrapped in a
Someif one is defined andNoneif not.
-
def
getLongOption(path: String): Option[Long]
Gets the value as a long wrapped in a
Someif one is defined andNoneif not.Gets the value as a long wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a long wrapped in a
Someif one is defined andNoneif not.
-
def
getMap[T](path: String)(implicit configReader: ConfigReader[T]): Map[String, T]
Gets the value as a Map[String, T]
Gets the value as a Map[String, T]
- T
the return type of the Map
- path
the path in the config
- returns
the Map value
-
def
getMapOption[T](path: String)(implicit configReader: ConfigReader[T]): Option[Map[String, T]]
Gets the value as a Map[String, T] wrapped in a
Someif it is defined andNoneif not.Gets the value as a Map[String, T] wrapped in a
Someif it is defined andNoneif not.- T
the return type of the Map
- path
the path in the config
- returns
the Map wrapped in a
Someif one is defined andNoneif not
-
def
getOption[T](path: String)(implicit configReader: ConfigReader[T]): Option[T]
Gets the value wrapped in a
Someif one is defined andNoneif not.Gets the value wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- T
the type of the value to extract
- path
the path in the config
- returns
the value as a boolean wrapped in a
Someif one is defined andNoneif not.
-
def
getPercentage(path: String): Double
Gets the value as a double from a percentage.
Gets the value as a double from a percentage.
- path
the path in the config
- returns
the percentage value as a double.
- Exceptions thrown
ConfigException.BadValueif the percentage does not end with '%' or if it is not a double.ConfigException.Missingif value is absent or null
-
def
getPercentageOption(path: String): Option[Double]
Gets the percentage value as a double wrapped in a
Someif it is defined andNoneif not.Gets the percentage value as a double wrapped in a
Someif it is defined andNoneif not.- path
the path in the config
- returns
the percentage value as a double wrapped in a
Someif one is defined andNoneif not.
- Exceptions thrown
ConfigException.BadValueif the percentage does not end with '%' or if it is not a double.
-
def
getStringListOption(path: String): Option[List[String]]
Gets the value as a string list wrapped in a
Someif one is defined andNoneif not.Gets the value as a string list wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a string list wrapped in a
Someif one is defined andNoneif not.
-
def
getStringOption(path: String): Option[String]
Gets the value as a string wrapped in a
Someif one is defined andNoneif not.Gets the value as a string wrapped in a
Someif one is defined andNoneif not. This method throws an exception if the path has a value associated but it is not of the requested type.- path
the path in the config
- returns
the value as a string wrapped in a
Someif one is defined andNoneif not.
-
def
getTypedList[T](path: String): List[T]
Gets the value as a List[T]
Gets the value as a List[T]
- T
the return type of the List
- path
the path in the config
- returns
the List value
-
def
getTypedListOption[T](path: String): Option[List[T]]
Gets the value as a List[T] wrapped in a
Someif it is defined andNoneif notGets the value as a List[T] wrapped in a
Someif it is defined andNoneif not- T
the return type of the List
- path
the path in the config
- returns
the List value wrapped in a
Someif it is defined andNoneif not
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
toConfigMap: Map[String, Config]
Converts the config into a Map[String, Config]
Converts the config into a Map[String, Config]
- returns
the Map value
-
def
toFlattenedMap[T](implicit configReader: ConfigReader[T]): Map[String, T]
Converts the config into a Map[String, T] with all the config keys flattened into one.
Converts the config into a Map[String, T] with all the config keys flattened into one.
- T
the return type of the Map
- returns
the Map value
-
def
toMap[T](implicit configReader: ConfigReader[T]): Map[String, T]
Converts the config into a Map[String, T]
Converts the config into a Map[String, T]
- T
the return type of the Map
- returns
the Map value
- Exceptions thrown
ConfigExceptionif the value cannot be read as typeT
-
def
toString(): String
- Definition Classes
- Any