Packages

final class Help[T] extends Product with Serializable

Provides usage and help messages related to T

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Help
  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 Help()
  2. new Help(args: Seq[Arg], appName: String, appVersion: String, progName: String, argsNameOption: Option[String])
  3. new Help(args: Seq[Arg], appName: String, appVersion: String, progName: String, argsNameOption: Option[String], optionsDesc: String, nameFormatter: Formatter[Name], helpMessage: Option[HelpMessage])

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. val appName: String
  5. val appVersion: String
  6. val args: Seq[Arg]
  7. val argsNameOption: Option[String]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def canEqual(obj: Any): Boolean
    Definition Classes
    Help → Equals
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def duplicates: Map[String, Seq[Arg]]
  12. def ensureNoDuplicates(): Unit
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(obj: Any): Boolean
    Definition Classes
    Help → Equals → AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    Help → AnyRef → Any
  18. def help(format: HelpFormat, showHidden: Boolean): String
  19. def help(format: HelpFormat): String
  20. def help: String

    Full multi-line help message for T.

    Full multi-line help message for T.

    Includes both usageMessage and optionsMessage

  21. val helpMessage: Option[HelpMessage]
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. val nameFormatter: Formatter[Name]
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def options: String

    Options description for T

  28. val optionsDesc: String
  29. def printHelp(b: StringBuilder, format: HelpFormat, showHidden: Boolean): Unit
  30. def printOptions(b: StringBuilder, format: HelpFormat, showHidden: Boolean): Unit
  31. def printUsage(b: StringBuilder, format: HelpFormat): Unit
  32. def productArity: Int
    Definition Classes
    Help → Product
  33. def productElement(n: Int): Any
    Definition Classes
    Help → Product
  34. def productIterator: Iterator[Any]
    Definition Classes
    Product
  35. def productPrefix: String
    Definition Classes
    Help → Product
  36. val progName: String
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    Help → AnyRef → Any
  39. def usage(format: HelpFormat): String
  40. def usage: String

    One-line usage message for T

  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  44. def withAppName(appName: String): Help[T]
  45. def withAppVersion(appVersion: String): Help[T]
  46. def withArgs(args: Seq[Arg]): Help[T]
  47. def withArgsNameOption(argsNameOption: Option[String]): Help[T]
  48. def withFullHelp: Help[WithFullHelp[T]]
  49. def withHelp: Help[WithHelp[T]]

    Add help and usage options.

  50. def withHelpMessage(helpMessage: Option[HelpMessage]): Help[T]
  51. def withNameFormatter(nameFormatter: Formatter[Name]): Help[T]
  52. def withOptionsDesc(optionsDesc: String): Help[T]
  53. def withProgName(progName: String): Help[T]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped