StrOpt

A command line option that takes a string argument

Examples

object MyApp extends OptParse {
// Basic string argument using a default long name of --name and short name of -n
val name = StrOpt()

// Example with all available options instead of relying on the defaults
val message = BoolOpt(
   long="message",          // Long name to use (--message)
   short="m",               // Short name to use (-m)
   default="Hello",         // Default value
   desc="Message to print", // Help message description
   enables=Nil,             // Other flags to enable if this one is enabled (single option or a Seq of options)
   disables=Nil,            // Other flags to disable if this one is enabled (single option or a Seq of options)
   invalidWith=Nil,         // Other options this flag is invalid with (they cannot be set)
   validWith=Nil,           // Other options that are required with this flag
   exclusive=false,         // Other options can be set when this option is set
   validate="^[a-zA-Z ,]+$" // Use a regex for validation via an implicit that converts it to: (String) => Boolean
)

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

  // getOrElse is available via an implicit from OptVal to Option[String]
  println(message+" "+name.getOrElse("Anonymous"))
}
}

Linear Supertypes

SingleOpt[String], ArgOpt[String], OptVal[String], Opt, AnyRef, Any

Instance Constructors

new StrOpt(long: Option[String], short: Option[Char], default: Option[String], desc: String, enables: ⇒ Seq[BoolOpt], disables: ⇒ Seq[BoolOpt], invalidWith: ⇒ Seq[Opt], validWith: ⇒ Seq[Opt], exclusive: Boolean, validate: (String) ⇒ 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
invalidWith
Other options that this option is not valid with
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)
validate
A method that takes the String value and returns a boolean indicating if the argument value is valid

Type Members

type Elem = String

Definition Classes
SingleOpt

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(): String

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
@HotSpotIntrinsicCandidate() @throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
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
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def parseValue(v: String): String

A no-op default parsing method
A no-op default parsing method

Definition Classes
StrOpt → ArgOpt
def reset(): Unit

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

Definition Classes
OptVal → Opt
def setValue(arg: String): Unit

Definition Classes
SingleOpt
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def validate(value: String): Boolean

Validate the parsed value using the validate argument passed in on the constructor
Validate the parsed value using the validate argument passed in on the constructor

Definition Classes
ArgOpt
def value: Option[String]

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(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

class StrOpt extends ArgOpt[String] with SingleOpt[String]

Examples

Instance Constructors

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

Type Members

type Elem = 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

var actualLong: Option[String]

var actualShort: Option[Char]

def apply(): String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

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 parseValue(v: String): String

def reset(): Unit

def setValue(arg: String): Unit

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

def toString(): String

def validate(value: String): Boolean

def value: Option[String]

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from SingleOpt[String]

Inherited from ArgOpt[String]

Inherited from OptVal[String]

Inherited from Opt

Inherited from AnyRef

Inherited from Any

Ungrouped