Packages

c

com.twitter.inject.app

AbstractApp

abstract class AbstractApp extends App

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractApp
  2. App
  3. Logging
  4. Slf4jBridge
  5. App
  6. Lifecycle
  7. CloseOnceAwaitably
  8. CloseOnceAwaitably0
  9. Awaitable
  10. ClosableOnce
  11. CloseOnce
  12. Closable
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractApp()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final val MinGrace: Duration
    Definition Classes
    App
  5. 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[twitter]
    Definition Classes
    App
  6. def addFrameworkModules(modules: Module*): Unit

    ONLY INTENDED FOR USE BY THE FRAMEWORK.

    ONLY INTENDED FOR USE BY THE FRAMEWORK.

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

    ONLY INTENDED FOR USE BY THE FRAMEWORK.

    ONLY INTENDED FOR USE BY THE FRAMEWORK.

    Attributes
    protected[inject]
    Definition Classes
    App
  8. 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()
  9. def allowUndefinedFlags: Boolean
    Attributes
    protected
    Definition Classes
    App
  10. def args: Array[String]
    Definition Classes
    App
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. 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()
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. final def close(deadline: Time): Future[Unit]
    Definition Classes
    CloseOnce → Closable
  15. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  16. final def close(): Future[Unit]
    Definition Classes
    Closable
  17. final def closeFuture: Future[Unit]
    Attributes
    protected
    Definition Classes
    CloseOnce
  18. final def closeOnExit(closable: Closable): Unit
    Definition Classes
    App
  19. final def closeOnExitLast(closable: Closable): Unit
    Definition Classes
    App
  20. def closeOnce(deadline: Time): Future[Unit]
    Attributes
    protected
    Definition Classes
    App → CloseOnce
  21. 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.

  22. 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.

  23. def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  24. def debug(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  25. def debug(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  26. def debug(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  27. def debugResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  28. def defaultCloseGracePeriod: Duration
    Definition Classes
    App
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  31. def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  32. def error(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  33. def error(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  34. def error(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  35. def errorResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  36. def exitOnError(reason: String, details: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    App
  37. def exitOnError(reason: String): Unit
    Attributes
    protected
    Definition Classes
    App
  38. def exitOnError(throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    App
  39. 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.

  40. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  41. final def flag: app.Flags
    Definition Classes
    App
  42. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def includeGlobalFlags: Boolean
    Attributes
    protected
    Definition Classes
    App
  45. def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  46. def info(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  47. def info(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  48. def info(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  49. def infoResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  50. final def init(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  51. def injector: Injector
    Definition Classes
    App
  52. final def isClosed: Boolean
    Definition Classes
    CloseOnce
  53. def isDebugEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  54. def isDebugEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  55. def isErrorEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  56. def isErrorEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  57. def isInfoEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  58. def isInfoEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. def isReady(implicit permit: CanAwait): Boolean
    Definition Classes
    CloseOnceAwaitably0 → Awaitable
  61. def isTraceEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  62. def isTraceEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  63. def isWarnEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  64. def isWarnEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  65. def javaModules: Collection[Module]

    Production modules from Java.

    Production modules from Java.

    Attributes
    protected
    Definition Classes
    App
  66. 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
  67. def loadModules(): InstalledModules

    ONLY INTENDED FOR USE BY THE FRAMEWORK.

    ONLY INTENDED FOR USE BY THE FRAMEWORK.

    Attributes
    protected[inject]
    Definition Classes
    App
  68. def loadServiceBindings: Seq[Binding[_]]
    Attributes
    protected[this]
    Definition Classes
    App
  69. final def logger: Logger
    Attributes
    protected[this]
    Definition Classes
    Logging
  70. final def loggerName: String
    Attributes
    protected[this]
    Definition Classes
    Logging
  71. def main(): Unit

    DO NOT BLOCK

    DO NOT BLOCK

    Definition Classes
    App
  72. final def main(args: Array[String]): Unit
    Definition Classes
    App
  73. def modules: Seq[Module]

    Production modules.

    Production modules.

    Attributes
    protected
    Definition Classes
    App
    Note

    Java users should prefer javaModules.

  74. def name: String
    Definition Classes
    App
  75. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  76. final def nonExitingMain(args: Array[String]): Unit
    Definition Classes
    App
  77. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  78. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def observe(event: Event)(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    Lifecycle
  80. final def observeFuture(event: Event)(f: Future[Unit]): Future[Unit]
    Attributes
    protected
    Definition Classes
    Lifecycle
  81. def onExit(): Unit

    Called prior to application exiting.

  82. final def onExit(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  83. def onExitLast(): Unit

    Called prior to application exiting after onExit.

  84. final def onExitLast(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  85. def onInit(): Unit

    Called prior to application initialization.

  86. 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
  87. def parseArgs(args: Array[String]): Unit
    Attributes
    protected[this]
    Definition Classes
    App
  88. def postInjectorStartup(): Unit

    Method to be called after injector creation

    Method to be called after injector creation

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

    Called after the main method.

  90. def postWarmup(): Unit

    Method to be called after successful warmup

    Method to be called after successful warmup

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

    Called before the main method.

  93. final def premain(f: ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    App
  94. def ready(timeout: Duration)(implicit permit: CanAwait): AbstractApp.this.type
    Definition Classes
    CloseOnceAwaitably0 → Awaitable
  95. def result(timeout: Duration)(implicit permit: CanAwait): Unit
    Definition Classes
    CloseOnceAwaitably0 → Awaitable
  96. 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
  97. final def runOnExit(runnable: Runnable): Unit
    Attributes
    protected
    Definition Classes
    App
  98. final def runOnExitLast(runnable: Runnable): Unit
    Attributes
    protected
    Definition Classes
    App
  99. lazy val shutdownTimer: Timer
    Attributes
    protected
    Definition Classes
    App
  100. def suppressGracefulShutdownErrors: Boolean
    Attributes
    protected
    Definition Classes
    App
  101. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  102. def toString(): String
    Definition Classes
    AnyRef → Any
  103. def trace(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  104. def trace(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  105. def trace(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  106. def trace(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  107. def traceResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  108. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  109. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  110. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  111. def warmup(): Unit

    Callback method run before postWarmup

    Callback method run before postWarmup

    Attributes
    protected
    Definition Classes
    App
  112. def warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  113. def warn(message: ⇒ Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  114. def warn(marker: Marker, message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  115. def warn(message: ⇒ Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  116. def warnResult[T](message: ⇒ String)(fn: ⇒ T): T
    Attributes
    protected[this]
    Definition Classes
    Logging

Inherited from App

Inherited from Logging

Inherited from Slf4jBridge

Inherited from app.App

Inherited from Lifecycle

Inherited from CloseOnceAwaitably

Inherited from CloseOnceAwaitably0[Unit]

Inherited from Awaitable[Unit]

Inherited from ClosableOnce

Inherited from CloseOnce

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped