Packages

c

com.twitter.inject

TwitterPrivateModule

abstract class TwitterPrivateModule extends PrivateModule with TwitterBaseModule with ScalaPrivateModule

A module whose configuration information is hidden from its environment by default. Only bindings that are explicitly exposed will be available to other modules and to the users of the injector. This module may expose the bindings it creates and the bindings of the modules it installs.

Note

Calling com.google.inject.PrivateModule#install in the configure() method is not supported. Please set TwitterBaseModule.modules (or TwitterBaseModule.javaModules) to a non-empty list instead.

See also

com.google.inject.PrivateModule

Writing Modules in Finatra

Linear Supertypes
ScalaPrivateModule, InternalModule[PrivateBinder], TwitterBaseModule, TwitterModuleLifecycle, 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. TwitterModuleFlags
  8. PrivateModule
  9. Module
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TwitterPrivateModule()

Type Members

  1. class BindingBuilder[T] extends ScalaAnnotatedBindingBuilder[T]
    Definition Classes
    InternalModule
  2. class ElementBuilder[T] extends ScalaAnnotatedElementBuilder[T]
    Definition Classes
    ScalaPrivateModule

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 def addError(arg0: Message): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  5. final def addError(arg0: Throwable): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  6. final def addError(arg0: String, arg1: <repeated...>[AnyRef]): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
    Annotations
    @transient()
  7. def annotatedWith[A <: Annotation](implicit arg0: ClassTag[A]): Matcher[AnnotatedElement]
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def bind[T](implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): BindingBuilder[T]
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  10. final def bind[T <: AnyRef](arg0: Class[T]): AnnotatedBindingBuilder[T]
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  11. final def bind[T <: AnyRef](arg0: TypeLiteral[T]): AnnotatedBindingBuilder[T]
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  12. final def bind[T <: AnyRef](arg0: Key[T]): LinkedBindingBuilder[T]
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  13. final def bindConstant(): AnnotatedConstantBindingBuilder
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  14. def bindInterceptor[I <: MethodInterceptor](classMatcher: Matcher[_ >: Class[_]], methodMatcher: Matcher[_ >: AnnotatedElement])(implicit arg0: ClassTag[I]): Unit
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  15. final def bindInterceptor(arg0: Matcher[_ >: Class[_ <: AnyRef] <: AnyRef], arg1: Matcher[_ >: Method <: AnyRef], arg2: <repeated...>[MethodInterceptor]): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
    Annotations
    @transient()
  16. def bindListener(arg0: Matcher[_ >: Binding[_ <: AnyRef] <: AnyRef], arg1: <repeated...>[ProvisionListener]): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
    Annotations
    @transient()
  17. def bindListener(arg0: Matcher[_ >: TypeLiteral[_ <: AnyRef] <: AnyRef], arg1: TypeListener): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  18. def bindScope[T <: Annotation](scope: Scope)(implicit arg0: ClassTag[T]): Unit
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  19. final def bindScope(arg0: Class[_ <: Annotation], arg1: Scope): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  20. final def binder(): PrivateBinder
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  21. def binderAccess: PrivateBinder
    Attributes
    protected[this]
    Definition Classes
    ScalaPrivateModule → InternalModule
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  23. def configure(): Unit

    Configures a com.google.inject.Binder via the exposed methods.

    Configures a com.google.inject.Binder via the exposed methods. A default implementation is provided such that extensions using only @Provider-annotated methods do not need to implement an empty TwitterModule.configure() method.

    Attributes
    protected
    Definition Classes
    TwitterPrivateModule → PrivateModule
    See also

    com.google.inject.PrivateModule#configure

    com.google.inject.PrivateModule#configure()

  24. final def configure(arg0: Binder): Unit
    Definition Classes
    PrivateModule → Module
  25. final def convertToTypes(arg0: Matcher[_ >: TypeLiteral[_ <: AnyRef] <: AnyRef], arg1: TypeConverter): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  26. 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.

    Definition Classes
    TwitterModuleFlags
  27. 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.

    Definition Classes
    TwitterModuleFlags
  28. final def currentStage(): Stage
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  29. def debug(marker: Marker, message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  30. def debug(message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  31. def debug(marker: Marker, message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  32. def debug(message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  33. def debugResult[T](message: => String)(fn: => T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  34. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  36. def error(marker: Marker, message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  37. def error(message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  38. def error(marker: Marker, message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  39. def error(message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  40. def errorResult[T](message: => String)(fn: => T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  41. def expose[T](implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): ElementBuilder[T]
    Attributes
    protected[this]
    Definition Classes
    ScalaPrivateModule
  42. final def expose(arg0: TypeLiteral[_ <: AnyRef]): AnnotatedElementBuilder
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  43. final def expose(arg0: Class[_ <: AnyRef]): AnnotatedElementBuilder
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  44. final def expose[T <: AnyRef](arg0: Key[T]): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  45. def failfastOnFlagsNotParsed: Boolean

    This is akin to the c.t.inject.app.App#failfastOnFlagsNotParsed and serves a similar purpose but for new com.twitter.app.Flag instances created in this TwitterModule.

    This is akin to the c.t.inject.app.App#failfastOnFlagsNotParsed and serves a similar purpose but for new com.twitter.app.Flag instances created in this TwitterModule. The value is 'true' by default. This is to ensure that the value of a com.twitter.app.Flag instance created in this TwitterModule cannot be incorrectly accessed before the application has parsed any passed command line input. This mirrors the framework default for com.twitter.inject.app.App#failfastOnFlagsNotParsed for Flag instances created within the application container.

    returns

    a Boolean indicating if com.twitter.app.Flag instances created in this TwitterModule should be set with com.twitter.app.Flag.failFastUntilParsed set to 'true' or 'false'. Default: 'true'.

    Attributes
    protected[this]
    Definition Classes
    TwitterModuleFlags
    Note

    This value SHOULD NOT be changed to 'false' without a very good reason.

  46. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  47. final 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.

    Definition Classes
    TwitterModuleFlags
    Note

    Java users: see the more Java-friendly createFlag or createMandatoryFlag.

  48. final 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.

    Definition Classes
    TwitterModuleFlags
    Note

    Java users: see the more Java-friendly createFlag or createMandatoryFlag.

  49. val flags: ArrayBuffer[Flag[_]]
    Attributes
    protected[inject]
    Definition Classes
    TwitterModuleFlags
  50. def frameworkModules: Seq[Module]

    Additional framework modules to be composed into this module.

    Additional framework modules to be composed into this module.

    Attributes
    protected[inject]
    Definition Classes
    TwitterBaseModule
  51. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  52. def getMembersInjector[T](implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T]): MembersInjector[T]
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  53. def getMembersInjector[T <: AnyRef](arg0: TypeLiteral[T]): MembersInjector[T]
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  54. def getMembersInjector[T <: AnyRef](arg0: Class[T]): MembersInjector[T]
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  55. def getProvider[T](implicit arg0: ClassTag[T]): Provider[T]
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  56. final def getProvider[T <: AnyRef](arg0: Class[T]): Provider[T]
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  57. final def getProvider[T <: AnyRef](arg0: Key[T]): Provider[T]
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  58. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  59. def info(marker: Marker, message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  60. def info(message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  61. def info(marker: Marker, message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  62. def info(message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  63. def infoResult[T](message: => String)(fn: => T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  64. final def install(arg0: Module): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  65. def isDebugEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  66. def isDebugEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  67. def isErrorEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  68. def isErrorEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  69. def isInfoEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  70. def isInfoEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  71. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  72. def isTraceEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  73. def isTraceEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  74. def isWarnEnabled(marker: Marker): Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  75. def isWarnEnabled: Boolean
    Attributes
    protected[this]
    Definition Classes
    Logging
  76. def javaModules: Collection[Module]

    Additional modules to be composed into this module from Java

    Additional modules to be composed into this module from Java

    Attributes
    protected[inject]
    Definition Classes
    TwitterBaseModule
  77. final def logger: Logger
    Attributes
    protected[this]
    Definition Classes
    Logging
  78. final def loggerName: String
    Attributes
    protected[this]
    Definition Classes
    Logging
  79. def modules: Seq[Module]

    Additional modules to be composed into this module.

    Additional modules to be composed into this module. This list of modules is generally used instead of the TwitterModule.install method to properly support the TwitterModuleLifecycle for TwitterModule instances.

    Attributes
    protected[inject]
    Definition Classes
    TwitterBaseModule
    Note

    Module) can still be used for non-TwitterModule 1 instances, and is sometimes preferred due to install being deferred until after flag parsing occurs.

    ,

    Java users should prefer javaModules.

  80. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  81. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  82. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  83. def onExit(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.

    onExit {
  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

    => Unit)

    com.twitter.util.Awaitable

    com.twitter.util.Closable

  84. final def requestInjection(arg0: AnyRef): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  85. def requestStaticInjection[T]()(implicit arg0: ClassTag[T]): Unit
    Attributes
    protected[this]
    Definition Classes
    InternalModule
  86. final def requestStaticInjection(arg0: <repeated...>[Class[_ <: AnyRef]]): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
    Annotations
    @transient()
  87. final def requireBinding(arg0: Class[_ <: AnyRef]): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  88. final def requireBinding(arg0: Key[_ <: AnyRef]): Unit
    Attributes
    protected[google.inject]
    Definition Classes
    PrivateModule
  89. 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[inject]
    Definition Classes
    TwitterModuleLifecycle
  90. 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[inject]
    Definition Classes
    TwitterModuleLifecycle
  91. 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[inject]
    Definition Classes
    TwitterModuleLifecycle
  92. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  93. def toString(): String
    Definition Classes
    AnyRef → Any
  94. def trace(marker: Marker, message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  95. def trace(message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  96. def trace(marker: Marker, message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  97. def trace(message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  98. def traceResult[T](message: => String)(fn: => T): T
    Attributes
    protected[this]
    Definition Classes
    Logging
  99. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  100. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  101. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  102. def warn(marker: Marker, message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  103. def warn(message: => Any, cause: Throwable): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  104. def warn(marker: Marker, message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  105. def warn(message: => Any): Unit
    Attributes
    protected[this]
    Definition Classes
    Logging
  106. def warnResult[T](message: => String)(fn: => T): T
    Attributes
    protected[this]
    Definition Classes
    Logging

Inherited from ScalaPrivateModule

Inherited from InternalModule[PrivateBinder]

Inherited from TwitterBaseModule

Inherited from TwitterModuleLifecycle

Inherited from util.logging.Logging

Inherited from TwitterModuleFlags

Inherited from PrivateModule

Inherited from Module

Inherited from AnyRef

Inherited from Any

Ungrouped