Flags

A simple flags implementation. We support only two formats:

for flags with optional values (booleans): -flag, -flag=value for flags with required values: -flag[= ]value

That's it. These can be parsed without ambiguity.

There is no support for mandatory arguments: That is not what flags are for.

Flags' apply adds a new flag to to the flag set, so it is idiomatic to assign instances of Flags to a singular flag:

val flag = new Flags("myapp")
val i = flag("i", 123, "iteration count")

Global flags, detached from a particular Flags instance, but accessible to all, are defined by com.twitter.app.GlobalFlag.

Linear Supertypes

AnyRef, Any

Instance Constructors

new Flags(argv0: String)
new Flags(argv0: String, includeGlobal: Boolean)

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 add(f: Flag[_]): Unit
def apply[T](name: String, help: String)(implicit _f: Flaggable[T], m: Manifest[T]): Flag[T]
def apply[T](name: String, default: ⇒ T, help: String)(implicit arg0: Flaggable[T]): Flag[T]
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()
def formattedFlagValues(includeGlobal: Boolean = this.includeGlobal, classLoader: ClassLoader = this.getClass.getClassLoader): (Iterable[String], Iterable[String])

Formats all the values of all flags known to this instance into a format suitable for logging
Formats all the values of all flags known to this instance into a format suitable for logging
includeGlobal
see getAll above
classLoader
see getAll above
returns
all the flag values in alphabetical order, grouped into (set, unset)
def formattedFlagValuesString(includeGlobal: Boolean = this.includeGlobal, classLoader: ClassLoader = this.getClass.getClassLoader): String

Creates a string containing all the values of all flags known to this instance into a format suitable for logging
Creates a string containing all the values of all flags known to this instance into a format suitable for logging
includeGlobal
set getAll above
classLoader
set getAll above
returns
A string suitable for logging
def getAll(includeGlobal: Boolean = this.includeGlobal, classLoader: ClassLoader = this.getClass.getClassLoader): Iterable[Flag[_]]

Get all the flags known to this this Flags instance
Get all the flags known to this this Flags instance
includeGlobal
defaults to the includeGlobal settings of this instance
classLoader
needed to find global flags, defaults to this instance's class loader
returns
all the flags known to this this Flags instance
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parse(args: Array[String], undefOk: Boolean = false): Seq[String]
def reset(): Unit
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def usage: String
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 Flags extends AnyRef

Instance Constructors

new Flags(argv0: String)

new Flags(argv0: String, includeGlobal: 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

def add(f: Flag[_]): Unit

def apply[T](name: String, help: String)(implicit _f: Flaggable[T], m: Manifest[T]): Flag[T]

def apply[T](name: String, default: ⇒ T, help: String)(implicit arg0: Flaggable[T]): Flag[T]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formattedFlagValues(includeGlobal: Boolean = this.includeGlobal, classLoader: ClassLoader = this.getClass.getClassLoader): (Iterable[String], Iterable[String])

def formattedFlagValuesString(includeGlobal: Boolean = this.includeGlobal, classLoader: ClassLoader = this.getClass.getClassLoader): String

def getAll(includeGlobal: Boolean = this.includeGlobal, classLoader: ClassLoader = this.getClass.getClassLoader): Iterable[Flag[_]]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse(args: Array[String], undefOk: Boolean = false): Seq[String]

def reset(): Unit

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

def toString(): String

def usage: String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped