org.rogach.scallop.Scallop

Instance Constructors

new Scallop(args: Seq[String] = immutable.this.Nil, opts: List[CliOption] = immutable.this.Nil, mainOpts: List[String] = immutable.this.Nil, vers: Option[String] = scala.None, bann: Option[String] = scala.None, foot: Option[String] = scala.None, descr: String = "", optionSetValidations: List[(List[String]) ⇒ Either[String, Unit]] = immutable.this.Nil, helpWidth: Option[Int] = scala.None, shortSubcommandsHelp: Boolean = false, subbuilders: List[(String, Scallop)] = immutable.this.Nil)

args
Arguments to parse.
opts
Options definitions.
mainOpts
Names of options, that are to be printed first in the help printout
vers
Version string to display in help.
bann
Banner (summary of this program and command-line usage) to display in help.
foot
Footer - displayed after options.
descr
Short description - used for subcommands
optionSetValidations
Validations, that enforce some rules on groups of options
helpWidth
Width, to which the help output will be formatted (note that banner, footer, version and description are not affected!)
shortSubcommandsHelp
If true, then help output from this builder wouldn't list full help for subcommands, only short description
subbuilders
subcommands in this builder

Type Members

case class ParseResult(opts: Parsed, subcommand: Option[String], subcommandArgs: List[String]) extends Product with Serializable
type Parsed = List[(CliOption, (String, List[String]))]

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
def addSubBuilder(name: String, builder: Scallop): Scallop

Adds a subbuilder (subcommand) to this builder.
Adds a subbuilder (subcommand) to this builder.
name
All arguments after this string would be routed to this builder.
def apply[A](name: Char)(implicit m: Manifest[A]): A
def apply[A](name: String)(implicit m: Manifest[A]): A

Get the value of option.
Get the value of option. If option is not found, this will throw an exception.
name
Name for option.
m
Manifest for requested type. Usually found implicitly.
def args(a: Seq[String]): Scallop

Add some more arguments to this builder.
Add some more arguments to this builder. They are appended to the end of the original list.
a
arg list to add
val args: Seq[String]

Arguments to parse.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val bann: Option[String]

Banner (summary of this program and command-line usage) to display in help.
def banner(b: String): Scallop

Add banner string to this builder.
Add banner string to this builder. Banner should describe your program and provide a short summary on it's usage.
b
Banner string, can contain multiple lines. Note this is not formatted to 80 characters!
def canEqual(arg0: Any): Boolean

Definition Classes
Scallop → Equals
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
val descr: String

Short description - used for subcommands
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
Scallop → Equals → AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
def findSubbuilder(name: String): Option[Scallop]

Traverses the tree of subbuilders, using the provided name.
Traverses the tree of subbuilders, using the provided name.
name
Names of subcommand names, that lead to the needed builder, separated by \\0.
val foot: Option[String]

Footer - displayed after options.
def footer(f: String): Scallop

Add footer string to this builder.
Add footer string to this builder. Footer will be printed in help after option definitions.
f
Footer string, can contain multiple lines. Note this is not formatted to 80 characters!
def get[A](name: Char)(implicit m: Manifest[A]): Option[A]
def get[A](name: String)(implicit m: Manifest[A]): Option[A]

Get the value of option (or trailing arg) as Option.
Get the value of option (or trailing arg) as Option.
name
Name for option.
m
Manifest for requested type. Usually found implicitly.
def getAllSuppliedOptionNames: List[String]

Retrieves a list of all supplied options (including options from subbuilders).
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
def getOptionShortNames(opt: CliOption): List[Char]
def getOptionWithShortName(c: Char): Option[CliOption]

Find an option, that responds to this short name.
def getSubbuilder: Option[Scallop]

Retrieves the subbuilder object, that matches the name of the subcommand found in input arguments.
def getSubcommandName: Option[String]

Retrieves name of the subcommand that was found in input arguments.
def getSubcommandNames: List[String]

Returns the list of subcommand names, recursively.
def hashCode(): Int

Definition Classes
Scallop → AnyRef → Any
def help: String

Get help on options from this builder.
Get help on options from this builder. The resulting help is carefully formatted to required number of columns (default = 80, change with .setHelpWidth method), and contains info on proporties, options and trailing arguments.
val helpWidth: Option[Int]

Width, to which the help output will be formatted (note that banner, footer, version and description are not affected!)
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isSupplied(name: String): Boolean

Tests if this option or trailing arg was explicitly provided by argument list (not from default).
Tests if this option or trailing arg was explicitly provided by argument list (not from default).
name
Identifier of option or trailing arg definition
val mainOpts: List[String]

Names of options, that are to be printed first in the help printout
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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]): Scallop

Add a new option definition to this builder.
Add a new option definition to this builder.
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).
validate
The function, that validates the parsed value
required
Is this option required? Defaults to false.
argName
The name for this ortion 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.
conv
The converter for this option. Usually found implicitly.
val optionSetValidations: List[(List[String]) ⇒ Either[String, Unit]]

Validations, that enforce some rules on groups of options
val opts: List[CliOption]

