App

A composable application trait that includes flag parsing as well as basic application lifecycle (pre- and post- main). Flag parsing is done via com.twitter.app.Flags, an instance of which is defined in the member flag. Applications should be constructed with modularity in mind, and common functionality should be extracted into mixins.

object MyApp extends App {
val n = flag("n", 100, "Number of items to process")

def main() {
  for (i <- 0 until n()) process(i)
}
}

Note that a missing main is OK: mixins may provide behavior that does not require defining a custom main method.

Linear Supertypes

AnyRef, Any

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 args: Array[String]

The remaining, unparsed arguments
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()
val flag: Flags

The com.twitter.app.Flags instance associated with this application
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def init(f: ⇒ Unit): Unit

Invoke f before anything else (including flag parsing).
Invoke f before anything else (including flag parsing).

Attributes
protected
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def main(args: Array[String]): Unit
val name: String

The name of the application, based on the classname
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onExit(f: ⇒ Unit): Unit

Create a new shutdown hook.
Create a new shutdown hook. As such, these will be started in no particular order and run concurrently.

Attributes
protected
def postmain(f: ⇒ Unit): Unit

Invoke f after the user's main has exited.
Invoke f after the user's main has exited.

Attributes
protected
def premain(f: ⇒ Unit): Unit

Invoke f right before the user's main is invoked.
Invoke f right before the user's main is invoked.

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

Definition Classes
AnyRef
def toString(): String

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

trait App extends AnyRef

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 args: Array[String]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val flag: Flags

final def getClass(): Class[_]

def hashCode(): Int

def init(f: ⇒ Unit): Unit

final def isInstanceOf[T0]: Boolean

final def main(args: Array[String]): Unit

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def onExit(f: ⇒ Unit): Unit

def postmain(f: ⇒ Unit): Unit

def premain(f: ⇒ Unit): Unit

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

def toString(): 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