Arg

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. def <(that: Arg[X]): Boolean

   

   Definition Classes

   Ordered

4. def <=(that: Arg[X]): Boolean

   

   Definition Classes

   Ordered

5. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

6. def >(that: Arg[X]): Boolean

   

   Definition Classes

   Ordered

7. def >=(that: Arg[X]): Boolean

   

   Definition Classes

   Ordered

8. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

9. def asOption: Option[(String, Option[X])]

   

   Method to return this Arg as an optional tuple of a String and an optional X value, according to whether it's an "option".

   Method to return this Arg as an optional tuple of a String and an optional X value, according to whether it's an "option".

   returns

   Some[(String, Option[X]) if name is not None otherwise None.

10. def byName(w: String): Option[Arg[X]]

    

    Method to get this Arg, if and only if its name matches the given String (w)

    Method to get this Arg, if and only if its name matches the given String (w)

    w

    the string to match.

    returns

    either Some(this) or else None.

11. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

12. def compare(that: Arg[X]): Int

    

    Method to compare this Arg with that.

    Method to compare this Arg with that.

    TEST this method.

    that

    the Arg to compare with.

    returns

    the result of invoking x compare y where x and y are the values of this and that Args.

    Definition Classes

    Arg → Ordered

13. def compareTo(that: Arg[X]): Int

    

    Definition Classes

    Ordered → Comparable

14. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

15. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

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

    

    Definition Classes

    AnyRef → Any

17. def hasValue: Boolean

    

    Method to determine if this Arg has a value, thus either an option with value, or an operand.

    Method to determine if this Arg has a value, thus either an option with value, or an operand.

    returns

    true if value is not None

18. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

19. def isOption: Boolean

    

    Method to determine if this Arg is an option (also known as a "flag"), as opposed to an operand.

    Method to determine if this Arg is an option (also known as a "flag"), as opposed to an operand.

    returns

    true if name is not None

20. def isOptional(s: Synopsis): Maybe

    

    Method to determine if this Arg is optional according to the synopsis provided.

    Method to determine if this Arg is optional according to the synopsis provided.

    s

    the synopsis.

    returns

    Kleenean(true if this Arg is optional.

21. def map[Y](f: (X) ⇒ Y): Arg[Y]

    

    Method to map this Arg into an Arg of underlying type Y

    Method to map this Arg into an Arg of underlying type Y

    Y

    the underlying type of the result.

    f

    a function to convert an X into a Y.

    returns

    an Arg[Y]

22. val name: Option[String]

    

    the optional name.

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

    

    Definition Classes

    AnyRef

24. final def notify(): Unit

    

    Definition Classes

    AnyRef

25. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

26. def operand: Option[X]

    

    Method to return this Arg as an optional X value, according to whether it's an "operand".

    Method to return this Arg as an optional X value, according to whether it's an "operand".

    returns

    Some[X] if name is None otherwise None.

27. def process(fm: Map[String, (Option[X]) ⇒ Unit]): Try[Option[X]]

    

    Method to process this Arg, given a map of options and their corresponding functions.

    Method to process this Arg, given a map of options and their corresponding functions.

    fm

    a Map of String->function where function is of type Option[X]=>Unit

    returns

    a Success[None] if there was a function defined for this Arg in the map fm AND if the function invocation was successful; otherwise a Failure[X]

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

    

    Definition Classes

    AnyRef

29. def toString(): String

    

    Method to form a String from this Arg

    Method to form a String from this Arg

    returns

    "Arg: flag name/anonymous with value: value/none"

    Definition Classes

    Arg → AnyRef → Any

30. def toY[Y](implicit arg0: Derivable[Y]): Try[Y]

    

    Method to get the value of this Arg as a Y.

    Method to get the value of this Arg as a Y.

    Y

    the type of the result.

    returns

    the result of deriving a Y value from the actual value of this Arg, wrapped in Try.

31. val value: Option[X]

    

    the optional value.

32. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )