ScallopConfBase

Instance Constructors

new ScallopConfBase(args: Seq[String] = Nil, commandNameAndAliases: Seq[String] = Nil)

Abstract Value Members

abstract def optionNameGuessingSupported: Boolean

Attributes
protected
abstract def performOptionNameGuessing(): Unit

Attributes
protected

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var _guessOptionName: Boolean

Attributes
protected
def addSubcommand(conf: Subcommand): Unit

Add subcommand to this config
def addValidation(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.
fn
Validation function. In case of error, it should return Left with the error message.
def allDefinedOrUndefined(list: ScallopOption[_]*): Unit

Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
Add a check that either all or none of the provided options have values defined (either supplied in arguments or got from defaults).
list
list of options
def appendDefaultToDescription: Boolean

If set to true, scallop would append auto-generated text about default option value to option descriptions.
def appendDefaultToDescription_=(v: Boolean): Unit

If set to true, scallop would append auto-generated text about default option value to option descriptions.
val args: Seq[String]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def assertVerified(): Unit

Checks that this Conf object is verified.
Checks that this Conf object is verified. If it is not, throws an exception.
def banner(b: String): Unit

Add a banner string to option builder.
Add a banner string to option builder.
b
Banner string.
var builder: Scallop

Internal immutable builder for options setup.
def choice(choices: Seq[String], name: String = null, short: Char = '\u0000', descr: String = "", default: ⇒ Option[String] = None, required: Boolean = false, argName: String = "arg", hidden: Boolean = false, noshort: Boolean = noshort, group: ScallopOptionGroup = null): ScallopOption[String]

Add a new choice option definition to this config.
Add a new choice option definition to this config.
This option takes a single string argument and restricts values to a list of possible choices.
choices
List of possible argument values.
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".
hidden
If set to true, then this option will be hidden from generated help output.
noshort
If set to true, then this option does not have any short name.
group
Option group to add this option to.
returns
ScallopOption, container for the parsed option value.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def codependent(list: ScallopOption[_]*): Unit

Add a check that either all or none of the provided options have values supplied in arguments.
Add a check that either all or none of the provided options have values supplied in arguments.
list
list of codependent options
val commandNameAndAliases: Seq[String]

Attributes
protected
def conflicts(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

Add a check that none of the options in the list were supplied if opt was supplied.
Add a check that none of the options in the list were supplied if opt was supplied.
opt
option that conflicts with all of options in list
list
list of dependencies (all will need to be absent)
def dependsOnAll(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

Add a check that all of the options in the list were also supplied if opt was supplied.
Add a check that all of the options in the list were also supplied if opt was supplied.
opt
option that depends on all of options in list
list
list of dependencies (all will need to be present)
def dependsOnAny(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

Add a check that at least one of the options in the list was supplied if opt was supplied.
Add a check that at least one of the options in the list was supplied if opt was supplied.
opt
option, that depends on any of options in list
list
list of dependencies (at least one will need to be present)
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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 stderr, coloring the output if possible, then calls exitHandler(1).
Update this variable with another function if you need to change that behavior.
var exitHandler: (Int) ⇒ Unit

This function is called with an exit code when Scallop thinks it's time to terminate.
This function is called with an exit code when Scallop thinks it's time to terminate. By default this calls sys.exit(exitCode).
Update this variable with another function if you need to change that behavior.
def filteredSummary(blurred: Set[String]): String

Get summary of current parser state, hididng values for some of the options.
Get summary of current parser state, hididng values for some of the options. Useful if you log the summary and want to avoid storing sensitive information in the logs (like passwords)
blurred
names of the options that should be hidden.
returns
a list of all options in the builder
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def footer(f: String): Unit

Add a footer string to this builder.
Add a footer string to this builder.
f
footer string.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getFullHelpString(): String

Get full generated help contents (with version, banner, option usage and footer) as a string.
def getHelpString(): String

Get generated help contents as a string.
def getVersionString(): Option[String]

Get version string.
def group(header: String = ""): ScallopOptionGroup

Create and return a new option group
def hashCode(): Int

Definition Classes
AnyRef → Any
def helpFormatter: ScallopHelpFormatter

Get current custom help formatter.
def helpFormatter_=(formatter: ScallopHelpFormatter): Unit

Set custom help formatter.
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.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var isRootConfig: Boolean

true if this config does not represent a subcommand
true if this config does not represent a subcommand

Attributes
protected
def mainOptions: Seq[CliOption]

Options, that are to be printed first in the help printout
def mutuallyExclusive(list: ScallopOption[_]*): Unit

Add a check that only one or zero of the provided options have values supplied in arguments.
Add a check that only one or zero of the provided options have values supplied in arguments.
list
list of mutually exclusive options
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def noshort: Boolean

If set to true, then do not generate short names for subsequently defined options by default.
If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.
def noshort_=(v: Boolean): Unit

If set to true, then do not generate short names for subsequently defined options by default.
If set to true, then do not generate short names for subsequently defined options by default. Only applied if a subsequent option definition does not explicitly provide its noshort-parameter.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def number(name: String = null, descr: String = "", validate: (Long) ⇒ Boolean = (_:Long) => true, required: Boolean = false, default: ⇒ Option[Long] = None, hidden: Boolean = false, group: ScallopOptionGroup = null)(implicit conv: ValueConverter[Long]): ScallopOption[Long]

Add new number argument definition to this config and get a holder for it's value.
Add new number argument definition to this config and get a holder for it's value.
Parses arguments like -1 or -3 (like GNU tail, for example).
name
Name for new definition, used for identification.
descr
Description for this option, for help text.
validate
The function that validates the parsed value.
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.
hidden
If set to true then this option will not be present in auto-generated help.
group
Option group to add this option to.
conv
The converter for this option. Usually found implicitly.
returns
ScallopOption, container for the parsed option value.
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
def opt[A](name: String = null, short: Char = '\u0000', descr: String = "", default: ⇒ Option[A] = None, validate: (A) ⇒ Boolean = (_:A) => true, required: Boolean = false, argName: String = "arg", hidden: Boolean = false, noshort: Boolean = builder.noshort, group: ScallopOptionGroup = null)(implicit conv: ValueConverter[A]): ScallopOption[A]

Add a new simple option definition to this config.
Add a new simple option definition to this config.
name
Name for new option, used as long option name in parsing, and for option identification.
short
By default, the first character of option name is used for short option name. You can override it by specifying the required character (short = 'c').
descr
Description for the option. Will be printed in help message, carefully formatted to the output width (80 characters by default).
default
Default value to use if option is not found in input arguments (if you provide this, you can omit the type on method).
validate
The function that validates the parsed value.
required
Is this option required? Defaults to false.
argName
The name for this option argument, as it will appear in help. Defaults to "arg".
hidden
Hides description of this option from help (this can be useful for debugging options).
noshort
If set to true, then this option does not have any short name.
group
Option group to add this option to.
conv
The converter for this option. Usually found implicitly.
returns
ScallopOption, container for the parsed option value.
var parentConfig: ScallopConfBase

Pointer to parent ScallopConf
Pointer to parent ScallopConf

Attributes
protected
def printHelp(): Unit

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

This name would be included in output when reporting errors.
def props[A](name: Char = 'D', descr: String = "", keyName: String = "key", valueName: String = "value", hidden: Boolean = false, group: ScallopOptionGroup = null)(implicit conv: ValueConverter[Map[String, A]]): LazyMap[String, A]

Add new property option definition to this config object.
Add new property option definition to this config object.
This option will parse arguments like -Dkey=value or -D key1=value1 key2=value2.
name
Character 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".
hidden
If set to true, then this option will be hidden from generated help output.
group
Option group to add this option to.
conv
The converter for this option. Usually found implicitly.
returns
ScallopOption, container for the parsed option value.
def propsLong[A](name: String = "Props", descr: String = "", keyName: String = "key", valueName: String = "value", hidden: Boolean = false, group: ScallopOptionGroup = null)(implicit conv: ValueConverter[Map[String, A]]): Map[String, A]

Add new property option definition to this config object.
Add new property option definition to this config object.
This option will parse arguments like --Props key1=value1 key2=value2.
name
Name for new option, used as long option name in parsing, and for option identification.
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".
hidden
If set to true, then this option will be hidden from generated help output.
group
Option group to add this option to.
conv
The converter for this option. Usually found implicitly.
returns
ScallopOption, container for the parsed option value.
def requireAtLeastOne(list: ScallopOption[_]*): Unit

Add a check that at least one of the options is supplied.
Add a check that at least one of the options is supplied.
list
list of options (at least one must be present)
def requireOne(list: ScallopOption[_]*): Unit

Add a check that at one and only one option in the list is supplied.
Add a check that at one and only one option in the list is supplied.
list
list of conflicting options (exactly one must be present)
def requireSubcommand(): Unit

Require subcommand to be provided (validation will fail if no subcommand was provided on the command line).
def shortSubcommandsHelp(enable: Boolean = true): Unit

If set to true, do not output subcommand options in the help output for the main program (only output short subcommand description in such cases).
If set to true, do not output subcommand options in the help output for the main program (only output short subcommand description in such cases). Full help for subcommand options can still be accessed via program subcommand-name --help.
enable
enable short format for subcommand help
var stderrPrintln: (String) ⇒ Unit

This function is called with a string when Scallop needs to output text to stderr.
This function is called with a string when Scallop needs to output text to stderr. Update this variable if you need to redirect stderr output somewhere else.
var stdoutPrintln: (String) ⇒ Unit

This function is called with a string when Scallop needs to output text to stdout.
This function is called with a string when Scallop needs to output text to stdout. Update this variable if you need to redirect stdout output somewhere else.
def subcommand: Option[ScallopConfBase]

Retrieves the choosen subcommand.
def subcommands: List[ScallopConfBase]

Retrieves the list of the chosen nested subcommands.
var subconfigs: Seq[ScallopConfBase]

List of sub-configs of this config.
List of sub-configs of this config.

Attributes
protected
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def tally(name: String = null, short: Char = '\u0000', descr: String = "", hidden: Boolean = false, noshort: Boolean = builder.noshort, group: ScallopOptionGroup = null): ScallopOption[Int]

Add a new tally option definition to this config.
Add a new tally option definition to this config.
Tally options count how many times the option was provided on the command line. E.g., -vvv will be countet as 3.
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.
hidden
If set to true, then this option will be hidden from generated help output.
noshort
If set to true, then this option does not have any short name.
group
Option group to add this option to.
returns
ScallopOption, container for the parsed option value.
def toString(): String

Definition Classes
AnyRef → Any
def toggle(name: String = null, default: ⇒ Option[Boolean] = None, short: Char = '\u0000', noshort: Boolean = noshort, prefix: String = "no", descrYes: String = "", descrNo: String = "", required: Boolean = false, hidden: Boolean = false, group: ScallopOptionGroup = null): 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 create 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.
prefix
Prefix to name of the option, that will be used for "negative" version of the option.
descrYes
Description for positive variant of this option.
descrNo
Description for negative variant of this option.
required
Is this option required? Defaults to false.
hidden
If set to true, then this option will not be present in auto-generated help.
group
Option group to add this option to.
returns
ScallopOption, container for the parsed option value.
def trailArg[A](name: String = null, descr: String = "", validate: (A) ⇒ Boolean = (_:A) => true, required: Boolean = true, default: ⇒ Option[A] = None, hidden: Boolean = false, group: ScallopOptionGroup = null)(implicit conv: ValueConverter[A]): ScallopOption[A]

Add new trailing argument definition to this config.
Add new trailing argument definition to this config.
name
Name for new definition, used for identification.
descr
Description for this option, for help text.
validate
The function that validates the parsed value.
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.
hidden
If set to true then this option will not be present in auto-generated help.
group
Option group to add this option to.
conv
The converter for this option. Usually found implicitly.
returns
ScallopOption, container for the parsed option value.
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21], o22: ScallopOption[A22])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8, A9](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9])(fn: (A1, A2, A3, A4, A5, A6, A7, A8, A9) ⇒ 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
def validate[A1, A2, A3, A4, A5, A6, A7, A8](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8])(fn: (A1, A2, A3, A4, A5, A6, A7, A8) ⇒ 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
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
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
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
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
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
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
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
def validateFileDoesNotExist(fileOption: ScallopOption[File]): Unit

Validate that file does not exists.
def validateFileExists(fileOption: ScallopOption[File]): Unit

Validate that file exists.
def validateFileIsDirectory(fileOption: ScallopOption[File]): Unit

Validate that file argument is directory.
def validateFileIsFile(fileOption: ScallopOption[File]): Unit

Validate that file is not a directory.
def validateFilesDoNotExist(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option do not exist.
def validateFilesExist(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option exist.
def validateFilesIsDirectory(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option are directories.
def validateFilesIsFile(filesOption: ScallopOption[List[File]]): Unit

Validate that all the files in the arguments to multi-arg option are not directories.
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, A22](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21], o22: ScallopOption[A22])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19], Option[A20], Option[A21], Option[A22]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20], o21: ScallopOption[A21])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19], Option[A20], Option[A21]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19], o20: ScallopOption[A20])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19], Option[A20]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18], o19: ScallopOption[A19])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18], Option[A19]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17], o18: ScallopOption[A18])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17], Option[A18]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16], o17: ScallopOption[A17])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16], Option[A17]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15], o16: ScallopOption[A16])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15], Option[A16]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14], o15: ScallopOption[A15])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14], Option[A15]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13], o14: ScallopOption[A14])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13], Option[A14]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12], o13: ScallopOption[A13])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12], Option[A13]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11], o12: ScallopOption[A12])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11], Option[A12]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10], o11: ScallopOption[A11])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10], Option[A11]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9, A10](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9], o10: ScallopOption[A10])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9], Option[A10]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8, A9](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8], o9: ScallopOption[A9])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8], Option[A9]) ⇒ 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
def validateOpt[A1, A2, A3, A4, A5, A6, A7, A8](o1: ScallopOption[A1], o2: ScallopOption[A2], o3: ScallopOption[A3], o4: ScallopOption[A4], o5: ScallopOption[A5], o6: ScallopOption[A6], o7: ScallopOption[A7], o8: ScallopOption[A8])(fn: (Option[A1], Option[A2], Option[A3], Option[A4], Option[A5], Option[A6], Option[A7], Option[A8]) ⇒ 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
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
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
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
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
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
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
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
def validatePathDoesNotExist(pathOption: ScallopOption[Path]): Unit

Validate that path does not point to the existing file.
def validatePathExists(pathOption: ScallopOption[Path]): Unit

Validate that path points to the existing file.
def validatePathIsDirectory(pathOption: ScallopOption[Path]): Unit

Validate that path points to a directory.
def validatePathIsFile(pathOption: ScallopOption[Path]): Unit

Validate that path points to a file (not directory).
def validatePathsDoesNotExist(pathsOption: ScallopOption[List[Path]]): Unit

Validate that path target does not exist.
def validatePathsExists(pathsOption: ScallopOption[List[Path]]): Unit

Validate that path target exists.
def validatePathsIsDirectory(pathsOption: ScallopOption[List[Path]]): Unit

Validate that paths targets exist.
def validatePathsIsFile(pathsOption: ScallopOption[List[Path]]): Unit

Validate that all paths targets are files (not directories).
var validations: List[() ⇒ Either[String, Unit]]

Attributes
protected
Definition Classes
ScallopConfValidations
def verify(): Unit

Verify this configuration - parse the arguments, convert option values, run validations.
Verify this configuration - parse the arguments, convert option values, run validations. This method MUST be called at the end of all options definitions, attempts to access option values before it is called will result in runtime exception.
def version(v: String): Unit

Add a version string to option builder.
Add a version string to option builder.
v
Version string.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def mainOptions_=(newMainOptions: ⇒ Seq[ScallopOption[_]]): Unit

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

Annotations
@deprecated
Deprecated
(Since version Scallop 4.0.0) Use option groups instead, for example see https://github.com/scallop/scallop/wiki/Help-information-printing#option-groups

Related Doc: package scallop

abstract class ScallopConfBase extends ScallopConfValidations

Instance Constructors

new ScallopConfBase(args: Seq[String] = Nil, commandNameAndAliases: Seq[String] = Nil)

Abstract Value Members

abstract def optionNameGuessingSupported: Boolean

abstract def performOptionNameGuessing(): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

var _guessOptionName: Boolean

def addSubcommand(conf: Subcommand): Unit

def addValidation(fn: ⇒ Either[String, Unit]): Unit

def allDefinedOrUndefined(list: ScallopOption[_]*): Unit

def appendDefaultToDescription: Boolean

def appendDefaultToDescription_=(v: Boolean): Unit

val args: Seq[String]

final def asInstanceOf[T0]: T0

def assertVerified(): Unit

def banner(b: String): Unit

var builder: Scallop

def choice(choices: Seq[String], name: String = null, short: Char = '\u0000', descr: String = "", default: ⇒ Option[String] = None, required: Boolean = false, argName: String = "arg", hidden: Boolean = false, noshort: Boolean = noshort, group: ScallopOptionGroup = null): ScallopOption[String]

def clone(): AnyRef

def codependent(list: ScallopOption[_]*): Unit

val commandNameAndAliases: Seq[String]

def conflicts(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

def dependsOnAll(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

def dependsOnAny(opt: ScallopOption[_], list: List[ScallopOption[_]]): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

var errorMessageHandler: (String) ⇒ Unit

var exitHandler: (Int) ⇒ Unit

def filteredSummary(blurred: Set[String]): String

def finalize(): Unit

def footer(f: String): Unit

final def getClass(): Class[_]

def getFullHelpString(): String

def getHelpString(): String

def getVersionString(): Option[String]

def group(header: String = ""): ScallopOptionGroup

def hashCode(): Int

def helpFormatter: ScallopHelpFormatter

def helpFormatter_=(formatter: ScallopHelpFormatter): Unit

def helpWidth(w: Int): Unit

final def isInstanceOf[T0]: Boolean

var isRootConfig: Boolean

def mainOptions: Seq[CliOption]

def mutuallyExclusive(list: ScallopOption[_]*): Unit

final def ne(arg0: AnyRef): Boolean

def noshort: Boolean

def noshort_=(v: Boolean): Unit

final def notify(): Unit

final def notifyAll(): Unit

def number(name: String = null, descr: String = "", validate: (Long) ⇒ Boolean = (_:Long) => true, required: Boolean = false, default: ⇒ Option[Long] = None, hidden: Boolean = false, group: ScallopOptionGroup = null)(implicit conv: ValueConverter[Long]): ScallopOption[Long]

def onError(e: Throwable): Unit

var parentConfig: ScallopConfBase

def printHelp(): Unit

var printedName: String

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

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

def requireAtLeastOne(list: ScallopOption[_]*): Unit

def requireOne(list: ScallopOption[_]*): Unit

def requireSubcommand(): Unit

def shortSubcommandsHelp(enable: Boolean = true): Unit

var stderrPrintln: (String) ⇒ Unit

var stdoutPrintln: (String) ⇒ Unit

def subcommand: Option[ScallopConfBase]

def subcommands: List[ScallopConfBase]

var subconfigs: Seq[ScallopConfBase]

def summary: String

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

def tally(name: String = null, short: Char = '\u0000', descr: String = "", hidden: Boolean = false, noshort: Boolean = builder.noshort, group: ScallopOptionGroup = null): ScallopOption[Int]

def toString(): String

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

def trailArg[A](name: String = null, descr: String = "", validate: (A) ⇒ Boolean = (_:A) => true, required: Boolean = true, default: ⇒ Option[A] = None, hidden: Boolean = false, group: ScallopOptionGroup = null)(implicit conv: ValueConverter[A]): ScallopOption[A]

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

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

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