Opt

Type Members

class Flag extends Opt[Boolean]

An implementation class for flags (boolean) options.
An implementation class for flags (boolean) options.

Attributes
protected[com.concurrentthought.cla]
case class InvalidValueString(flag: String, valueMessage: String, cause: Option[Throwable] = None) extends RuntimeException with Product with Serializable

Exception raised when an invalid value string is given.
Exception raised when an invalid value string is given. Not all errors are detected and reported this way. For example, calls to s.toInt for an invalid string will result in NumberFormatException.
type Parser[V] = PartialFunction[Seq[String], ((String, Try[V]), Seq[String])]

Each option attempts to parse one or more tokens in the argument list.
Each option attempts to parse one or more tokens in the argument list. If successful, it returns the option's name and extracted value as a tuple, along with the rest of the arguments.

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def byte(name: String, flags: Seq[String], default: Option[Byte] = None, help: String = "", requiredFlag: Boolean = false): Opt[Byte]

Create a Byte option.
def char(name: String, flags: Seq[String], default: Option[Char] = None, help: String = "", requiredFlag: Boolean = false): Opt[Char]

Create a Char option.
Create a Char option. Just takes the first character in the value string.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def double(name: String, flags: Seq[String], default: Option[Double] = None, help: String = "", requiredFlag: Boolean = false): Opt[Double]

Create a Double option.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flag(name: String, flags: Seq[String], help: String = "", requiredFlag: Boolean = false): Flag

Create a "flag" (Boolean) option.
Create a "flag" (Boolean) option. Unlike all the other kinds of options, it does not consume an argument that follows it. Instead the inferred default value corresponding to the flag is false. If a user specifies the flag on the command line, the corresponding value is true.

See also
Opt.notflag
def float(name: String, flags: Seq[String], default: Option[Float] = None, help: String = "", requiredFlag: Boolean = false): Opt[Float]

Create a Float option.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def int(name: String, flags: Seq[String], default: Option[Int] = None, help: String = "", requiredFlag: Boolean = false): Opt[Int]

Create an Int option.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def long(name: String, flags: Seq[String], default: Option[Long] = None, help: String = "", requiredFlag: Boolean = false): Opt[Long]

Create a Long option.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def notflag(name: String, flags: Seq[String], help: String = "", requiredFlag: Boolean = false): Flag

Like flag, but the default value is true, not false.
Like flag, but the default value is true, not false.

See also
Opt.flag
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def path(name: String, flags: Seq[String], default: Option[Seq[String]] = None, help: String = "List of file system paths", requiredFlag: Boolean = false): Opt[Seq[String]]

A helper method for path-like structures, where the default delimiter for the platform is used, e.g., ':' for *nix systems and ';' for Windows.
def pathSeparator: String
def seq[V](delimsRE: String)(name: String, flags: Seq[String], default: Option[Seq[V]] = None, help: String = "", requiredFlag: Boolean = false)(fromString: (String) ⇒ Try[V]): Opt[Seq[V]]

Create an option where the value string represents a sequence with a delimiter.
Create an option where the value string represents a sequence with a delimiter. The delimiter string is treated as a regex. For matching on several possible delimiter characters, use "[;-_]", for example. The resulting substrings won't be trimmed of whitespace, in case you want it, but you can also remove any internal whitespace (i.e., not at the beginning or end of the input string), e.g., "\\s*[;-_]\\s*". The delimiter is given as a separate argument list so that the list of common Opt arguments is consistent with the other helper methods.
def seqString(delimsRE: String)(name: String, flags: Seq[String], default: Option[Seq[String]] = None, help: String = "", requiredFlag: Boolean = false): Opt[Seq[String]]

A helper method when the substrings are returned without further processing required.
def string(name: String, flags: Seq[String], default: Option[String] = None, help: String = "", requiredFlag: Boolean = false): Opt[String]

Create a String option
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toSeq[V](to: (String) ⇒ V): (String) ⇒ Seq[V]

Lift String => V to String => Seq[V].
def toString(): String

Definition Classes
AnyRef → Any
def toTry[V](to: (String) ⇒ V): (String) ⇒ Try[V]

Lift String => V to String => Try[V].
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: class Opt | package cla

object Opt extends Serializable

Type Members

class Flag extends Opt[Boolean]

case class InvalidValueString(flag: String, valueMessage: String, cause: Option[Throwable] = None) extends RuntimeException with Product with Serializable

type Parser[V] = PartialFunction[Seq[String], ((String, Try[V]), Seq[String])]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def byte(name: String, flags: Seq[String], default: Option[Byte] = None, help: String = "", requiredFlag: Boolean = false): Opt[Byte]

def char(name: String, flags: Seq[String], default: Option[Char] = None, help: String = "", requiredFlag: Boolean = false): Opt[Char]

def clone(): AnyRef

def double(name: String, flags: Seq[String], default: Option[Double] = None, help: String = "", requiredFlag: Boolean = false): Opt[Double]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def flag(name: String, flags: Seq[String], help: String = "", requiredFlag: Boolean = false): Flag

def float(name: String, flags: Seq[String], default: Option[Float] = None, help: String = "", requiredFlag: Boolean = false): Opt[Float]

final def getClass(): Class[_]

def hashCode(): Int

def int(name: String, flags: Seq[String], default: Option[Int] = None, help: String = "", requiredFlag: Boolean = false): Opt[Int]

final def isInstanceOf[T0]: Boolean

def long(name: String, flags: Seq[String], default: Option[Long] = None, help: String = "", requiredFlag: Boolean = false): Opt[Long]

final def ne(arg0: AnyRef): Boolean

def notflag(name: String, flags: Seq[String], help: String = "", requiredFlag: Boolean = false): Flag

final def notify(): Unit

final def notifyAll(): Unit

def path(name: String, flags: Seq[String], default: Option[Seq[String]] = None, help: String = "List of file system paths", requiredFlag: Boolean = false): Opt[Seq[String]]

def pathSeparator: String

def seq[V](delimsRE: String)(name: String, flags: Seq[String], default: Option[Seq[V]] = None, help: String = "", requiredFlag: Boolean = false)(fromString: (String) ⇒ Try[V]): Opt[Seq[V]]

def seqString(delimsRE: String)(name: String, flags: Seq[String], default: Option[Seq[String]] = None, help: String = "", requiredFlag: Boolean = false): Opt[Seq[String]]

def string(name: String, flags: Seq[String], default: Option[String] = None, help: String = "", requiredFlag: Boolean = false): Opt[String]

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

def toSeq[V](to: (String) ⇒ V): (String) ⇒ Seq[V]

def toString(): String

def toTry[V](to: (String) ⇒ V): (String) ⇒ Try[V]

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 AnyRef

Inherited from Any

Ungrouped