com.twitter.inject.TwitterBaseModule.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inject-core_2.11 Show documentation

inject-core

The newest version!

package com.twitter.inject

import com.google.inject.{Key, Module}
import net.codingwell.scalaguice._

/**
 * Guice/twitter.util.Flag integrations usable from both non-private and private Guice modules
 */
trait TwitterBaseModule
  extends TwitterModuleFlags
  with TwitterModuleLifecycle {

  /**
   * 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.
   */
  protected[inject] def modules: Seq[Module] = Seq()

  /**
   * Additional framework modules to be composed into this module
   */
  protected[inject] def frameworkModules: Seq[Module] = Seq()

  protected def createKey[T: Manifest] = {
    Key.get(typeLiteral[T])
  }
}