TwitterBaseModule

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 def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def closeOnExit(f: ⇒ Unit): Unit

Collects functions over a com.twitter.util.Closables.
Collects functions over a com.twitter.util.Closables. These functions will be passed to the application onExit function to be executed on graceful shutdown of the application.
f
A Function0 which returns Unit. It is expected that this function encapsulates awaiting on a com.twitter.util.Closable that the application would like to ensure is closed upon graceful shutdown.
```
closeOnExit {
  val closable = ...
  Await.result(
    closable.close(after: Duration), timeout: Duration)
  }
```
Attributes
protected
Definition Classes
TwitterModuleLifecycle
Note
It is expected that the passed function is a function over a com.twitter.util.Closable.
See also
com.twitter.util.Closable
com.twitter.util.Awaitable
=> Unit)
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.

Attributes
protected
Definition Classes
TwitterModuleFlags
def createKey[T](implicit arg0: Manifest[T]): Key[T]

Attributes
protected
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.

Definition Classes
TwitterModuleFlags
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
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 finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flag[T](name: String, help: String)(implicit arg0: Flaggable[T], arg1: Manifest[T]): Flag[T]

Create a "mandatory" flag and add it to this Module's flags list."Mandatory" flags MUST have a value provided as an application argument (as they have no default value to be used).
Create a "mandatory" flag and add it to this Module's flags list."Mandatory" flags MUST have a value provided as an application argument (as they have no default value to be used).
T
must be a Flaggable type.
name
the name of the Flag.
help
the help text explaining the purpose of the Flag.
returns
the created Flag.

Attributes
protected
Definition Classes
TwitterModuleFlags
Note
Java users: see the more Java-friendly createFlag or createMandatoryFlag.
def flag[T](name: String, default: T, help: String)(implicit arg0: Flaggable[T]): Flag[T]

Create a Flag and add it to this Module's flags list.
Create a Flag and add it to this Module's flags list.
T
must be a Flaggable type.
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.

Attributes
protected
Definition Classes
TwitterModuleFlags
Note
Java users: see the more Java-friendly createFlag or createMandatoryFlag.
val flags: ArrayBuffer[Flag[_]]

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleFlags
def frameworkModules: Seq[Module]

Additional framework modules to be composed into this module
Additional framework modules to be composed into this module

Attributes
protected[com.twitter.inject]
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
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 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
final def logger: Logger

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

Attributes
protected[this]
Definition Classes
Logging
def modules: Seq[Module]

Additional modules to be composed into this module
Additional modules to be composed into this module
NOTE: This Seq of modules is generally used instead of the standard Guice 'install' method so that TwitterModules with flag definitions can be supported.
However, AbstractModule.install can still be used for non-TwitterModules, and is sometimes preferred due to install being deferred until after flag parsing occurs.

Attributes
protected[com.twitter.inject]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def singletonPostWarmupComplete(injector: Injector): Unit

Invoke after external ports are bound and any clients are resolved
Invoke after external ports are bound and any clients are resolved
This method should only get singleton instances from the injector.

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleLifecycle
def singletonShutdown(injector: Injector): Unit

Invoked on graceful shutdown of the application.
Invoked on graceful shutdown of the application.
This method should only get singleton instances from the injector.

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleLifecycle
def singletonStartup(injector: Injector): Unit

Invoked after the injector is started.
Invoked after the injector is started.
This method should only get singleton instances from the injector.

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleLifecycle
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 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 inject

trait TwitterBaseModule extends TwitterModuleFlags with TwitterModuleLifecycle

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def closeOnExit(f: ⇒ Unit): Unit

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

def createKey[T](implicit arg0: Manifest[T]): Key[T]

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

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 finalize(): Unit

def flag[T](name: String, help: String)(implicit arg0: Flaggable[T], arg1: Manifest[T]): Flag[T]

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

val flags: ArrayBuffer[Flag[_]]

def frameworkModules: Seq[Module]

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

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 isTraceEnabled(marker: Marker): Boolean

def isTraceEnabled: Boolean

def isWarnEnabled(marker: Marker): Boolean

def isWarnEnabled: Boolean

final def logger: Logger

final def loggerName: String

def modules: Seq[Module]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def singletonPostWarmupComplete(injector: Injector): Unit

def singletonShutdown(injector: Injector): Unit

def singletonStartup(injector: Injector): Unit

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

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

def toString(): String

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

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

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

def trace(message: ⇒ Any): Unit

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

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

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

def warn(message: ⇒ Any): Unit

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

Inherited from TwitterModuleLifecycle

Inherited from Logging

Inherited from util.logging.Logging

Inherited from TwitterModuleFlags

Inherited from AnyRef

Inherited from Any