com.frugalmechanic.optparse

ArgOpt

abstract class ArgOpt[T] extends OptVal[T]

Base type for command line options that take an argument

For implementation examples see:

Linear Supertypes
OptVal[T], Opt, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ArgOpt
  2. OptVal
  3. Opt
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ArgOpt(_long: Option[String], _short: Option[Char], _default: Option[T], _desc: String, _enables: ⇒ Seq[BoolOpt], _disables: ⇒ Seq[BoolOpt], _invalidWith: ⇒ Seq[Opt], _validWith: ⇒ Seq[Opt], _exclusive: Boolean, _validate: (T) ⇒ Boolean)

Type Members

  1. abstract type Elem

    An invididual element (usually just T)

Abstract Value Members

  1. abstract def parseValue(value: String): Elem

    Specifies how to parse the string from the command line argument into a value of type T

  2. abstract def setValue(arg: String): Unit

    Set the value (sending it through parseValue())

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. var actualLong: Option[String]

    Attributes
    protected[com.frugalmechanic.optparse]
    Definition Classes
    Opt
  7. var actualShort: Option[Char]

    Attributes
    protected[com.frugalmechanic.optparse]
    Definition Classes
    Opt
  8. def apply(): T

    Get the value

    Get the value

    This calls Option.get on the underlying value so an exception will be thrown if the value is not set.

    Definition Classes
    OptVal
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. def default: Option[T]

    The default value for this options

    The default value for this options

    Definition Classes
    OptVal
  12. def desc: String

    The description of this option which is used as part of the help message

    The description of this option which is used as part of the help message

    Definition Classes
    Opt
  13. def disables: Seq[BoolOpt]

    A list of boolean option that this option disables

    A list of boolean option that this option disables

    Definition Classes
    Opt
  14. def enables: Seq[BoolOpt]

    A List of boolean options that this option enables

    A List of boolean options that this option enables

    Definition Classes
    Opt
  15. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  17. def exclusive: Boolean

    Whether or not this command line options is exclusive and cannot be used with any other options (e.

    Whether or not this command line options is exclusive and cannot be used with any other options (e.g. a help options that prints the help message and then quits)

    Definition Classes
    Opt
  18. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  21. def invalidWith: Seq[Opt]

    Other command line options that this option is invalid with

    Other command line options that this option is invalid with

    Definition Classes
    Opt
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. def long: Option[String]

    The long form of this option (if any)

    The long form of this option (if any)

    (e.g. "myoption" would be called with "--myoption" on the command line)

    Definition Classes
    Opt
  24. var methodName: String

    Attributes
    protected[com.frugalmechanic.optparse]
    Definition Classes
    Opt
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  28. def reset: Unit

    Reset the value to the default

    Reset the value to the default

    Definition Classes
    OptValOpt
  29. def short: Option[Char]

    The short form of this option (if any)

    The short form of this option (if any)

    (e.g. "a" would be called with "-a" on the command line)

    Definition Classes
    Opt
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. def toString(): String

    Definition Classes
    AnyRef → Any
  32. def validWith: Seq[Opt]

    Other command line options that are required when this option is set

    Other command line options that are required when this option is set

    Definition Classes
    Opt
  33. def validate(value: T): Boolean

    Validate the parsed value using the validate argument passed in on the constructor

  34. def value: Option[T]

    The value attached to this command line option (wrapped in an Option)

    The value attached to this command line option (wrapped in an Option)

    Definition Classes
    OptVal
  35. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from OptVal[T]

Inherited from Opt

Inherited from AnyRef

Inherited from Any

Ungrouped