Options definitions.
def printHelp(): Unit

Print help message (with version, banner, option usage and footer) to stdout.
def productArity: Int

Definition Classes
Scallop → Product
def productElement(arg0: Int): Any

Definition Classes
Scallop → Product
def productIterator: Iterator[Any]

Definition Classes
Product
def productPrefix: String

Definition Classes
Scallop → Product
def prop[A](name: Char, key: String)(implicit m: Manifest[Map[String, A]]): Option[A]
def props[A](name: Char, descr: String = "", keyName: String = "key", valueName: String = "value", hidden: Boolean = false)(implicit conv: ValueConverter[Map[String, A]]): Scallop

Add new property option definition to this builder.
Add new property option definition to this builder.
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".
def propsLong[A](name: String, descr: String = "", keyName: String = "key", valueName: String = "value", hidden: Boolean = false)(implicit conv: ValueConverter[Map[String, A]]): Scallop
def setHelpWidth(w: Int): Scallop

Explicitly sets the needed width for the help printout.
val shortSubcommandsHelp: Boolean

If true, then help output from this builder wouldn't list full help for subcommands, only short description
val subbuilders: List[(String, Scallop)]

subcommands in this builder
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 toString(): String

Definition Classes
Scallop → AnyRef → Any
def toggle(name: String, default: () ⇒ Option[Boolean] = () => None, short: Char = 0.toChar, noshort: Boolean = false, prefix: String = "no", descrYes: String = "", descrNo: String = "", hidden: Boolean = false): Scallop
def trailArg[A](name: String, required: Boolean, descr: String, default: () ⇒ Option[A], validate: (A) ⇒ Boolean, hidden: Boolean)(implicit conv: ValueConverter[A]): Scallop

Add new trailing argument definition to this builder.
Add new trailing argument definition to this builder.
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.
validate
The function, that validates the parsed value
def validationSet(fn: (List[String]) ⇒ Either[String, Unit]): Scallop

Add a validation for supplied option set.
Add a validation for supplied option set.
fn
A function, that accepts the list of names of options, that are supplied. It should return a Left with error message in case of validation failure.
def verify: Scallop

Verify the builder.
Verify the builder. Parses arguments, makes sure no definitions clash, no garbage or unknown options are present, and all present arguments are in proper format. It is recommended to call this method before using the results.
If there is "--help" or "--version" option present, it prints help or version statement and exits.
val vers: Option[String]

Version string to display in help.
def version(v: String): Scallop

Add version string to this builder.
Add version string to this builder.
v
Version string, to be printed before all other things in help.
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 productElements: Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
(Since version 2.8.0) use productIterator instead

Scallop

Instance Constructors

Type Members

case class ParseResult(opts: Parsed, subcommand: Option[String], subcommandArgs: List[String]) extends Product with Serializable

type Parsed = List[(CliOption, (String, List[String]))]

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def addSubBuilder(name: String, builder: Scallop): Scallop

def apply[A](name: Char)(implicit m: Manifest[A]): A

def apply[A](name: String)(implicit m: Manifest[A]): A

def args(a: Seq[String]): Scallop

val args: Seq[String]

final def asInstanceOf[T0]: T0

val bann: Option[String]

def banner(b: String): Scallop

def canEqual(arg0: Any): Boolean

def clone(): AnyRef

val descr: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def findSubbuilder(name: String): Option[Scallop]

val foot: Option[String]

def footer(f: String): Scallop

def get[A](name: Char)(implicit m: Manifest[A]): Option[A]

def get[A](name: String)(implicit m: Manifest[A]): Option[A]

def getAllSuppliedOptionNames: List[String]

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

def getOptionShortNames(opt: CliOption): List[Char]

def getOptionWithShortName(c: Char): Option[CliOption]

def getSubbuilder: Option[Scallop]

def getSubcommandName: Option[String]

def getSubcommandNames: List[String]

def hashCode(): Int

def help: String

val helpWidth: Option[Int]

final def isInstanceOf[T0]: Boolean

def isSupplied(name: String): Boolean

val mainOpts: List[String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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]): Scallop

val optionSetValidations: List[(List[String]) ⇒ Either[String, Unit]]

val opts: List[CliOption]

def printHelp(): Unit

def productArity: Int

def productElement(arg0: Int): Any

def productIterator: Iterator[Any]

def productPrefix: String

def prop[A](name: Char, key: String)(implicit m: Manifest[Map[String, A]]): Option[A]

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

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

def setHelpWidth(w: Int): Scallop

val shortSubcommandsHelp: Boolean

val subbuilders: List[(String, Scallop)]

def summary: String

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

def toString(): String

def toggle(name: String, default: () ⇒ Option[Boolean] = () => None, short: Char = 0.toChar, noshort: Boolean = false, prefix: String = "no", descrYes: String = "", descrNo: String = "", hidden: Boolean = false): Scallop

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

def validationSet(fn: (List[String]) ⇒ Either[String, Unit]): Scallop

def verify: Scallop

val vers: Option[String]

def version(v: String): Scallop

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

def productElements: Iterator[Any]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any