airframe-config
API
Generated with
airframe-config/wvlet.airframe.config/Config

Config

wvlet.airframe.config.Config
See theConfig companion object
case class Config(env: ConfigEnv, holder: Map[Surface, ConfigHolder]) extends ConfigCompat, Iterable[ConfigHolder], LogSupport

Attributes

Companion
object
Graph
Supertypes
trait Product
trait Equals
trait LogSupport
trait LazyLogger
trait LoggingMethods
trait Serializable
trait Iterable[ConfigHolder]
trait IterableFactoryDefaults[ConfigHolder, Iterable]
trait IterableOps[ConfigHolder, Iterable, Iterable[ConfigHolder]]
trait IterableOnceOps[ConfigHolder, Iterable, Iterable[ConfigHolder]]
trait IterableOnce[ConfigHolder]
trait ConfigCompat
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def +(h: ConfigHolder): Config
def +(other: Config): Config
def getAll: Seq[ConfigHolder]
override def iterator: Iterator[ConfigHolder]

Attributes

Definition Classes
IterableOnce
def ofSurface[ConfigType](surface: Surface): ConfigType
def overrideWith(props: Map[String, Any], onUnusedProperties: Properties => Unit): Config
def overrideWithProperties(props: Properties, onUnusedProperties: Properties => Unit): Config
def overrideWithPropertiesFile(propertiesFile: String, onUnusedProperties: Properties => Unit): Config
def printConfig: String
def registerFromYaml[ConfigType](surface: Surface, yamlFile: String): Config
def registerFromYamlOrElse[ConfigType](surface: Surface, yamlFile: String, defaultValue: => ConfigType): Config
def registerOfSurface[ConfigType](surface: Surface, config: ConfigType): Config
def toPrintableMap: Map[String, Any]

Create a map representation of this config for display purpose. Parameters with @secret annotation will be hidden.

Create a map representation of this config for display purpose. Parameters with @secret annotation will be hidden.

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Iterable -> Any
def withConfigPaths(paths: Seq[String]): Config
def withEnv(newEnv: String, defaultEnv: String): Config

Inherited methods

