Packages

implicit final class ApsoConfig extends AnyVal

Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApsoConfig
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ApsoConfig(conf: Config)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val conf: Config
  6. 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.

  7. def getBooleanListOption(path: String): Option[List[Boolean]]

    Gets the value as a boolean list wrapped in a Some if one is defined and None if not.

    Gets the value as a boolean list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  8. def getBooleanOption(path: String): Option[Boolean]

    Gets the value as a boolean wrapped in a Some if one is defined and None if not.

    Gets the value as a boolean wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  9. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  10. def getConfigListOption(path: String): Option[List[Config]]

    Gets the value as a config list wrapped in a Some if one is defined and None if not.

    Gets the value as a config list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  11. 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

  12. def getConfigMapOption(path: String): Option[Map[String, Config]]

    Gets the value as a Map[String, Config] wrapped in a Some if it is defined and None if not.

    Gets the value as a Map[String, Config] wrapped in a Some if it is defined and None if not.

    path

    the path in the config

    returns

    the Map wrapped in a Some if one is defined and None if not

  13. def getConfigOption(path: String): Option[Config]

    Gets the value as a Config wrapped in a Some if one is defined and None if not.

    Gets the value as a Config wrapped in a Some if one is defined and None if 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 wrapped in a Some if one is defined and None if not.

  14. def getDoubleListOption(path: String): Option[List[Double]]

    Gets the value as a double list wrapped in a Some if one is defined and None if not.

    Gets the value as a double list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  15. def getDoubleOption(path: String): Option[Double]

    Gets the value as a double wrapped in a Some if one is defined and None if not.

    Gets the value as a double wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  16. def getDurationListOption(path: String): Option[List[FiniteDuration]]

    Gets the value as a duration list wrapped in a Some if one is defined and None if not.

    Gets the value as a duration list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  17. def getDurationOption(path: String): Option[FiniteDuration]

    Gets the value as a duration wrapped in a Some if one is defined and None if not.

    Gets the value as a duration wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  18. 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

  19. 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 Some if it is defined and None if not.

    Gets the value as a deep flattened Map[String, T] wrapped in a Some if it is defined and None if not.

    T

    the return type of the Map

    path

    the path in the config

    returns

    the Map wrapped in a Some if one is defined and None if not

  20. def getIntListOption(path: String): Option[List[Integer]]

    Gets the value as a int list wrapped in a Some if one is defined and None if not.

    Gets the value as a int list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  21. def getIntOption(path: String): Option[Int]

    Gets the value as a int wrapped in a Some if one is defined and None if not.

    Gets the value as a int wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  22. def getListOption(path: String): Option[List[ConfigValue]]

    Gets the value as a list wrapped in a Some if one is defined and None if not.

    Gets the value as a list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  23. def getLongListOption(path: String): Option[List[Long]]

    Gets the value as a long list wrapped in a Some if one is defined and None if not.

    Gets the value as a long list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  24. def getLongOption(path: String): Option[Long]

    Gets the value as a long wrapped in a Some if one is defined and None if not.

    Gets the value as a long wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  25. 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

  26. def getMapOption[T](path: String)(implicit configReader: ConfigReader[T]): Option[Map[String, T]]

    Gets the value as a Map[String, T] wrapped in a Some if it is defined and None if not.

    Gets the value as a Map[String, T] wrapped in a Some if it is defined and None if not.

    T

    the return type of the Map

    path

    the path in the config

    returns

    the Map wrapped in a Some if one is defined and None if not

  27. def getOption[T](path: String)(implicit configReader: ConfigReader[T]): Option[T]

    Gets the value wrapped in a Some if one is defined and None if not.

    Gets the value wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  28. 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.BadValue if the percentage does not end with '%' or if it is not a double.

    ConfigException.Missing if value is absent or null

  29. def getPercentageOption(path: String): Option[Double]

    Gets the percentage value as a double wrapped in a Some if it is defined and None if not.

    Gets the percentage value as a double wrapped in a Some if it is defined and None if not.

    path

    the path in the config

    returns

    the percentage value as a double wrapped in a Some if one is defined and None if not.

    Exceptions thrown

    ConfigException.BadValue if the percentage does not end with '%' or if it is not a double.

  30. def getStringListOption(path: String): Option[List[String]]

    Gets the value as a string list wrapped in a Some if one is defined and None if not.

    Gets the value as a string list wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  31. def getStringOption(path: String): Option[String]

    Gets the value as a string wrapped in a Some if one is defined and None if not.

    Gets the value as a string wrapped in a Some if one is defined and None if 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 Some if one is defined and None if not.

  32. 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

  33. def getTypedListOption[T](path: String): Option[List[T]]

    Gets the value as a List[T] wrapped in a Some if it is defined and None if not

    Gets the value as a List[T] wrapped in a Some if it is defined and None if not

    T

    the return type of the List

    path

    the path in the config

    returns

    the List value wrapped in a Some if it is defined and None if not

  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. 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

  36. 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

  37. 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

    ConfigException if the value cannot be read as type T

  38. def toString(): String
    Definition Classes
    Any

Inherited from AnyVal

Inherited from Any

Ungrouped