ScallopConf

Value Members

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

   Definition Classes

   AnyRef

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

   Definition Classes

   Any

3. final def ##(): Int

   Definition Classes

   AnyRef → Any

4. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

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

   Definition Classes

   Any

6. final def afterInit(): Unit

   Definition Classes

   ScallopConf → AfterInit

7. val args: Seq[String]

8. final def asInstanceOf[T0]: T0

   Definition Classes

   Any

9. def assertVerified: Unit

   Checks that this Conf object is verified.

   Checks that this Conf object is verified. If it is not, throws an exception.

10. def banner(b: String): Unit

    Add a banner string to option builder.

    Add a banner string to option builder.

    b

    Banner string.

11. var builder: Scallop

12. def clone(): AnyRef

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws()

13. def codependent(list: org.rogach.scallop.ScallopOption[_]*): Unit

    In the verify stage, checks that either all or none of the provided options have values supplied in arguments.

    In the verify stage, checks that either all or none of the provided options have values supplied in arguments.

    list

    list of codependent options

14. val commandname: String

    Attributes

    protected

15. def conflicts(opt: org.rogach.scallop.ScallopOption[_], list: List[org.rogach.scallop.ScallopOption[_]]): Unit

    In the verify stage, if opt was supplied, checks that all of the options in list are not supplied.

    In the verify stage, if opt was supplied, checks that all of the options in list are not supplied.

    opt

    option, that conflicts with all of options in list

    list

    list of dependencies (all will need to be absent)

16. final def delayedInit(x: ⇒ Unit): Unit

    Definition Classes

    AfterInit → DelayedInit

17. def dependsOnAll(opt: org.rogach.scallop.ScallopOption[_], list: List[org.rogach.scallop.ScallopOption[_]]): Unit

    In the verify stage, if opt was supplied, checks that all of the options in list are also supplied.

    In the verify stage, if opt was supplied, checks that all of the options in list are also supplied.

    opt

    option, that depends on all of options in list

    list

    list of dependencies (all will need to be present)

18. def dependsOnAny(opt: org.rogach.scallop.ScallopOption[_], list: List[org.rogach.scallop.ScallopOption[_]]): Unit

    In the verify stage, if opt was supplied, checks that at least one of the options in list are also supplied.

    In the verify stage, if opt was supplied, checks that at least one of the options in list are also supplied.

    opt

    option, that depends on any of options in list

    list

    list of dependencies (at least one will need to be present)

19. def editBuilder(fn: (Scallop) ⇒ Scallop): Unit

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

    Definition Classes

    AnyRef

21. def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

22. var errorMessageHandler: (String) ⇒ Unit

    This function is called with the error message when ScallopException occurs.

    This function is called with the error message when ScallopException occurs. By default, this function prints message (prefixed by *printedName*) to stdout, coloring the output if possible, then calls sys.exit(1).

    Update this variable with another function if you need to change that behavior.

23. def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws()

24. def footer(f: String): Unit

    Add a footer string to this builder.

    Add a footer string to this builder.

    f

    footer string.

25. final def getClass(): java.lang.Class[_]

    Definition Classes

    AnyRef → Any

26. def getName(name: String): String

27. def guessOptionName: Boolean

    If true, scallop would try to guess missing option names from the names of their fields.

28. def guessOptionName_=(v: Boolean): Unit

    If set to true, scallop would try to guess missing option names from the names of their fields.

29. def hashCode(): Int

    Definition Classes

    AnyRef → Any

30. def helpWidth(w: Int): Unit

    Explicitly set width of help printout.

    Explicitly set width of help printout. By default, Scallop tries to determine it from terminal width or defaults to 80 characters.

31. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

32. def mainOptions: Seq[String]

    Options, that are to be printed first in the help printout

33. def mainOptions_=(newMainOptions: ⇒ Seq[org.rogach.scallop.ScallopOption[_]]): Unit

    Set options, that are to be printed first in the help printout

34. def mutuallyExclusive(list: org.rogach.scallop.ScallopOption[_]*): Unit

    In the verify stage, checks that only one or zero of the provided options have values supplied in arguments.

    In the verify stage, checks that only one or zero of the provided options have values supplied in arguments.

    list

    list of mutually exclusive options

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

    Definition Classes

    AnyRef

36. final def notify(): Unit

    Definition Classes

    AnyRef

37. final def notifyAll(): Unit

    Definition Classes

    AnyRef

38. def onError(e: Throwable): Unit

    This function is called in event of any exception in arguments parsing.

    This function is called in event of any exception in arguments parsing. By default, it catches only standard Scallop errors, letting all other pass through.

    Attributes

    protected

39. def opt[A](name: String, short: Char, descr: String, default: ⇒ Option[A], validate: (A) ⇒ Boolean, required: Boolean, argName: String, hidden: Boolean, noshort: Boolean)(implicit conv: ValueConverter[A]): ScallopOption[A]

    Add a new option definition to this config and get a holder for the value.

    Add a new option definition to this config and get a holder for the value.

    name

    Name for new option, used as long option name in parsing, and for option identification.

    short

    Overload the char that will be used as short option name. Defaults to first character of the name.

    descr

    Description for this option, for help description.

    default

    Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).

    required

    Is this option required? Defaults to false.

    argName

    The name for this option argument, as it will appear in help. Defaults to "arg".

    noshort

    If set to true, then this option does not have any short name.

    conv

    The converter for this option. Usually found implicitly.

    returns

    A holder for parsed value

40. def printHelp(): Unit

    Prints help message (with version, banner, option usage and footer) to stdout.

41. var printedName: String

    This name would be included in output when reporting errors.

