Class/Object

caseapp.core.argparser

ArgParser

Related Docs: object ArgParser | package argparser

Permalink

abstract class ArgParser[T] extends AnyRef

Parses argument values of type T.

Linear Supertypes
AnyRef, Any
Known Subclasses
AccumulatorArgParser, FlagAccumulatorArgParser, FlagArgParser, LastArgParser, SimpleArgParser
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ArgParser
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ArgParser()

    Permalink

Abstract Value Members

  1. abstract def apply(current: Option[T], value: String): Either[Error, T]

    Permalink

    Parses a value.

    Parses a value.

    value must be consumed. Corresponds to cases like --foo=bar.

    returns

    in case of success, a T, wrapped in scala.Right; else, and error message, wrapped in caseapp.core.Error and scala.Left

  2. abstract def description: String

    Permalink

    Value description.

    Value description.

    Used in help messages.

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. def apply(current: Option[T]): Either[Error, T]

    Permalink

    Called when the corresponding argument was specific with no value.

    Called when the corresponding argument was specific with no value.

    Can happen if the option was enabled as very last argument, like --bar in --foo 1 other --bar.

    returns

    a T wrapped in scala.Right in case of success, or an error message wrapped in caseapp.core.Error and scala.Left else

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. def isFlag: Boolean

    Permalink

    Whether the parsed value corresponds to a flag.

    Whether the parsed value corresponds to a flag.

    Prevents telling corresponding arguments expect a value in help messages.

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. def optional(current: Option[T], value: String): Either[Error, (Consumed, T)]

    Permalink

    Parses a value.

    Parses a value.

    Unlike apply above, value may or may not be consumed. Corresponds to cases like --foo bar.

    Use of value or not must be returned via the caseapp.core.argparser.Consumed value.

    returns

    in case of success, whether value was consumed and a T, wrapped in scala.Right; else, and error message, wrapped in caseapp.core.Error and scala.Left

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

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped