AbstractApp

Instance Constructors

new AbstractApp()

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 val MinGrace: Duration

Definition Classes
App
def addFrameworkModule(module: Module): Unit

ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.
Default modules can be overridden in production by overriding methods in your App or Server.
We take special care to make sure the module is not null, since a common bug is overriding the default methods using a val instead of a def

Attributes
protected[com.twitter]
Definition Classes
App
def addFrameworkModules(modules: Module*): Unit

ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.

Attributes
protected[com.twitter]
Definition Classes
App
def addFrameworkOverrideModules(modules: Module*): Unit

ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.

Attributes
protected[com.twitter.inject]
Definition Classes
App
def afterPostWarmup(): Unit

Method to be be called after port warmup
Method to be be called after port warmup

Attributes
protected
Definition Classes
App
Annotations
@Lifecycle()
def allowUndefinedFlags: Boolean

Attributes
protected
Definition Classes
App
def args: Array[String]

Definition Classes
App
final def asInstanceOf[T0]: T0

Definition Classes
Any
def beforePostWarmup(): Unit

Method to be called after successful warmup but before application initialization
Method to be called after successful warmup but before application initialization

Attributes
protected
Definition Classes
App
Annotations
@Lifecycle()
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def close(deadline: Time): Future[Unit]

Definition Classes
CloseOnce
def close(after: Duration): Future[Unit]

Definition Classes
Closable
final def close(): Future[Unit]

Definition Classes
Closable
final def closeFuture: Future[Unit]

Attributes
protected
Definition Classes
CloseOnce
final def closeOnExit(closable: Closable): Unit

Definition Classes
App
final def closeOnExitLast(closable: Closable): Unit

Definition Classes
App
def closeOnce(deadline: Time): Future[Unit]

Attributes
protected
Definition Classes
App → CloseOnce
final def createFlag[T](name: String, default: T, help: String, flaggable: Flaggable[T]): Flag[T]

A Java-friendly method for creating a named Flag.
A Java-friendly method for creating a named Flag.
name
the name of the Flag.
default
a default value for the Flag when no value is given as an application argument.
help
the help text explaining the purpose of the Flag.
returns
the created Flag.
final def createMandatoryFlag[T](name: String, help: String, usage: String, flaggable: Flaggable[T]): Flag[T]

A Java-friendly way to create a "mandatory" Flag.
A Java-friendly way to create a "mandatory" Flag. "Mandatory" flags MUST have a value provided as an application argument (as they have no default value to be used).
name
the name of the Flag.
help
the help text explaining the purpose of the Flag.
usage
a string describing the type of the Flag, i.e.: Integer.
returns
the created Flag.
def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

Attributes
protected
Definition Classes
Logging
def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
def defaultCloseGracePeriod: Duration

Definition Classes
App
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
def exitOnError(reason: String, details: ⇒ String): Unit

Attributes
protected
Definition Classes
App
def exitOnError(reason: String): Unit

Attributes
protected
Definition Classes
App
def exitOnError(throwable: Throwable): Unit

Attributes
protected
Definition Classes
App
def failfastOnFlagsNotParsed: Boolean

<invalid inheritdoc annotation>
<invalid inheritdoc annotation>

Attributes
protected
Definition Classes
App → App
Note
It is HIGHLY recommended that this value remains 'true'. This value SHOULD NOT be changed to 'false' without a very good reason.This method only remains overridable for legacy reasons.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val flag: app.Flags

Definition Classes
App
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
final def init(f: ⇒ Unit): Unit

Attributes
protected
Definition Classes
App
def injector: Injector

Definition Classes
App
final def isClosed: Boolean

Definition Classes
CloseOnce
def isDebugEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isDebugEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isReady(implicit permit: CanAwait): Boolean

Definition Classes
CloseOnceAwaitably0 → Awaitable
def isTraceEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isTraceEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def javaModules: Collection[Module]

Production modules from Java.
Production modules from Java.

Attributes
protected
Definition Classes
App
def javaOverrideModules: Collection[Module]

ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules from Java which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.

Attributes
protected
Definition Classes
App
def loadModules(): InstalledModules

ONLY INTENDED FOR USE BY THE FRAMEWORK.
ONLY INTENDED FOR USE BY THE FRAMEWORK.

Attributes
protected[com.twitter.inject]
Definition Classes
App
def loadServiceBindings: Seq[Binding[_]]

Attributes
protected[this]
Definition Classes
App
final def logger: Logger

Attributes
protected[this]
Definition Classes
Logging
final def loggerName: String

Attributes
protected[this]
Definition Classes
Logging
def main(): Unit

DO NOT BLOCK
DO NOT BLOCK

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

Definition Classes
App
def modules: Seq[Module]

Production modules.
Production modules.

Attributes
protected
Definition Classes
App
Note
Java users should prefer javaModules.
val name: String

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

Definition Classes
AnyRef
final def nonExitingMain(args: Array[String]): Unit

Definition Classes
App
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def onExit(): Unit

Called prior to application exiting.
final def onExit(f: ⇒ Unit): Unit

Attributes
protected
Definition Classes
App
def onExitLast(): Unit

Called prior to application exiting after onExit.
final def onExitLast(f: ⇒ Unit): Unit

Attributes
protected
Definition Classes
App
def onInit(): Unit

