Trait

dagr.sopt.cmdline

CommandLineParserStrings

Related Doc: package cmdline

Permalink

trait CommandLineParserStrings extends AnyRef

Various constants and methods for formatting and printing usages and error messages on the command line

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CommandLineParserStrings
  2. AnyRef
  3. 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

Abstract Value Members

  1. abstract def commandLineName: String

    Permalink

    The command line name.

Concrete 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 CommandLineParserStrings to any2stringadd[CommandLineParserStrings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (CommandLineParserStrings, B)

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

    Permalink

    Error messages

  7. val HelpSimilarityFloor: Int

    Permalink

    Similarity floor for when searching for similar sub-command names.

    Similarity floor for when searching for similar sub-command names. *

  8. val MaximumLineLength: Int

    Permalink

    The maximum line lengths for tool descriptions

  9. val MinimumSubstringLength: Int

    Permalink
  10. val MissingSubCommand: String

    Permalink
  11. val OptionalArguments: String

    Permalink
  12. val RequiredArguments: String

    Permalink
  13. val SeparatorLine: String

    Permalink

    Section separator

  14. val SubCommandGroupDescriptionColumnLength: Int

    Permalink
  15. val SubCommandGroupNameColumnLength: Int

    Permalink

    Lengths for names and descriptions on the command line

  16. val SubCommandNameColumnLength: Int

    Permalink
  17. val UsagePrefix: String

    Permalink

    Section headers

  18. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def ensuring(cond: (CommandLineParserStrings) ⇒ Boolean, msg: ⇒ Any): CommandLineParserStrings

    Permalink
    Implicit information
    This member is added by an implicit conversion from CommandLineParserStrings to Ensuring[CommandLineParserStrings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (CommandLineParserStrings) ⇒ Boolean): CommandLineParserStrings

    Permalink
    Implicit information
    This member is added by an implicit conversion from CommandLineParserStrings to Ensuring[CommandLineParserStrings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: ⇒ Any): CommandLineParserStrings

    Permalink
    Implicit information
    This member is added by an implicit conversion from CommandLineParserStrings to Ensuring[CommandLineParserStrings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): CommandLineParserStrings

    Permalink
    Implicit information
    This member is added by an implicit conversion from CommandLineParserStrings to Ensuring[CommandLineParserStrings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  26. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. def formatShortDescription(description: String): String

    Permalink

    Formats the short description of a tool when printing out the list of sub-commands in the usage.

    Formats the short description of a tool when printing out the list of sub-commands in the usage.

    (1) find the first period (".") and keep only everything before it (2) shorten it to the maximum line length adding "..." to the end.

  28. def formatted(fmtstr: String): String

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

    Permalink

    The name of "command" on the command line

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

    Permalink
    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef
  35. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. def standardCommandAndSubCommandUsagePreamble(commandClazz: Option[Class[_]] = None, subCommandClazz: Option[Class[_]] = None): String

    Permalink

    A typical command line program will call this to get the beginning of the usage message, and then append a description of the program.

  37. def standardSubCommandUsagePreamble(clazz: Option[Class[_]] = None): String

    Permalink

    A typical command line program will call this to get the beginning of the usage message, and then append a description of the program.

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

    Permalink
    Definition Classes
    AnyRef
  39. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def [B](y: B): (CommandLineParserStrings, B)

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped