Class

com.frugalmechanic.optparse

ArgOpt

Related Doc: package optparse

Permalink

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
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)

    Permalink

Type Members

  1. abstract type Elem

    Permalink

    An invididual element (usually just T)

Abstract Value Members

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

    Permalink

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

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

    Permalink

    Set the value (sending it through parseValue())

Concrete Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. var actualLong: Option[String]

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

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

    Permalink

    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
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

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

    Permalink

    The default value for this options

    The default value for this options

    Definition Classes
    OptVal
  10. def desc: String

    Permalink

    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
  11. def disables: Seq[BoolOpt]

    Permalink

    A list of boolean option that this option disables

    A list of boolean option that this option disables

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

    Permalink

    A List of boolean options that this option enables

    A List of boolean options that this option enables

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. def exclusive: Boolean

    Permalink

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

    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
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  18. def invalidWith: Seq[Opt]

    Permalink

    Other command line options that this option is invalid with

    Other command line options that this option is invalid with

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

    Permalink
    Definition Classes
    Any
  20. def long: Option[String]

    Permalink

    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
  21. var methodName: String

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

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  25. def reset(): Unit

    Permalink

    Reset the value to the default

    Reset the value to the default

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

    Permalink

    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
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

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

    Permalink

    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
  30. def validate(value: T): Boolean

    Permalink

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

  31. def value: Option[T]

    Permalink

    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
  32. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from OptVal[T]

Inherited from Opt

Inherited from AnyRef

Inherited from Any

Ungrouped