42. def props[A](name: Char = 'D', descr: String = "", keyName: String = "key", valueName: String = "value", hidden: Boolean = false)(implicit conv: ValueConverter[Map[String, A]]): Map[String, A]

    Add new property option definition to this config object, and get a handle for option retreiving.

    Add new property option definition to this config object, and get a handle for option retreiving.

    name

    Char, that will be used as prefix for property arguments.

    descr

    Description for this property option, for help description.

    keyName

    Name for 'key' part of this option arg name, as it will appear in help option definition. Defaults to "key".

    valueName

    Name for 'value' part of this option arg name, as it will appear in help option definition. Defaults to "value".

    returns

    A holder for retreival of the values.

43. def propsLong[A](name: String = "Props", descr: String = "", keyName: String = "key", valueName: String = "value", hidden: Boolean = false)(implicit conv: ValueConverter[Map[String, A]]): Map[String, A]

44. def requireOne(list: org.rogach.scallop.ScallopOption[_]*): Unit

    In the verify stage, checks that one, and only one, option in the list is supplied.

    In the verify stage, checks that one, and only one, option in the list is supplied.

    list

    list of conflicting options (exactly one must be present)

45. val rootConfig: ScallopConf

46. def shortSubcommandsHelp(v: Boolean = true): Unit

47. def subcommand: Option[ScallopConf]

    Retrieves the choosen subcommand.

48. def subcommands: List[ScallopConf]

    Retrieves the list of the chosen nested subcommands.

49. var subconfigs: List[ScallopConf]

    List of sub-configs of this config.

50. def summary: String

    Get summary of current parser state.

    Get summary of current parser state.

    returns

    a list of all options in the builder, and corresponding values for them.

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

    Definition Classes

    AnyRef

52. def tally(name: String = null, short: Char = 0.toChar, descr: String = "", hidden: Boolean = false, noshort: Boolean = false): ScallopOption[Int]

53. def toString(): String

    Definition Classes

    AnyRef → Any

54. def toggle(name: String = null, default: ⇒ Option[Boolean] = None, short: Char = '\0', noshort: Boolean = false, prefix: String = "no", descrYes: String = "", descrNo: String = "", hidden: Boolean = false): ScallopOption[Boolean]

    Add new toggle option definition to this config, and get a holder for it's value.

    Add new toggle option definition to this config, and get a holder for it's value.

    Toggle options are just glorified flag options. For example, if you will ask for a toggle option with name "verbose", it will be invocable in three ways - "--verbose", "--noverbose", "-v".

    name

    Name of this option

    default

    default value for this option

    short

    Overload the char that will be used as short option name. Defaults to first character of the name.

    noshort

    If set to true, then this option will not have any short name.

    descrYes

    Description for positive variant of this option.

    descrNo

    Description for negative variant of this option.

    hidden

    If set to true, then this option will not be present in auto-generated help.

55. def trailArg[A](name: String, descr: String, validate: (A) ⇒ Boolean, required: Boolean, default: ⇒ Option[A], hidden: Boolean)(implicit conv: ValueConverter[A]): ScallopOption[A]

    Add new trailing argument definition to this config, and get a holder for it's value.

    Add new trailing argument definition to this config, and get a holder for it's value.

    name

    Name for new definition, used for identification.

    required

    Is this trailing argument required? Defaults to true.

    default

    If this argument is not required and not found in the argument list, use this value.

56. def validate[A1, A2, A3, A4, A5, A6, A7](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7])(fn: (A1, A2, A3, A4, A5, A6, A7) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

57. def validate[A1, A2, A3, A4, A5, A6](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6])(fn: (A1, A2, A3, A4, A5, A6) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

58. def validate[A1, A2, A3, A4, A5](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5])(fn: (A1, A2, A3, A4, A5) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

59. def validate[A1, A2, A3, A4](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4])(fn: (A1, A2, A3, A4) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

60. def validate[A1, A2, A3](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3])(fn: (A1, A2, A3) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

61. def validate[A1, A2](o1: ScallopOption[A1], o2: ScallopOption[A2])(fn: (A1, A2) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

62. def validate[A1](o1: ScallopOption[A1])(fn: (A1) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

63. def validate()(fn: () ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps. Automatically defines co-dependent relationship on these options.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

64. def validateOpt[A1, A2, A3, A4, A5, A6, A7](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7]) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

65. def validateOpt[A1, A2, A3, A4, A5, A6](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6]) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

66. def validateOpt[A1, A2, A3, A4, A5](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5]) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

67. def validateOpt[A1, A2, A3, A4](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4])(fn: (Option[A1], Option[A2], Option[A3], Option[A4]) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

68. def validateOpt[A1, A2, A3](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3])(fn: (Option[A1], Option[A2], Option[A3]) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

69. def validateOpt[A1, A2](o1: ScallopOption[A1], o2: ScallopOption[A2])(fn: (Option[A1], Option[A2]) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

70. def validateOpt[A1](o1: ScallopOption[A1])(fn: (Option[A1]) ⇒ Either[String, Unit]): Unit

    Adds a validation function to this configuration.

    Adds a validation function to this configuration. This function will be run after all other verification steps.

    fn

    Validation function. In case of error, it should return Left with the error message.

    Definition Classes

    ScallopConfValidations

71. var validations: List[() ⇒ Either[String, Unit]]

    Attributes

    protected

    Definition Classes

    ScallopConfValidations

72. var verified: Boolean

73. def version(v: String): Unit

    Add a version string to option builder.

    Add a version string to option builder.

    v

    Version string.

74. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws()

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

    Definition Classes

    AnyRef

    Annotations

    @throws()

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

    Definition Classes

    AnyRef

    Annotations

    @throws()