Class

com.twitter.inject

TwitterPrivateModule

Related Doc: package inject

Permalink

abstract class TwitterPrivateModule extends PrivateModule with TwitterBaseModule with ScalaPrivateModule

Linear Supertypes
ScalaPrivateModule, InternalModule[PrivateBinder], TwitterBaseModule, TwitterModuleLifecycle, Logging, util.logging.Logging, TwitterModuleFlags, PrivateModule, Module, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwitterPrivateModule
  2. ScalaPrivateModule
  3. InternalModule
  4. TwitterBaseModule
  5. TwitterModuleLifecycle
  6. Logging
  7. Logging
  8. TwitterModuleFlags
  9. PrivateModule
  10. Module
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TwitterPrivateModule()

    Permalink

Type Members

  1. class BindingBuilder[T] extends ScalaAnnotatedBindingBuilder[T]

    Permalink
    Definition Classes
    InternalModule
  2. class ElementBuilder[T] extends ScalaAnnotatedElementBuilder[T]

    Permalink
    Definition Classes
    ScalaPrivateModule

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def addError(arg0: Message): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  5. final def addError(arg0: Throwable): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  6. final def addError(arg0: String, arg1: <repeated...>[AnyRef]): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  7. def annotatedWith[A <: Annotation](implicit arg0: Manifest[A]): Matcher[AnnotatedElement]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def bind[T](implicit arg0: Manifest[T]): BindingBuilder[T]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  10. final def bind[T](arg0: Class[T]): AnnotatedBindingBuilder[T]

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  11. final def bind[T](arg0: TypeLiteral[T]): AnnotatedBindingBuilder[T]

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  12. final def bind[T](arg0: Key[T]): LinkedBindingBuilder[T]

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  13. final def bindConstant(): AnnotatedConstantBindingBuilder

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  14. def bindInterceptor[I <: MethodInterceptor](classMatcher: Matcher[_ >: Class[_]], methodMatcher: Matcher[_ >: AnnotatedElement])(implicit arg0: Manifest[I]): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  15. final def bindInterceptor(arg0: Matcher[_ >: Class[_]], arg1: Matcher[_ >: Method], arg2: <repeated...>[MethodInterceptor]): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  16. def bindListener(arg0: Matcher[_ >: Binding[_]], arg1: <repeated...>[ProvisionListener]): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  17. def bindListener(arg0: Matcher[_ >: TypeLiteral[_]], arg1: TypeListener): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  18. def bindScope[T <: Annotation](scope: Scope)(implicit arg0: Manifest[T]): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  19. final def bindScope(arg0: Class[_ <: Annotation], arg1: Scope): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  20. final def binder(): PrivateBinder

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  21. def binderAccess: PrivateBinder

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ScalaPrivateModule → InternalModule
  22. def clone(): AnyRef

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

    Permalink

    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)

  24. def configure(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    TwitterPrivateModule → PrivateModule
  25. final def configure(arg0: Binder): Unit

    Permalink
    Definition Classes
    PrivateModule → Module
  26. final def convertToTypes(arg0: Matcher[_ >: TypeLiteral[_]], arg1: TypeConverter): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  27. def createFlag[T](name: String, default: T, help: String, flaggable: Flaggable[T]): Flag[T]

    Permalink

    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
  28. def createKey[T](implicit arg0: Manifest[T]): Key[T]

    Permalink
    Attributes
    protected
    Definition Classes
    TwitterBaseModule
  29. def createMandatoryFlag[T](name: String, help: String, usage: String, flaggable: Flaggable[T]): Flag[T]

    Permalink

    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
  30. final def currentStage(): Stage

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  31. def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

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

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

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  37. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean

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

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

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  44. def expose[T](implicit arg0: Manifest[T]): ElementBuilder[T]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    ScalaPrivateModule
  45. final def expose(arg0: TypeLiteral[_]): AnnotatedElementBuilder

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  46. final def expose(arg0: Class[_]): AnnotatedElementBuilder

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  47. final def expose[T](arg0: Key[T]): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  48. def finalize(): Unit

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

    Permalink

    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.

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

    Permalink

    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.

  51. val flags: ArrayBuffer[Flag[_]]

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

    Permalink

    Additional framework modules to be composed into this module

    Additional framework modules to be composed into this module

    Attributes
    protected[com.twitter.inject]
    Definition Classes
    TwitterBaseModule
  53. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  54. def getMembersInjector[T](implicit arg0: Manifest[T]): MembersInjector[T]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  55. def getMembersInjector[T](arg0: TypeLiteral[T]): MembersInjector[T]

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  56. def getMembersInjector[T](arg0: Class[T]): MembersInjector[T]

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  57. def getProvider[T](implicit arg0: Manifest[T]): Provider[T]

    Permalink
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  58. final def getProvider[T](arg0: Class[T]): Provider[T]

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  59. final def getProvider[T](arg0: Key[T]): Provider[T]

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  60. def hashCode(): Int

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

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

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  66. final def install(arg0: Module): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  67. def isDebugEnabled(marker: Marker): Boolean

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  74. def isTraceEnabled(marker: Marker): Boolean

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  78. final def logger: Logger

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

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

    Permalink

    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]
    Definition Classes
    TwitterBaseModule
  81. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  82. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  83. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  84. final def requestInjection(arg0: Any): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  85. def requestStaticInjection[T]()(implicit arg0: Manifest[T]): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  86. final def requestStaticInjection(arg0: <repeated...>[Class[_]]): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  87. final def requireBinding(arg0: Class[_]): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  88. final def requireBinding(arg0: Key[_]): Unit

    Permalink
    Attributes
    protected[com.google.inject]
    Definition Classes
    PrivateModule
  89. def singletonPostWarmupComplete(injector: Injector): Unit

    Permalink

    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
  90. def singletonShutdown(injector: Injector): Unit

    Permalink

    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
  91. def singletonStartup(injector: Injector): Unit

    Permalink

    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
  92. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  94. def toString(): String

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

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

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  100. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  101. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. def warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

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

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

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging

Inherited from ScalaPrivateModule

Inherited from InternalModule[PrivateBinder]

Inherited from TwitterBaseModule

Inherited from TwitterModuleLifecycle

Inherited from Logging

Inherited from util.logging.Logging

Inherited from TwitterModuleFlags

Inherited from PrivateModule

Inherited from Module

Inherited from AnyRef

Inherited from Any

Ungrouped