Class

com.fulcrumgenomics.sopt.Sopt

ClpMetadata

Related Doc: package Sopt

Permalink

case class ClpMetadata(name: String, group: Group, hidden: Boolean, description: String, args: Seq[Arg]) extends MarkDownDescription with Product with Serializable

Represents the metadata about a command line program that may be consumed externally to generate documentation etc.

name

the name of the program / command

group

the clp group name of the program

hidden

whether or not the program is marked as hidden

description

the description/documentation for the program in MarkDown format

args

the ordered Seq of arguments the program takes

Linear Supertypes
Serializable, Serializable, Product, Equals, MarkDownDescription, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClpMetadata
  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 ClpMetadata(name: String, group: Group, hidden: Boolean, description: String, args: Seq[Arg])

    Permalink

    name

    the name of the program / command

    group

    the clp group name of the program

    hidden

    whether or not the program is marked as hidden

    description

    the description/documentation for the program in MarkDown format

    args

    the ordered Seq of arguments the program takes

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 ClpMetadata to any2stringadd[ClpMetadata] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. val args: Seq[Arg]

    Permalink

    the ordered Seq of arguments the program takes

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

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

  9. val description: String

    Permalink

    the description/documentation for the program in MarkDown format

    the description/documentation for the program in MarkDown format

    Definition Classes
    ClpMetadata → 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: (ClpMetadata) ⇒ Boolean, msg: ⇒ Any): ClpMetadata

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

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

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

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

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

  15. def ensuring(cond: Boolean): ClpMetadata

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClpMetadata to Ensuring[ClpMetadata] 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. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. val group: Group

    Permalink

    the clp group name of the program

  21. val hidden: Boolean

    Permalink

    whether or not the program is marked as hidden

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. val name: String

    Permalink

    the name of the program / command

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

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  28. final def wait(): Unit

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

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

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

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

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

  31. def →[B](y: B): (ClpMetadata, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClpMetadata to ArrowAssoc[ClpMetadata] 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 ClpMetadata to any2stringadd[ClpMetadata]

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

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

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

Ungrouped