Args4c

can convert command-line arguments (a Seq[String]) into an Either[String, Config] representing either a successfully merged configuration (Right(config)) or an error.

The user arguments can be:

the relative path to a config file
the absolute path to a config file
the path to a config file on the classpath
a key/value pair to a configuration value in the form:
- <key> = <value>
- <key>=<value>
- -<key> = <value>
- -<key>=<value>

The values are resolved left-to right, with any key/value settings taking precidence over any file settings.

MyApp foo=bar myConf.conf x.y.z=1,2,3 anotherConf.properties

would use the configuration value 'bar' for property 'foo' and "1,2,3" for property x.y.z over any properties in myConf.conf or anotherConf.properties.

Then any values in myConf.conf would have its configuration settings take precidence over anotherConf.properties

Linear Supertypes

AnyRef, Any

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def configAtPath(c: Config, path: String, defaultValue: String = "<invalid path>"): Config

Given a configuration and a path, return the configuration at that path.
Given a configuration and a path, return the configuration at that path.
If the path is invalid or points to a value which is NOT a configuration, a "synthetic" configuration will be created for the path to either hold the value at the path or the default value
c
the configuration to parse
path
the configuration path
defaultValue
the value to display for an invalid path
returns
the sub-configuration for the given path
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
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
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parseArgs(args: Seq[String], defaults: Config = ConfigFactory.defaultOverrides): Either[String, Config]

parses the string arguments as a configuration.
parses the string arguments as a configuration.
Any arguments in the form "-key=value" will override any other values.
The arguments otherwise are expected to be paths to configuration files, either on the classpath or as absolute paths.
Left-most configurations are used in preference over ones further to the right.
args
the arguments to parse
returns
Either a Left with an error message or a Right with an unresolved, parsed configuration
def parseArgsAndResolve(args: Seq[String], defaults: Config = ConfigFactory.defaultOverrides): Product with Serializable with Either[String, Config]

Convenience function to parses the arguments and return a resolved configuration
Convenience function to parses the arguments and return a resolved configuration
args
the user arguments to parse
defaults
the default fallback configuration
def parseUnresolved(args: Seq[String]): Either[String, Config]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Related Doc: package args4c

object Args4c

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def configAtPath(c: Config, path: String, defaultValue: String = "<invalid path>"): Config

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parseArgs(args: Seq[String], defaults: Config = ConfigFactory.defaultOverrides): Either[String, Config]

def parseArgsAndResolve(args: Seq[String], defaults: Config = ConfigFactory.defaultOverrides): Product with Serializable with Either[String, Config]

def parseUnresolved(args: Seq[String]): Either[String, Config]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped