class RichConfig extends RichConfigOps
Adds some scala utility around a typesafe config
- Alphabetic
- By Inheritance
- RichConfig
- RichConfigOps
- LowPriorityArgs4cImplicits
- Dynamic
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RichConfig(config: Config)
Type Members
- implicit class RichArgs extends AnyRef
- Definition Classes
- LowPriorityArgs4cImplicits
- implicit class RichString extends AnyRef
- Definition Classes
- LowPriorityArgs4cImplicits
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
- Definition Classes
- RichConfigOps
- def asFiniteDuration(key: String): FiniteDuration
- Definition Classes
- RichConfigOps
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJson: String
- returns
the configuration as a json string
- Definition Classes
- RichConfigOps
- 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
- Definition Classes
- RichConfigOps
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def collectAsMap(options: ConfigRenderOptions = defaultRenderOptions): Map[String, String]
- returns
the configuration as a map
- Definition Classes
- RichConfigOps
- def collectAsStrings(options: ConfigRenderOptions = defaultRenderOptions): Seq[(String, String)]
- returns
the configuration as a set of key/value tuples
- Definition Classes
- RichConfigOps
- val config: Config
- returns
the configuration for which we're providing additional functionality
- Definition Classes
- RichConfig → RichConfigOps
- implicit def configAsRichConfig(c: Config): RichConfig
- Definition Classes
- LowPriorityArgs4cImplicits
- def defaultRenderOptions: ConfigRenderOptions
- Definition Classes
- RichConfigOps
- def encrypt(password: Array[Byte]): Array[Byte]
- returns
the encrypted configuration
- Definition Classes
- RichConfigOps
- def entries(arraySyntax: Boolean = true): Set[(String, ConfigValue)]
- arraySyntax
if true expand arrays with '.[x]' syntax
- returns
the configuration entries as a set of entries
- Definition Classes
- RichConfigOps
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def filter(pathFilter: (String) => Boolean): Config
- pathFilter
a predicate used to determine if the configuration path should be kept
- returns
a new configuration which just keeps the paths which include the provided path predicate
- Definition Classes
- RichConfigOps
- def filterNot(pathFilter: (String) => Boolean): Config
- pathFilter
a predicate used to determine if the configuration path should be kept
- returns
a new configuration which just keeps the paths which do NOT include the provided path predicate
- Definition Classes
- RichConfigOps
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hasValue(path: String): Boolean
- path
the config path
- returns
true if the config path is set in this config to a non-empty value. This will error if the path specified is an object or a list
- Definition Classes
- RichConfigOps
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def intersect(other: Config): Config
- returns
the configuration representing the intersection of the two configuration entries
- Definition Classes
- RichConfigOps
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def origins: List[String]
- returns
a sorted list of the origins from when the config values come
- Definition Classes
- RichConfigOps
- def overrideWith(configString: String): Config
- configString
the configuration (as a string) which should override this config -- essentially the inverse of 'withFallback'
- returns
a new configuration based on 'configString' with our config as a fallback
- Definition Classes
- RichConfigOps
- def overrideWith(overrideConfig: Config): Config
- overrideConfig
the configuration (as a string) which should override this config -- essentially the inverse of 'withFallback'
- returns
a new configuration based on 'configString' with our config as a fallback
- Definition Classes
- RichConfigOps
- def pathRoots: Seq[String]
The available config roots.
The available config roots.
e.g. of a config has
foo.bar.x = 1 java.home = /etc/java bar.enabled = true bar.user = root
The 'pathRoots' would return a [bar, foo, java]
- returns
a sorted list of the root entries to the config.
- Definition Classes
- RichConfigOps
- def paths(arraySyntax: Boolean = true): Seq[String]
- returns
all the unique paths for this configuration
- Definition Classes
- RichConfigOps
- def selectDynamic(path: String): Selected
- Definition Classes
- RichConfigOps
- def set(values: Map[String, Any], originDesc: String = "override"): Config
- Definition Classes
- RichConfigOps
- def set(key: String, value: Boolean): Config
- Definition Classes
- RichConfigOps
- def set(key: String, value: String): Config
- Definition Classes
- RichConfigOps
- def set(key: String, value: Long): Config
- key
the config path
- value
the value to set
- returns
a new configuration based on 'configString' with our config as a fallback
- Definition Classes
- RichConfigOps
- def setArray[T](key: String, value: Seq[T], originDesc: String = null): Config
- Definition Classes
- RichConfigOps
- def setArray[T](key: String, firstValue: T, secondValue: T, theRest: T*): Config
- Definition Classes
- RichConfigOps
- def showIfSpecified(obscure: (String, String) => String = obscurePassword(_, _)): Option[String]
If 'show=X' is specified, configuration values which contain X in their path will be displayed with the values matching 'obscure' obscured.
If 'show=X' is specified, configuration values which contain X in their path will be displayed with the values matching 'obscure' obscured.
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
- obscure
a function which takes a dotted configuration path and string value and returns the value to display
- returns
the optional value of what's pointed to if 'show=<path>' is specified
- Definition Classes
- RichConfigOps
- def summary(obscure: (String, String) => String = obscurePassword(_, _)): String
Return a property-like summary of the config using the pathFilter to trim property entries
Return a property-like summary of the config using the pathFilter to trim property entries
- obscure
a function which will 'safely' replace any config values with an obscured value
- returns
a summary of the configuration
- Definition Classes
- RichConfigOps
- def summaryEntries(obscure: (String, String) => String = obscurePassword(_, _)): Seq[StringEntry]
Return a property-like summary of the config using the 'obscure' function to mask sensitive entries
Return a property-like summary of the config using the 'obscure' function to mask sensitive entries
- obscure
a function which will 'safely' replace any config values with an obscured value
- Definition Classes
- RichConfigOps
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toMap: Map[String, ConfigValue]
- returns
the config as a map
- Definition Classes
- RichConfigOps
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withPaths(paths: Seq[String]): Config
- returns
this configuration which only contains the specified paths
- Definition Classes
- RichConfigOps
- def withPaths(first: String, theRest: String*): Config
- first
the first path to include (keep)
- theRest
any other paths to keep
- returns
this configuration which only contains the specified paths
- Definition Classes
- RichConfigOps
- def withUserArgs(args: Array[String], unrecognizedArg: (String) => Config = ParseArg.Throw): Config
Overlay the given arguments over this configuration, where the arguments are taken to be in the form:
Overlay the given arguments over this configuration, where the arguments are taken to be in the form:
$ the path to a configuration file, either on the classpath or file system $ a <key>=<value> pair where the key is a 'path.to.a.configuration.entry'
- 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
- Definition Classes
- RichConfigOps
- def without(configPaths: TraversableOnce[String]): Config
- configPaths
the paths to remove
- returns
a new configuration with the given paths removed
- Definition Classes
- RichConfigOps
- def without(firstPath: String, theRest: String*): Config
- firstPath
the first path to remove
- theRest
the remaining paths to remove
- returns
a new configuration with the given paths removed
- Definition Classes
- RichConfigOps
- def without(other: Config): Config
- other
the configuration to remove from this config
- returns
a new configuration with all values from 'other' removed
- Definition Classes
- RichConfigOps