trait Api extends TypesApi with ParsersApi with ReadersApi with VersionSpecificApi

Linear Supertypes
VersionSpecificApi, ReadersApi, LowPrioReaders, ParsersApi, TypesApi, AnyRef, Any
Known Subclasses
default
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Api
  2. VersionSpecificApi
  3. ReadersApi
  4. LowPrioReaders
  5. ParsersApi
  6. TypesApi
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class ArgumentParser extends AnyRef

    A simple command line argument parser.

    A simple command line argument parser.

    Usage:

    1. Define parameters with param, requiredParam and repeatedParam. Each of these methods gives back a handle to a future argument value.

    2. Call parseOrExit() with actual arguments.

    3. If parsing succeeds, the arguments will be available in the handles defined in step 1.

    If parsing fails, error descriptions are printed and the program exits with 2.

    Example:

    scala val parser = argparse.default.ArgumentParser()

    val p1 = parser.param[String]("--this-is-a-named-param", default = "default value") val p2 = parser.param[Int]("positional-param", default = 2)

    parser.parseOrExit(Seq("--this-is-a-named-param=other", 5)) println(p1.value) println(p2.value)

    Definition Classes
    ParsersApi
  2. trait FsPathReader[A] extends (ReadersApi.this)#Reader[A]
    Definition Classes
    ReadersApi
  3. trait Reader[A] extends AnyRef

    A typeclass that defines how to convert a string from a single command line argument to a given type.

    A typeclass that defines how to convert a string from a single command line argument to a given type.

    Definition Classes
    TypesApi
    Annotations
    @implicitNotFound()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit def CollectionReader[Elem, Col[Elem] <: Iterable[Elem]](implicit elementReader: Reader[Elem], factory: Factory[Elem, Col[Elem]]): Reader[Col[Elem]]
    Definition Classes
    LowPrioReaders
  5. implicit def FilePathCollectionReader[Col <: Iterable[FilePath]](implicit factory: Factory[FilePath, Col], pathReader: Reader[FilePath]): Reader[Col]
    Definition Classes
    ReadersApi
  6. implicit def IntegralReader[N](implicit numeric: Integral[N]): Reader[N]
    Definition Classes
    ReadersApi
  7. implicit def JFileCollectionReader[Col <: Iterable[File]](implicit factory: Factory[File, Col], pathReader: Reader[File]): Reader[Col]
    Definition Classes
    ReadersApi
  8. implicit def JPathCollectionReader[Col <: Iterable[Path]](implicit factory: Factory[Path, Col], pathReader: Reader[Path]): Reader[Col]
    Definition Classes
    ReadersApi
  9. implicit def Mapping[K, V](implicit kr: Reader[K], vr: Reader[V]): Reader[(K, V)]
    Definition Classes
    ReadersApi
  10. implicit def OptionReader[A](implicit elementReader: Reader[A]): Reader[Option[A]]
    Definition Classes
    ReadersApi
  11. implicit def PathCollectionReader[Col <: Iterable[Path]](implicit factory: Factory[Path, Col], pathReader: Reader[Path]): Reader[Col]
    Definition Classes
    ReadersApi
  12. implicit def RelPathCollectionReader[Col <: Iterable[RelPath]](implicit factory: Factory[RelPath, Col], pathReader: Reader[RelPath]): Reader[Col]
    Definition Classes
    ReadersApi
  13. implicit val StringReader: Reader[String]
    Definition Classes
    TypesApi
  14. implicit def SubPathCollectionReader[Col <: Iterable[SubPath]](implicit factory: Factory[SubPath, Col], pathReader: Reader[SubPath]): Reader[Col]
    Definition Classes
    ReadersApi
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  17. def defaultBashCompletionFlags: Seq[String]

    The name of the flag to use for generating standalone bash-completion.

    The name of the flag to use for generating standalone bash-completion.

    Set this to empty to disable bash-completion entirely.

    Note that individual argument parsers may override this.

    Definition Classes
    ParsersApi
  18. def defaultHelpFlags: Seq[String]

    The name of the flag to use for printing help messages.

    The name of the flag to use for printing help messages.

    Set this to empty to disable help entirely.

    Note that individual argument parsers may override this.

    Definition Classes
    ParsersApi
  19. def defaultHelpMessage(parser: ArgumentParser): String

    Generate a help message from parameters.

    Generate a help message from parameters.

    This message will be used by ArgumentParsers. Overriding this allows you to customize the help message of all ArgumentParsers.

    Definition Classes
    ParsersApi
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def exit(code: Int): Nothing

    Called by parseOrExit in case of error.

    Called by parseOrExit in case of error.

    Overriding this can be useful in situations where you do not want to exit, for example in tests.

    Attributes
    protected
    Definition Classes
    ParsersApi
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. val pathCompleter: (String) => Seq[String]
    Definition Classes
    ReadersApi
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. object ArgumentParser
    Definition Classes
    ParsersApi
  37. implicit object BooleanReader extends (ReadersApi.this)#Reader[Boolean]
    Definition Classes
    ReadersApi
  38. implicit object DoubleReader extends (ReadersApi.this)#Reader[Double]
    Definition Classes
    ReadersApi
  39. implicit object DurationReader extends (ReadersApi.this)#Reader[Duration]
    Definition Classes
    ReadersApi
  40. implicit object FilePathReader extends (ReadersApi.this)#FsPathReader[FilePath]
    Definition Classes
    ReadersApi
  41. implicit object FiniteDurationReader extends (ReadersApi.this)#Reader[FiniteDuration]
    Definition Classes
    ReadersApi
  42. implicit object FloatReader extends (ReadersApi.this)#Reader[Float]
    Definition Classes
    ReadersApi
  43. implicit object InputStreamReader extends (ReadersApi.this)#Reader[() => InputStream]
    Definition Classes
    ReadersApi
  44. implicit object InstantReader extends (ReadersApi.this)#Reader[Instant]
    Definition Classes
    ReadersApi
  45. implicit object JavaFileReader extends (ReadersApi.this)#FsPathReader[File]
    Definition Classes
    ReadersApi
  46. implicit object JavaPathReader extends (ReadersApi.this)#FsPathReader[Path]
    Definition Classes
    ReadersApi
  47. implicit object LocalDateReader extends (ReadersApi.this)#Reader[LocalDate]
    Definition Classes
    ReadersApi
  48. implicit object LocalDateTimeReader extends (ReadersApi.this)#Reader[LocalDateTime]
    Definition Classes
    ReadersApi
  49. implicit object LocalTime extends (ReadersApi.this)#Reader[LocalTime]
    Definition Classes
    ReadersApi
  50. implicit object OutputStreamReader extends (ReadersApi.this)#Reader[() => OutputStream]
    Definition Classes
    ReadersApi
  51. implicit object PathReader extends (ReadersApi.this)#FsPathReader[Path]
    Definition Classes
    ReadersApi
  52. implicit object RangeReader extends (ReadersApi.this)#Reader[Range]
    Definition Classes
    ReadersApi
  53. implicit object ReadableReader extends (ReadersApi.this)#Reader[Readable]
    Definition Classes
    ReadersApi
  54. implicit object RelPathReader extends (ReadersApi.this)#FsPathReader[RelPath]
    Definition Classes
    ReadersApi
  55. implicit object SubPathReader extends (ReadersApi.this)#FsPathReader[SubPath]
    Definition Classes
    ReadersApi
  56. implicit object ZonedDateTimeReader extends (ReadersApi.this)#Reader[ZonedDateTime]
    Definition Classes
    ReadersApi
  57. object Reader
    Definition Classes
    TypesApi

Inherited from VersionSpecificApi

Inherited from ReadersApi

Inherited from LowPrioReaders

Inherited from ParsersApi

Inherited from TypesApi

Inherited from AnyRef

Inherited from Any

Ungrouped