hcura/kotlin-guice

Guice DSL extensions for Kotlin

kotlin-guice

Guice extensions for Kotlin. This provides extension wrappers and extension methods for providing a better Guice DSL experience from Kotlin. It takes advantage of reified types to reduce class references like bind(MyResource::class.java) to bind<MyResource>().

Download

Download the latest JAR via Maven:

<dependency>
  <groupId>com.authzee.kotlinguice4</groupId>
  <artifactId>kotlin-guice</artifactId>
  <version>1.0.0</version>
</dependency>

or Gradle:

compile 'com.authzee.kotlinguice4:kotlin-guice:1.0.0'

Getting Started

KotlinModule

Use KotlinModule for Guice modules instead of AbstractModule to take advantage of the enhanced Kotlin Guice DSL.

import com.authzee.kotlinguice4.KotlinModule

class MyModule : KotlinModule() {
    override fun configure() {
        bind<Service>().to<ServiceImpl>().`in`<Singleton>()
        bind<PaymentService<CreditCard>>().to<CreditCardPaymentService>()
        bind<CreditCardProcessor>().annotatedWith<PayPal>().to<PayPalCreditCardProcessor>()
    }
}

The KotlinPrivateModule can also be used if only some bindings need to be exposed.

import com.authzee.kotlinguice4.KotlinPrivateModule

class MyPrivateModule : KotlinPrivateModule() {
    override fun configure() {
        bind<Service>().to<ServiceImpl>().`in`<Singleton>()
        bind<PaymentService<CreditCard>>().to<CreditCardPaymentService>()
        bind<CreditCardProcessor>().annotatedWith<PayPal>().to<PayPalCreditCardProcessor>()
        
        expose<PaymentService<CreditCard>>()
    }
}

Injector

The Guice injector has been enhanced with extension methods to make direct use of the injector better from Kotlin.

import com.authzee.kotlinguice4.annotatedKey
import com.authzee.kotlinguice4.getInstance

fun main(args: Array<String>) {
  val injector = Guice.createInjector(new MyModule(), new MyPrivateModule())
  
  val paymentService = injector.getInstance<PaymentService<CreditCard>>()
  
  // Use the annotatedKey to get an annotated instance
  val payPalProcessor = injector.getInstance(annotatedKey<CreditCardProcessor, PayPayl>())
}

Key and TypeLiteral

Package level functions are included to enhance creating Key and TypeLiteral instances from kotlin.

import com.authzee.kotlinguice4.annotatedKey
import com.authzee.kotlinguice4.key
import com.authzee.kotlinguice4.typeLiteral

val key = key<String>()
val annotatedKey = annotatedKey<String, SomeAnnotation>()
val sameAnnotatedDifferentKey = annotatedKey.getType<Long>()

val listType = typeLiteral<PaymentService<CreditCrd>>()

Multibindings

Download

Download the latest JAR via Maven:

<dependency>
  <groupId>com.authzee.kotlinguice4</groupId>
  <artifactId>kotlin-guice-multibindings</artifactId>
  <version>1.0.0</version>
</dependency>

or Gradle:

compile 'com.authzee.kotlinguice4:kotlin-guice-multibindings:1.0.0'

Usage

val multibinder = KotlinMultibinder.newSetBinder<Snack>(kotlinBinder)
multibinder.addBinding().to<Twix>()

val mapbinder = KotlinMapBinder.newMapBinder<String, Snack>(kotlinBinder)
mapbinder.addBinding("twix").to<Twix>()

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.