args

Type Members

1. case class AmbiguousNameException(name: String) extends ArgsException with Product with Serializable

   

2. case class Arg[X](name: Option[String], value: Option[X]) extends Ordered[Arg[X]] with Product with Serializable

   

   Case class to represent an "option" in a command line.

   Case class to represent an "option" in a command line. Such an option has an (optional) name which is a String; and an (optional) value, which is of type X.

   X

   the underlying type of the value.

   name

   the optional name.

   value

   the optional value.

3. case class Args[X](xas: Seq[Arg[X]]) extends Iterable[Arg[X]] with Product with Serializable

   

4. abstract class ArgsException extends Exception

   

5. case class CompareException(str: String) extends ArgsException with Product with Serializable

   

6. trait Derivable[T] extends AnyRef

   

   Type-class trait to allow conversion from type X to type T

   Type-class trait to allow conversion from type X to type T

   T

   the result type

7. trait Element extends Ordered[Element]

   

   This represents an element in the synopsis for a command line

8. case class Flag(value: String) extends Element with Product with Serializable

   

   This represents an "Option" in the parlance of POSIX command line interpretation (but formerly these options were known as flags)

   This represents an "Option" in the parlance of POSIX command line interpretation (but formerly these options were known as flags)

   value

   the (single-character) String representing the option (flag)

9. case class FlagWithValue(value: String, element: Element) extends Element with Product with Serializable

   

   This represents an "Option" and its "Value"

   This represents an "Option" and its "Value"

   value

   the flag or "option" String

   element

   the Element which corresponds to the "value" of this synopsis flag (and which may of course be OptionalElement).

10. case class InvalidOptionException[X](arg: Arg[X]) extends ArgsException with Product with Serializable

    

11. case class NoDerivationAvailable(xc: Class[_], yc: Class[_]) extends RuntimeException with Product with Serializable

    

12. case class NoOptionInSynopsisException(str: String) extends ArgsException with Product with Serializable

    

13. case class NoValueException(name: Option[String]) extends ArgsException with Product with Serializable

    

14. case class NotFoundException(command: String) extends ArgsException with Product with Serializable

    

15. case class Operand(value: String) extends Element with Product with Serializable

    

    This represents an operand in the parlance of POSIX.

    This represents an operand in the parlance of POSIX.

    value

    the String

16. case class OptionalElement(element: Element) extends Element with Product with Serializable

    

    This represents an optional synopsis element, either an optional flag, or an optional value.

    This represents an optional synopsis element, either an optional flag, or an optional value.

    element

    a synopsis element that is optional

17. case class ParseException(cause: String) extends ArgsException with Product with Serializable

    

18. class Parser extends RegexParsers

    

    Parser of POSIX-style command lines.

    Parser of POSIX-style command lines.

    TODO there is a problem with testing equality of Elements (it's too liberal)

19. trait PosixArg extends AnyRef

    

    a Posix Arg

20. case class PosixOperand(value: String) extends PosixArg with Product with Serializable

    

    The value of an operand, i.e.

    The value of an operand, i.e. a String which follows all of the options and their values.

    value

    a String

21. case class PosixOptionString(value: String) extends PosixArg with Product with Serializable

    

    One or more options.

    One or more options. Each option is a single-letter, although the terminating characters can be a value.

    value

    the string of options, without the "-" prefix.

22. case class PosixOptionValue(value: String) extends PosixArg with Product with Serializable

    

    The value of the preceding option.

    The value of the preceding option.

    value

    a String

23. class SimpleArgParser extends RegexParsers

    

    Parser of non-POSIX command lines

24. case class Synopsis(es: Seq[Element]) extends Product with Serializable

    

25. class SynopsisParser extends RegexParsers

    

26. case class ValidationException[X](a: Args[X], s: Synopsis) extends ArgsException with Product with Serializable

    

27. case class Value(value: String) extends Element with Product with Serializable

    

    This represents an Option Value in the parlance of POSIX.

    This represents an Option Value in the parlance of POSIX.

    value

    the String