caseapp.core.argparser

FlagArgParser

final case class FlagArgParser[T](description: String, parse: (Option[String]) ⇒ Either[Error, T]) extends ArgParser[T] with Product with Serializable

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FlagArgParser
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ArgParser
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FlagArgParser(description: String, parse: (Option[String]) ⇒ Either[Error, T])

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

    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

    Definition Classes
    FlagArgParserArgParser
  7. def apply(current: Option[T], value: String): Either[Error, T]

    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

    Definition Classes
    FlagArgParserArgParser
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val description: String

    Value description.

    Value description.

    Used in help messages.

    Definition Classes
    FlagArgParserArgParser
  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  14. def isFlag: Boolean

    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.

    Definition Classes
    FlagArgParserArgParser
  15. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  19. def optional(current: Option[T], value: String): Either[Error, (Consumed, T)]

    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

    Definition Classes
    FlagArgParserArgParser
  20. val parse: (Option[String]) ⇒ Either[Error, T]

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

    Definition Classes
    AnyRef
  22. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ArgParser[T]

Inherited from AnyRef

Inherited from Any

Ungrouped