Class

com.fulcrumgenomics.sopt.Sopt

Arg

Related Doc: package Sopt

Permalink

case class Arg(name: String, group: Option[String], flag: Option[Char], kind: String, minValues: Int, maxValues: Int, defaultValues: Seq[String], sensitive: Boolean, description: String) extends MarkDownDescription with Product with Serializable

Represents information about an argument to a command line program.

name

the name of the argument as presented on the command line

group

the (optional) name of the group in which the argument exists

flag

the optional flag character for the argument if it has one

kind

the name of the type of the argument (for collection arguments, the type in the collection)

minValues

the minimum number of values that must be specified

maxValues

the maximum number of values that may be specified

defaultValues

the seq of default values, as strings

sensitive

if true the argument is sensitive and values should not be re-displayed

description

the description of the argument

Linear Supertypes
Serializable, Serializable, Product, Equals, MarkDownDescription, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Arg
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MarkDownDescription
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Arg(name: String, group: Option[String], flag: Option[Char], kind: String, minValues: Int, maxValues: Int, defaultValues: Seq[String], sensitive: Boolean, description: String)

    Permalink

    name

    the name of the argument as presented on the command line

    group

    the (optional) name of the group in which the argument exists

    flag

    the optional flag character for the argument if it has one

    kind

    the name of the type of the argument (for collection arguments, the type in the collection)

    minValues

    the minimum number of values that must be specified

    maxValues

    the maximum number of values that may be specified

    defaultValues

    the seq of default values, as strings

    sensitive

    if true the argument is sensitive and values should not be re-displayed

    description

    the description of the argument

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to any2stringadd[Arg] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Arg, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to ArrowAssoc[Arg] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

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

  8. val defaultValues: Seq[String]

    Permalink

    the seq of default values, as strings

  9. val description: String

    Permalink

    the description of the argument

    the description of the argument

    Definition Classes
    Arg → MarkDownDescription

  10. def descriptionAsHtml: String

    Permalink

    Returns the description as HTML.

    Returns the description as HTML.

    Definition Classes
    MarkDownDescription

  11. def descriptionAsText: String

    Permalink

    Returns the description as plain text, line-wrapped to TerminalWidth.

    Returns the description as plain text, line-wrapped to TerminalWidth.

    Definition Classes
    MarkDownDescription

  12. def ensuring(cond: (Arg) ⇒ Boolean, msg: ⇒ Any): Arg

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to Ensuring[Arg] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: (Arg) ⇒ Boolean): Arg

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to Ensuring[Arg] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean, msg: ⇒ Any): Arg

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to Ensuring[Arg] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean): Arg

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to Ensuring[Arg] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  17. def finalize(): Unit

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

  18. val flag: Option[Char]

    Permalink

    the optional flag character for the argument if it has one

  19. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to StringFormat[Arg] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  21. val group: Option[String]

    Permalink

    the (optional) name of the group in which the argument exists

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. val kind: String

    Permalink

    the name of the type of the argument (for collection arguments, the type in the collection)

  24. val maxValues: Int

    Permalink

    the maximum number of values that may be specified

  25. val minValues: Int

    Permalink

    the minimum number of values that must be specified

  26. val name: String

    Permalink

    the name of the argument as presented on the command line

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

    Permalink
    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. val sensitive: Boolean

    Permalink

    if true the argument is sensitive and values should not be re-displayed

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

    Permalink
    Definition Classes
    AnyRef

  32. final def wait(): Unit

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

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

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

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

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

  35. def →[B](y: B): (Arg, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Arg to ArrowAssoc[Arg] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from MarkDownDescription

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Arg to any2stringadd[Arg]

Inherited by implicit conversion StringFormat from Arg to StringFormat[Arg]

Inherited by implicit conversion Ensuring from Arg to Ensuring[Arg]

Inherited by implicit conversion ArrowAssoc from Arg to ArrowAssoc[Arg]

Ungrouped