final def ++[B >: ConfigHolder](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
final def addString(b: StringBuilder): b.type

Attributes

Inherited from:
IterableOnceOps
final def addString(b: StringBuilder, sep: String): b.type

Attributes

Inherited from:
IterableOnceOps
def addString(b: StringBuilder, start: String, sep: String, end: String): b.type

Attributes

Inherited from:
IterableOnceOps
def collect[B](pf: PartialFunction[ConfigHolder, B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def collectFirst[B](pf: PartialFunction[ConfigHolder, B]): Option[B]

Attributes

Inherited from:
IterableOnceOps
def concat[B >: ConfigHolder](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def copyToArray[B >: ConfigHolder](xs: Array[B], start: Int, len: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: ConfigHolder](xs: Array[B], start: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: ConfigHolder](xs: Array[B]): Int

Attributes

Inherited from:
IterableOnceOps
def corresponds[B](that: IterableOnce[B])(p: (ConfigHolder, B) => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def count(p: ConfigHolder => Boolean): Int

Attributes

Inherited from:
IterableOnceOps
inline protected def debug(inline message: Any, inline cause: Throwable): Unit

Attributes

Inherited from:
LoggingMethods
inline protected def debug(inline message: Any): Unit

Attributes

Inherited from:
LoggingMethods
inline def defaultValueOf[ConfigType]: ConfigType

Attributes

Inherited from:
ConfigCompat
def drop(n: Int): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def dropRight(n: Int): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def dropWhile(p: ConfigHolder => Boolean): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
override def empty: Iterable[ConfigHolder]

Attributes

Definition Classes
IterableFactoryDefaults -> IterableOps
Inherited from:
IterableFactoryDefaults
inline protected def error(inline message: Any, inline cause: Throwable): Unit

Attributes

Inherited from:
LoggingMethods
inline protected def error(inline message: Any): Unit

Attributes

Inherited from:
LoggingMethods
def exists(p: ConfigHolder => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def filter(pred: ConfigHolder => Boolean): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def filterNot(pred: ConfigHolder => Boolean): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def find(p: ConfigHolder => Boolean): Option[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def flatMap[B](f: ConfigHolder => IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def flatten[B](implicit asIterable: ConfigHolder => IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def fold[A1 >: ConfigHolder](z: A1)(op: (A1, A1) => A1): A1

Attributes

Inherited from:
IterableOnceOps
def foldLeft[B](z: B)(op: (B, ConfigHolder) => B): B

Attributes

Inherited from:
IterableOnceOps
def foldRight[B](z: B)(op: (ConfigHolder, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def forall(p: ConfigHolder => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def foreach[U](f: ConfigHolder => U): Unit

Attributes

Inherited from:
IterableOnceOps
protected def fromSpecific(coll: IterableOnce[ConfigHolder]): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableFactoryDefaults
inline def getOrElse[ConfigType](default: => ConfigType): ConfigType

Attributes

Inherited from:
ConfigCompat
def groupBy[K](f: ConfigHolder => K): Map[K, Iterable[ConfigHolder]]

Attributes

Inherited from:
IterableOps
def groupMap[K, B](key: ConfigHolder => K)(f: ConfigHolder => B): Map[K, Iterable[B]]

Attributes

Inherited from:
IterableOps
def groupMapReduce[K, B](key: ConfigHolder => K)(f: ConfigHolder => B)(reduce: (B, B) => B): Map[K, B]

Attributes

Inherited from:
IterableOps
def grouped(size: Int): Iterator[Iterable[ConfigHolder]]

Attributes

Inherited from:
IterableOps
def head: ConfigHolder

Attributes

Inherited from:
IterableOps
def headOption: Option[ConfigHolder]

Attributes

Inherited from:
IterableOps
inline protected def info(inline message: Any, inline cause: Throwable): Unit

Attributes

Inherited from:
LoggingMethods
inline protected def info(inline message: Any): Unit

Attributes

Inherited from:
LoggingMethods
def init: Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def inits: Iterator[Iterable[ConfigHolder]]

Attributes

Inherited from:
IterableOps
def isEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
override def isTraversableAgain: Boolean

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def iterableFactory: IterableFactory[Iterable]

Attributes

Inherited from:
Iterable
def knownSize: Int

Attributes

Inherited from:
IterableOnce
def last: ConfigHolder

Attributes

Inherited from:
IterableOps
def lastOption: Option[ConfigHolder]

Attributes

Inherited from:
IterableOps
def lazyZip[B](that: Iterable[B]): LazyZip2[ConfigHolder, B, Iterable.this.type]

Attributes

Inherited from:
Iterable
inline protected def logAt(inline logLevel: LogLevel, inline message: Any): Unit

Attributes

Inherited from:
LoggingMethods
def map[B](f: ConfigHolder => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def max[B >: ConfigHolder](implicit ord: Ordering[B]): ConfigHolder

Attributes

Inherited from:
IterableOnceOps
def maxBy[B](f: ConfigHolder => B)(implicit ord: Ordering[B]): ConfigHolder

Attributes

Inherited from:
IterableOnceOps
def maxByOption[B](f: ConfigHolder => B)(implicit ord: Ordering[B]): Option[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def maxOption[B >: ConfigHolder](implicit ord: Ordering[B]): Option[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def min[B >: ConfigHolder](implicit ord: Ordering[B]): ConfigHolder

Attributes

Inherited from:
IterableOnceOps
def minBy[B](f: ConfigHolder => B)(implicit ord: Ordering[B]): ConfigHolder

Attributes

Inherited from:
IterableOnceOps
def minByOption[B](f: ConfigHolder => B)(implicit ord: Ordering[B]): Option[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def minOption[B >: ConfigHolder](implicit ord: Ordering[B]): Option[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
final def mkString: String

Attributes

Inherited from:
IterableOnceOps
final def mkString(sep: String): String

Attributes

Inherited from:
IterableOnceOps
final def mkString(start: String, sep: String, end: String): String

Attributes

Inherited from:
IterableOnceOps
protected def newSpecificBuilder: Builder[ConfigHolder, Iterable[ConfigHolder]]

Attributes

Inherited from:
IterableFactoryDefaults
def nonEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
inline def of[ConfigType]: ConfigType

Attributes

Inherited from:
ConfigCompat
def partition(p: ConfigHolder => Boolean): (Iterable[ConfigHolder], Iterable[ConfigHolder])

Attributes

Inherited from:
IterableOps
def partitionMap[A1, A2](f: ConfigHolder => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
def product[B >: ConfigHolder](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def reduce[B >: ConfigHolder](op: (B, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeft[B >: ConfigHolder](op: (B, ConfigHolder) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeftOption[B >: ConfigHolder](op: (B, ConfigHolder) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceOption[B >: ConfigHolder](op: (B, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceRight[B >: ConfigHolder](op: (ConfigHolder, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceRightOption[B >: ConfigHolder](op: (ConfigHolder, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
inline def register[ConfigType](config: ConfigType): Config

Attributes

Inherited from:
ConfigCompat
inline def registerDefault[ConfigType]: Config

Register the default value of the object as configuration

Register the default value of the object as configuration

Attributes

Inherited from:
ConfigCompat
inline def registerFromYaml[ConfigType](yamlFile: String): Config

Attributes

Inherited from:
ConfigCompat
inline def registerFromYamlOrElse[ConfigType](yamlFile: String, defaultValue: => ConfigType): Config

Attributes

Inherited from:
ConfigCompat
protected def reversed: Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def scan[B >: ConfigHolder](z: B)(op: (B, B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def scanLeft[B](z: B)(op: (B, ConfigHolder) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def scanRight[B](z: B)(op: (ConfigHolder, B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def size: Int

Attributes

Inherited from:
IterableOnceOps
def sizeCompare(that: Iterable[_]): Int

Attributes

Inherited from:
IterableOps
def sizeCompare(otherSize: Int): Int

Attributes

Inherited from:
IterableOps
final def sizeIs: SizeCompareOps

Attributes

Inherited from:
IterableOps
def slice(from: Int, until: Int): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def sliding(size: Int, step: Int): Iterator[Iterable[ConfigHolder]]

Attributes

Inherited from:
IterableOps
def sliding(size: Int): Iterator[Iterable[ConfigHolder]]

Attributes

Inherited from:
IterableOps
def span(p: ConfigHolder => Boolean): (Iterable[ConfigHolder], Iterable[ConfigHolder])

Attributes

Inherited from:
IterableOps
override def splitAt(n: Int): (Iterable[ConfigHolder], Iterable[ConfigHolder])

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def stepper[S <: Stepper[_]](implicit shape: StepperShape[ConfigHolder, S]): S

Attributes

Inherited from:
IterableOnce
def sum[B >: ConfigHolder](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def tail: Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def tails: Iterator[Iterable[ConfigHolder]]

Attributes

Inherited from:
IterableOps
def take(n: Int): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def takeRight(n: Int): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
def takeWhile(p: ConfigHolder => Boolean): Iterable[ConfigHolder]

Attributes

Inherited from:
IterableOps
override def tapEach[U](f: ConfigHolder => U): Iterable[ConfigHolder]

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def to[C1](factory: Factory[ConfigHolder, C1]): C1

Attributes

Inherited from:
IterableOnceOps
def toArray[B >: ConfigHolder : ClassTag]: Array[B]

Attributes

Inherited from:
IterableOnceOps
final def toBuffer[B >: ConfigHolder]: Buffer[B]

Attributes

Inherited from:
IterableOnceOps
def toIndexedSeq: IndexedSeq[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def toList: List[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def toMap[K, V](implicit ev: ConfigHolder <:< (K, V)): Map[K, V]

Attributes

Inherited from:
IterableOnceOps
def toSeq: Seq[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
def toSet[B >: ConfigHolder]: Set[B]

Attributes

Inherited from:
IterableOnceOps
def toVector: Vector[ConfigHolder]

Attributes

Inherited from:
IterableOnceOps
inline protected def trace(inline message: Any, inline cause: Throwable): Unit

Attributes

Inherited from:
LoggingMethods
inline protected def trace(inline message: Any): Unit

Attributes

Inherited from:
LoggingMethods
def transpose[B](implicit asIterable: ConfigHolder => Iterable[B]): Iterable[Iterable[B]]

Attributes

Inherited from:
IterableOps
def unzip[A1, A2](implicit asPair: ConfigHolder => (A1, A2)): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
def unzip3[A1, A2, A3](implicit asTriple: ConfigHolder => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

Attributes

Inherited from:
IterableOps
def view: View[ConfigHolder]

Attributes

Inherited from:
IterableOps
inline protected def warn(inline message: Any, inline cause: Throwable): Unit

Attributes

Inherited from:
LoggingMethods
inline protected def warn(inline message: Any): Unit

Attributes

Inherited from:
LoggingMethods
def withFilter(p: ConfigHolder => Boolean): WithFilter[ConfigHolder, Iterable]

Attributes

Inherited from:
IterableOps
def zip[B](that: IterableOnce[B]): Iterable[(ConfigHolder, B)]

Attributes

Inherited from:
IterableOps
def zipAll[A1 >: ConfigHolder, B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

Attributes

Inherited from:
IterableOps
def zipWithIndex: Iterable[(ConfigHolder, Int)]

Attributes

Inherited from:
IterableOps

Deprecated and Inherited methods

def ++:[B >: ConfigHolder](that: IterableOnce[B]): Iterable[B]

Attributes

Deprecated
[Since version 2.13.0] Use ++ instead of ++: for collections of type Iterable
Inherited from:
IterableOps
final def /:[B](z: B)(op: (B, ConfigHolder) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldLeft instead of /:
Inherited from:
IterableOnceOps
final def :\[B](z: B)(op: (ConfigHolder, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldRight instead of :\\
Inherited from:
IterableOnceOps
def aggregate[B](z: => B)(seqop: (B, ConfigHolder) => B, combop: (B, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] `aggregate` is not relevant for sequential collections. Use `foldLeft(z)(seqop)` instead.
Inherited from:
IterableOnceOps
def companion: IterableFactory[Iterable]

Attributes

Deprecated
[Since version 2.13.0] Use iterableFactory instead
Inherited from:
IterableOps
final def copyToBuffer[B >: ConfigHolder](dest: Buffer[B]): Unit

Attributes

Deprecated
[Since version 2.13.0] Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
def hasDefiniteSize: Boolean

Attributes

Deprecated
[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
Inherited from:
IterableOnceOps
final def repr: Iterable[ConfigHolder]

Attributes

Deprecated
[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
def seq: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.0] Iterable.seq always returns the iterable itself
Inherited from:
Iterable
final def toIterable: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
Iterable
final def toIterator: Iterator[ConfigHolder]

Attributes

Deprecated
[Since version 2.13.0] Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
final def toStream: Stream[ConfigHolder]

Attributes

Deprecated
[Since version 2.13.0] Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
final def toTraversable: Iterable[ConfigHolder]

Attributes

Deprecated
[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
def view(from: Int, until: Int): View[ConfigHolder]

Attributes

Deprecated
[Since version 2.13.0] Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps
Generated with