RichConfigOps

Type Members

implicit class RichArgs extends AnyRef

Definition Classes
LowPriorityImplicits
implicit class RichMap extends AnyRef

Definition Classes
LowPriorityImplicits
implicit class RichString extends AnyRef

Definition Classes
LowPriorityImplicits

Abstract Value Members

abstract def config: Config

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def asDuration(key: String): Duration

key
the configuration path
returns
the value at the given key as a scala duration
def asFiniteDuration(key: String): FiniteDuration
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asList(path: String, separator: Option[String] = Option(",")): List[String]

produces a scala list, either from a StringList or a comma-separated string value
produces a scala list, either from a StringList or a comma-separated string value
path
the config path
separator
if specified, the value at the given path will be parsed if it is a string and not a stringlist
implicit def asRichConfig(c: Config): RichConfig

Definition Classes
LowPriorityImplicits
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def collectAsMap: Map[String, String]
def collectAsStrings: List[(String, String)]
def describe(implicit opts: ConfigRenderOptions = concise().setFormatted(true)): String
def entries: Set[Entry[String, ConfigValue]]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def filterNot(path: (String) ⇒ Boolean): Config
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def intersect(other: Config): Config
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def json: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def or(other: Config): Config
def origins: List[URL]

returns
a sorted list of the origins from when the config values come
def pathRoots: List[String]
def paths: List[String]
def show(options: ConfigRenderOptions = ...): Option[String]

If 'show=X' specified, configuration values which contain X in their path.
If 'show=X' specified, configuration values which contain X in their path.
If 'X' is 'all' or 'root', then the entire configuration is rendered.
This can be useful to debug other command-line args (to ensure they take the desired effect) or to validate the environment variable replacement
returns
the optional value of what's pointed to if 'show=<path>' is specified
def summary(pathFilter: (String) ⇒ Boolean = _ => true): List[StringEntry]

Return a property-like summary of the config using the pathFilter to trim property entries
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unique: Config
def uniquePaths: List[String]

And example which uses most of the below stuff to showcase what this is for Note : writing a 'diff' using this would be pretty straight forward
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withPaths(paths: List[String]): Config
def withPaths(first: String, theRest: String*): Config
def withUserArgs(args: Array[String], unrecognizedArg: (String) ⇒ Config = ParseArg.Throw): Config

args
the user arguments in the form <key>=<value>, <filePath> or <fileOnTheClasspath>
unrecognizedArg
what to do with malformed user input
returns
a configuration with the given user-argument overrides applied over top
def without(paths: TraversableOnce[String]): Config
def without(firstPath: String, theRest: String*): Config
def without(other: Config): Config
def withoutSystem: Config

this config w/o the system props and stuff

Related Doc: package config

trait RichConfigOps extends LowPriorityImplicits

Type Members

implicit class RichArgs extends AnyRef

implicit class RichMap extends AnyRef

implicit class RichString extends AnyRef

Abstract Value Members

abstract def config: Config

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def asDuration(key: String): Duration

def asFiniteDuration(key: String): FiniteDuration

final def asInstanceOf[T0]: T0

def asList(path: String, separator: Option[String] = Option(",")): List[String]

implicit def asRichConfig(c: Config): RichConfig

def clone(): AnyRef

def collectAsMap: Map[String, String]

def collectAsStrings: List[(String, String)]

def describe(implicit opts: ConfigRenderOptions = concise().setFormatted(true)): String

def entries: Set[Entry[String, ConfigValue]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def filterNot(path: (String) ⇒ Boolean): Config

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def intersect(other: Config): Config

final def isInstanceOf[T0]: Boolean

def json: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def or(other: Config): Config

def origins: List[URL]

def pathRoots: List[String]

def paths: List[String]

def show(options: ConfigRenderOptions = ...): Option[String]

def summary(pathFilter: (String) ⇒ Boolean = _ => true): List[StringEntry]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unique: Config

def uniquePaths: List[String]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withPaths(paths: List[String]): Config

def withPaths(first: String, theRest: String*): Config

def withUserArgs(args: Array[String], unrecognizedArg: (String) ⇒ Config = ParseArg.Throw): Config

def without(paths: TraversableOnce[String]): Config

def without(firstPath: String, theRest: String*): Config

def without(other: Config): Config

def withoutSystem: Config

Inherited from LowPriorityImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped