Class

io.jobial.sclap.core

Command

Related Doc: package core

Permalink

case class Command(name: Option[String] = None, header: Option[String] = None, description: Option[String] = None, printOptionDefaultValues: Boolean = true, addDotToDescriptions: Boolean = true, help: Boolean = true, version: Option[String] = None, clusteredShortOptionsAllowed: Boolean = true, prefixLongOptionsWith: Option[String] = Some("--"), prefixShortOptionsWith: Option[String] = Some("-"), headerHeading: Option[String] = None, synopsisHeading: Option[String] = None, descriptionHeading: Option[String] = None, parameterListHeading: Option[String] = None, optionListHeading: Option[String] = None, commandListHeading: Option[String] = None, footerHeading: Option[String] = None, printStackTraceOnException: Boolean = false) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Command
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Command(name: Option[String] = None, header: Option[String] = None, description: Option[String] = None, printOptionDefaultValues: Boolean = true, addDotToDescriptions: Boolean = true, help: Boolean = true, version: Option[String] = None, clusteredShortOptionsAllowed: Boolean = true, prefixLongOptionsWith: Option[String] = Some("--"), prefixShortOptionsWith: Option[String] = Some("-"), headerHeading: Option[String] = None, synopsisHeading: Option[String] = None, descriptionHeading: Option[String] = None, parameterListHeading: Option[String] = None, optionListHeading: Option[String] = None, commandListHeading: Option[String] = None, footerHeading: Option[String] = None, printStackTraceOnException: Boolean = false)

    Permalink

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. val addDotToDescriptions: Boolean

    Permalink
  5. def apply[A](commandLine: CommandLine[A]): Free[CommandLineArgSpecA, IO[A]]

    Permalink
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @throws( ... )
  8. def clusteredShortOptionsAllowed(value: Boolean): Command

    Permalink
  9. val clusteredShortOptionsAllowed: Boolean

    Permalink
  10. def commandLine[A](commandLine: CommandLine[A]): Free[CommandLineArgSpecA, IO[A]]

    Permalink
  11. def commandListHeading(value: Option[String]): Command

    Permalink
  12. val commandListHeading: Option[String]

    Permalink
  13. def description(value: String): Command

    Permalink
  14. val description: Option[String]

    Permalink
  15. def descriptionHeading(value: Option[String]): Command

    Permalink
  16. val descriptionHeading: Option[String]

    Permalink
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def footerHeading(value: Option[String]): Command

    Permalink
  19. val footerHeading: Option[String]

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate()
  21. def header(value: String): Command

    Permalink
  22. val header: Option[String]

    Permalink
  23. def headerHeading(value: Option[String]): Command

    Permalink
  24. val headerHeading: Option[String]

    Permalink
  25. def help(value: Boolean): Command

    Permalink
  26. val help: Boolean

    Permalink
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def name(value: String): Command

    Permalink
  29. val name: Option[String]

    Permalink
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate()
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate()
  33. def optionListHeading(value: Option[String]): Command

    Permalink
  34. val optionListHeading: Option[String]

    Permalink
  35. def parameterListHeading(value: Option[String]): Command

    Permalink
  36. val parameterListHeading: Option[String]

    Permalink
  37. def prefixLongOptionsWith(value: Option[String]): Command

    Permalink
  38. val prefixLongOptionsWith: Option[String]

    Permalink
  39. def prefixShortOptionsWith(value: Option[String]): Command

    Permalink
  40. val prefixShortOptionsWith: Option[String]

    Permalink
  41. val printOptionDefaultValues: Boolean

    Permalink
  42. def printStackTraceOnException(value: Boolean): Command

    Permalink
  43. val printStackTraceOnException: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  45. def synopsisHeading(value: Option[String]): Command

    Permalink
  46. val synopsisHeading: Option[String]

    Permalink
  47. def version(value: String): Command

    Permalink
  48. val version: Option[String]

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped