Args

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. def addValidation(f: ⇒ Unit): Unit

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. def getArgs(argPrefix: String): Traversable[ArgAssignable]

11. final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

12. def getDefaultArgs: Traversable[ArgAssignable]

    Returns the "default" values for the arguments of this class.

    Returns the "default" values for the arguments of this class. Unrelated to the current value of those arguments. Unless overridden, "default" means whatever values are assigned by the no-arg constructor of this class.

    returns

13. def getStringValues: Map[String, String]

    get back the current (name, value) of all arguments as strings.

    get back the current (name, value) of all arguments as strings. This does not just return the original arguments that were passed to this function -- they may have been changed from defaulting, validation, etc.

    In general, users will not need this function, but it is useful for tools built on top, eg. saving to a property file

14. def hashCode(): Int

    Definition Classes

    AnyRef → Any

15. def helpMessage: String

16. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

17. final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

18. final def notify(): Unit

    Definition Classes

    AnyRef

19. final def notifyAll(): Unit

    Definition Classes

    AnyRef

20. def parse(kvPairs: Map[String, String], validation: Boolean = true): Unit

21. def parse(args: Array[String]): Unit

22. def parse(commandLineArgs: String): Unit

23. lazy val parser: ArgumentParser[ArgAssignable]

24. def readArgs(originalArgs: Map[String, String]): Map[String, String]

    Read config from an external source, and use that to modify the set of arguments.

    Read config from an external source, and use that to modify the set of arguments. The "original" arguments are given as an argument to this function, so that this method can base its behavior on those arguments. (Eg., it can take a filename from those args.) It should return the complete set of args that should be used. It is free to choose to completely replace the original args, append to them, modify them, etc.

    in general, implementations should be abstract override with a call to super, to allow multiple external configs via the Stackable Trait Pattern

    Definition Classes

    Args → ExternalConfig

25. def registerParser[T](parser: Parser[T]): Unit

    add the ability to parse your own custom types.

    add the ability to parse your own custom types. Note that this registers the parser *globally*, not just for this object.

26. def runValidation(): Unit

    run all validation functions.

    run all validation functions.

    Note that parse automatically runs all validation, so in general a user will not need to call this. However, if you are programatically filling in the the args of this object, you probably want to call this.

27. def saveConfig(): Unit

    save the config back to the external source.

    save the config back to the external source. Any parameters for this method should have already been extracted from the call to readArgs

    as with readArgs, this should in general be implemented as an abstract override with a call to super

    Definition Classes

    Args → ExternalConfig

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

    Definition Classes

    AnyRef

29. def toString(): String

    Definition Classes

    AnyRef → Any

30. var validationFunctions: Seq[() ⇒ Unit]

31. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33. final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )