BoolOpt

A boolean/flag command line option

Examples

import com.frugalmechanic.optparse._

object MyApp extends OptParse {
  // Basic flag using a default long name of --flag and short name of -f
  val flag = BoolOpt()

  // Example with all available options instead of relying on the defaults
  val verbose = BoolOpt(
     long="verbose",     // Long name to use (--verbose)
     short="v",          // Short name to use (-v)
     default=false,      // Default value for this flag (true/false)
     desc="Be verbose",  // Help message description
     enables=noisy,      // Other flags to enable if this one is enabled (single option or a Seq of options)
     disables=Seq(quiet),// Other flags to disable if this one is enabled (single option or a Seq of options)
     invalidWith=quiet,  // Other options this flag is invalid with (they cannot be set)
     validWith=noisy,    // Other options that are required with this flag
     exclusive=false,    // Other options can be set when this option is set
  )

  // You can also use "new BoolOpt()" instead of using the companion object
  val noisy = new BoolOpt()
  val quiet = new BoolOpt()

  def main(args:Array[String]) {
    parse(args)

    if(verbose) println("You want verbose output")
  }
}

Linear Supertypes

OptVal[Boolean], Opt, AnyRef, Any

Instance Constructors

new BoolOpt(long: Option[String], short: Option[Char], default: Option[Boolean], desc: String, enables: ⇒ Seq[BoolOpt], disables: ⇒ Seq[BoolOpt], invalidWith: ⇒ Seq[Opt], validWith: ⇒ Seq[Opt], exclusive: Boolean)

long
Long name for this option (--long_name on the command line)
short
Short name for this option (-short_name on the command line)
default
Default value for this option
desc
Description of the parameter (used in help message)
enables
Other flags that this option implicitly enables
disables
Other flags that this option implicitly disables
validWith
Other options that are required to be set when using this options
exclusive
Whether or not this option is exclusive and cannot be used with any other options (e.g. like --help where it prints the help message and exits)

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
var actualLong: Option[String]

Attributes
protected[com.frugalmechanic.optparse]
Definition Classes
Opt
var actualShort: Option[Char]

Attributes
protected[com.frugalmechanic.optparse]
Definition Classes
Opt
def apply(): Boolean

Get the value
Get the value
This calls Option.get on the underlying value so an exception will be thrown if the value is not set.

Definition Classes
OptVal
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var methodName: String

Attributes
protected[com.frugalmechanic.optparse]
Definition Classes
Opt
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def reset: Unit

Reset the value to the default
Reset the value to the default

Definition Classes
OptVal → Opt
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def value: Option[Boolean]

The value attached to this command line option (wrapped in an Option)
The value attached to this command line option (wrapped in an Option)

Definition Classes
OptVal
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()

class BoolOpt extends OptVal[Boolean]

Examples

Instance Constructors

new BoolOpt(long: Option[String], short: Option[Char], default: Option[Boolean], desc: String, enables: ⇒ Seq[BoolOpt], disables: ⇒ Seq[BoolOpt], invalidWith: ⇒ Seq[Opt], validWith: ⇒ Seq[Opt], exclusive: Boolean)

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

var actualLong: Option[String]

var actualShort: Option[Char]

def apply(): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

var methodName: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reset: Unit

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

def toString(): String

def value: Option[Boolean]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from OptVal[Boolean]

Inherited from Opt

Inherited from AnyRef

Inherited from Any

Ungrouped