Called prior to application initialization.
def overrideModules: Seq[Module]

ONLY INTENDED FOR USE IN TESTING.
ONLY INTENDED FOR USE IN TESTING.
Override modules which redefine production bindings (only use overrideModules during testing) If you think you need this in your main server you are most likely doing something incorrectly.

Attributes
protected
Definition Classes
App
def parseArgs(args: Array[String]): Unit

Attributes
protected[this]
Definition Classes
App
def postInjectorStartup(): Unit

Method to be called after injector creation
Method to be called after injector creation

Attributes
protected
Definition Classes
App
Annotations
@Lifecycle()
def postMain(): Unit

Called after the main method.
def postWarmup(): Unit

Method to be called after successful warmup
Method to be called after successful warmup

Attributes
protected
Definition Classes
App
Annotations
@Lifecycle()
final def postmain(f: ⇒ Unit): Unit

Attributes
protected
Definition Classes
App
def preMain(): Unit

Called before the main method.
final def premain(f: ⇒ Unit): Unit

Attributes
protected
Definition Classes
App
def ready(timeout: Duration)(implicit permit: CanAwait): AbstractApp.this.type

Definition Classes
CloseOnceAwaitably0 → Awaitable
def result(timeout: Duration)(implicit permit: CanAwait): Unit

Definition Classes
CloseOnceAwaitably0 → Awaitable
def run(): Unit

Callback method executed after the injector is created and all lifecycle methods have fully completed.
Callback method executed after the injector is created and all lifecycle methods have fully completed.
The app is signaled as STARTED prior to the execution of this callback as all lifecycle methods have successfully completed.
This method can be used to start long-lived processes that run in separate threads from the main() thread. It is expected that you manage these threads manually, e.g., by using a com.twitter.util.FuturePool.
Any exceptions thrown in this method will result in the app exiting.

Attributes
protected
Definition Classes
App
lazy val shutdownTimer: Timer

Attributes
protected
Definition Classes
App
def suppressGracefulShutdownErrors: Boolean

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

Definition Classes
AnyRef
def time[T](formatStr: String)(func: ⇒ T): T

Attributes
protected
Definition Classes
Logging
def toString(): String

Definition Classes
AnyRef → Any
def trace(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def traceResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
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( ... )
def warmup(): Unit

Callback method run before postWarmup
Callback method run before postWarmup

Attributes
protected
Definition Classes
App
def warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def warnResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging

Related Doc: package app

abstract class AbstractApp extends App

Instance Constructors

new AbstractApp()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final val MinGrace: Duration

def addFrameworkModule(module: Module): Unit

def addFrameworkModules(modules: Module*): Unit

def addFrameworkOverrideModules(modules: Module*): Unit

def afterPostWarmup(): Unit

def allowUndefinedFlags: Boolean

def args: Array[String]

final def asInstanceOf[T0]: T0

def beforePostWarmup(): Unit

def clone(): AnyRef

final def close(deadline: Time): Future[Unit]

def close(after: Duration): Future[Unit]

final def close(): Future[Unit]

final def closeFuture: Future[Unit]

final def closeOnExit(closable: Closable): Unit

final def closeOnExitLast(closable: Closable): Unit

def closeOnce(deadline: Time): Future[Unit]

final def createFlag[T](name: String, default: T, help: String, flaggable: Flaggable[T]): Flag[T]

final def createMandatoryFlag[T](name: String, help: String, usage: String, flaggable: Flaggable[T]): Flag[T]

def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def debug(message: ⇒ Any, cause: Throwable): Unit

def debug(marker: Marker, message: ⇒ Any): Unit

def debug(message: ⇒ Any): Unit

def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

def defaultCloseGracePeriod: Duration

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def error(message: ⇒ Any, cause: Throwable): Unit

def error(marker: Marker, message: ⇒ Any): Unit

def error(message: ⇒ Any): Unit

def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

def exitOnError(reason: String, details: ⇒ String): Unit

def exitOnError(reason: String): Unit

def exitOnError(throwable: Throwable): Unit

def failfastOnFlagsNotParsed: Boolean

def finalize(): Unit

val flag: app.Flags

final def getClass(): Class[_]

def hashCode(): Int

def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def info(message: ⇒ Any, cause: Throwable): Unit

def info(marker: Marker, message: ⇒ Any): Unit

def info(message: ⇒ Any): Unit

def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

final def init(f: ⇒ Unit): Unit

def injector: Injector

final def isClosed: Boolean

def isDebugEnabled(marker: Marker): Boolean

def isDebugEnabled: Boolean

def isErrorEnabled(marker: Marker): Boolean

def isErrorEnabled: Boolean

def isInfoEnabled(marker: Marker): Boolean

def isInfoEnabled: Boolean

final def isInstanceOf[T0]: Boolean

def isReady(implicit permit: CanAwait): Boolean

def isTraceEnabled(marker: Marker): Boolean

def isTraceEnabled: Boolean

def isWarnEnabled(marker: Marker): Boolean

def isWarnEnabled: Boolean

def javaModules: Collection[Module]

def javaOverrideModules: Collection[Module]

def loadModules(): InstalledModules

def loadServiceBindings: Seq[Binding[_]]

final def logger: Logger

final def loggerName: String

def main(): Unit

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

def modules: Seq[Module]

val name: String