args4c

ConfigApp

Related Doc: package args4c

object ConfigApp

Extends the ArgsAsConfigParser to also offer the usual suspects - 'help' and '-show=<path/to/config>'

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConfigApp
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class InvalidInput(args: Seq[String], err: String) extends UserInput with Product with Serializable

  2. case class ParsedConfig(unresolved: Config) extends UserInput with Product with Serializable

  3. case class ShowConfig(conf: Config) extends UserInput with Product with Serializable

  4. sealed trait UserInput extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Definition Classes
    AnyRef → Any
  4. object ShowHelp extends UserInput with Product with Serializable

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  6. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  16. def runMain[T](args: Seq[String])(f: (UserInput) ⇒ T): T

    Executes the function against the user input.

    Executes the function against the user input.

    If the user args contains 'help' or '-help', then 'ShowHelp' is returned

    If the user args contains '-show=<path>' where <path> is one of: $ empty or "all" then ShowConfig is passed to 'f' with the full configuration $ any other path.to.a.configuration.value then ShowConfig is passed to 'f' with the configuration at the given path

    Otherwise the function 'f' is called with ParsedConfig(Config)

    T

    the return type of the application

    args

    the command-line arguments to parse.

    f

    the main application which takes the Input and produces a type T

    returns

    the result of the function

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

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped