ciris.ConfigException.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ciris-core_native0.3_2.11 Show documentation

Ciris

There is a newer version: 0.12.1

Show newest version

package ciris

/**
  * [[ConfigException]] is a `Throwable` representation of [[ConfigErrors]].
  * [[ConfigException]] can be useful in cases where it is desirable to have
  * failed configuration loading halt program execution -- typically during
  * application startup.
  *
  * @param errors the underlying [[ConfigErrors]] of the exception
  */
final class ConfigException private (val errors: ConfigErrors)
    extends Throwable({
      val errorMessages =
        errors.toVector
          .map(error => s"  - ${error.message.stripSuffix(".")}.")
          .mkString("\n", "\n", "\n")

      s"configuration loading failed with the following errors.\n$errorMessages"
    }) {

  override def toString: String =
    s"ciris.ConfigException: $getMessage"
}

object ConfigException {

  /**
    * Creates a new [[ConfigException]] using the specified [[ConfigErrors]].
    *
    * @param errors the errors from which to create the exception
    * @return a new [[ConfigException]]
    */
  def apply(errors: ConfigErrors): ConfigException =
    new ConfigException(errors)
}