Args

Instance Constructors

new Args(programInvocation: String, leadingComments: String, trailingComments: String, opts: Seq[Opt[_]], defaults: Map[String, Any], values: Map[String, Any], allValues: Map[String, Seq[Any]], remaining: Seq[String], failures: Seq[(String, Any)])

Attributes
protected

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
val allValues: Map[String, Seq[Any]]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val defaults: Map[String, Any]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val failures: Seq[(String, Any)]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get[V](flag: String)(implicit arg0: ClassTag[V]): Option[V]

Return the value for the option.
Return the value for the option. This will be either the default specified, if the user did not invoke the option, or the _last_ invocation of the command line option. In other words, if the argument list contains --foo bar1 --foo bar2, then Some("bar2") is returned. Note: Use remaining to get the tokens not associated with a flag.

See also
getAll
def getAll[V](flag: String)(implicit arg0: ClassTag[V]): Seq[V]

Return a Seq with all values specified for the option.
Return a Seq with all values specified for the option. This supports the case where an option can be repeated on the command line. If the user did not specify the option, then default is mapped to a return value as follows:
- None => Nil
- Some(x) => Seq(x)
If the user specified one or more invocations, then all of the values are returned in Seq. For example, for --foo bar1 --foo bar2, then this method returns Seq("bar1", "bar2"). Note: Use remaining to get the tokens not associated with a flag.
See also
get
def getAllOrElse[V](flag: String, orElse: Seq[V])(implicit arg0: ClassTag[V]): Seq[V]

Like getAll, but an alternative is specified, if no value for exists.
Like getAll, but an alternative is specified, if no value for exists. Note: Use remaining to get the tokens not associated with a flag.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getOrElse[V](flag: String, orElse: V)(implicit arg0: ClassTag[V]): V

Like get, but an alternative is specified, if no value for the option exists, so the return value is of type V, rather than Option[V].
Like get, but an alternative is specified, if no value for the option exists, so the return value is of type V, rather than Option[V]. Note: Use remaining to get the tokens not associated with a flag.
def handleErrors(out: PrintStream = Console.err): Boolean

Were errors found in the argument list? If so, print the error messages, followed by the help message and return true.
Were errors found in the argument list? If so, print the error messages, followed by the help message and return true. Otherwise, return false. Callers may wish to exit if true is returned.
def handleHelp(out: PrintStream = Console.out): Boolean

Was the help option invoked? If so, print the help message to the output PrintStream and return true.
Was the help option invoked? If so, print the help message to the output PrintStream and return true. Otherwise, return false. Callers may wish to exit if true is returned.
def help: String
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val leadingComments: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val opts: Seq[Opt[_]]
val opts2: Seq[Opt[_]]

Attributes
protected
def parse(args: Seq[String]): Args

Parse the user-specified arguments, using parserChain.
Parse the user-specified arguments, using parserChain. Note that if an unrecognized flag is found, i.e., a string that starts with one or two '-', it is an error. Otherwise, all unrecognized options are added to the resulting values in a Seq[String] with the key, "remaining".
returns
Args
lazy val parserChain: Parser[_]
def printAllValues(out: PrintStream = Console.out): Unit

Print all the current values.
Print all the current values. Before any parsing is done, the values are the defaults. After parsing, they are the defaults overridden by all the user-supplied options. If an option is specified multiple times, then all values are shown.

See also
printValues
def printValues(out: PrintStream = Console.out): Unit

Print the current values.
Print the current values. Before any parsing is done, the values are the defaults. After parsing, they are the defaults overridden by any user-supplied options. If an option is specified multiple times, then the _last_ invocation is shown. Note that the "remaining" arguments are the same in this output and in printAllValues.

See also
printAllValues
def process(args: Seq[String], out: PrintStream = Console.out, exit: (Int) ⇒ Unit = n => sys.exit(n)): Args

Convenience method to parse the argument list and handle errors or help requests.
Convenience method to parse the argument list and handle errors or help requests. If a parsing error occurs or help is requested, an appropriate message is printed to the out argument and the program exits with a call to sys.exit(n) with the integer exit returned by the sister Args#process method. Normally, the default values for the out and exit arguments are only overridden for testing. For more customized handling, {@see #parse}.
returns
Args
val programInvocation: String
val remaining: Seq[String]
val remainingOpt: Opt[_]

Attributes
protected
val remainingOptName: String

Attributes
protected
val requiredOptions: Seq[Opt[_]]
def resolveFailures(keys: Seq[String], failures: Seq[(String, Any)]): Seq[(String, Any)]

Ignore all parse errors if help was requested
Ignore all parse errors if help was requested

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
Args → AnyRef → Any
val trailingComments: String
val unknownOptionMatch: Parser[Any]

Unknown option that starts with one or two '-' matches!
Unknown option that starts with one or two '-' matches!

Attributes
protected
val unknownOptionRE: Regex

Attributes
protected
val values: Map[String, Any]
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( ... )

Related Docs: object Args | package cla

case class Args(programInvocation: String, leadingComments: String, trailingComments: String, opts: Seq[Opt[_]], defaults: Map[String, Any], values: Map[String, Any], allValues: Map[String, Seq[Any]], remaining: Seq[String], failures: Seq[(String, Any)]) extends Product with Serializable

Instance Constructors

new Args(programInvocation: String, leadingComments: String, trailingComments: String, opts: Seq[Opt[_]], defaults: Map[String, Any], values: Map[String, Any], allValues: Map[String, Seq[Any]], remaining: Seq[String], failures: Seq[(String, Any)])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allValues: Map[String, Seq[Any]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaults: Map[String, Any]

final def eq(arg0: AnyRef): Boolean

val failures: Seq[(String, Any)]

def finalize(): Unit

def get[V](flag: String)(implicit arg0: ClassTag[V]): Option[V]

def getAll[V](flag: String)(implicit arg0: ClassTag[V]): Seq[V]

def getAllOrElse[V](flag: String, orElse: Seq[V])(implicit arg0: ClassTag[V]): Seq[V]

final def getClass(): Class[_]

def getOrElse[V](flag: String, orElse: V)(implicit arg0: ClassTag[V]): V

def handleErrors(out: PrintStream = Console.err): Boolean

def handleHelp(out: PrintStream = Console.out): Boolean

def help: String

final def isInstanceOf[T0]: Boolean

val leadingComments: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val opts: Seq[Opt[_]]

val opts2: Seq[Opt[_]]

def parse(args: Seq[String]): Args

lazy val parserChain: Parser[_]

def printAllValues(out: PrintStream = Console.out): Unit

def printValues(out: PrintStream = Console.out): Unit

def process(args: Seq[String], out: PrintStream = Console.out, exit: (Int) ⇒ Unit = n => sys.exit(n)): Args

val programInvocation: String

val remaining: Seq[String]

val remainingOpt: Opt[_]

val remainingOptName: String

val requiredOptions: Seq[Opt[_]]

def resolveFailures(keys: Seq[String], failures: Seq[(String, Any)]): Seq[(String, Any)]

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

def toString(): String

val trailingComments: String

val unknownOptionMatch: Parser[Any]

val unknownOptionRE: Regex

val values: Map[String, Any]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped