Skip to content
Allows Guice Injection of configuration values from Typesafe Config
Branch: master
Clone or download
Latest commit 95e383c Jul 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Merge branch 'master' of https://github.com/racc/typesafeconfig-guice Jul 22, 2018
.gitignore Initial commit May 27, 2015
.travis.yml Really make Travis happy again Jun 12, 2015
LICENSE Update doco. Jun 10, 2015
README.md Prepare for release 0.1.0 Jul 22, 2018
build.gradle Prepare for release 0.1.0 Jul 22, 2018

README.md

Typesafe Config Guice

Allows Guice to @Inject configuration values into your application derived from Typesafe Config.

Build Status

Available on Maven Central.

<dependency>
    <groupId>com.github.racc</groupId>
    <artifactId>typesafeconfig-guice</artifactId>
    <version>0.1.0</version>
</dependency>

Quickstart

Step 1:

Annotate configuration injection points (Constructors, Providers, Provider methods, Setter methods, Fields) with @TypesafeConfig("config.path.key")

Step 2:

Bootstrap your application with Guice and the TypesafeConfigModule. Configuration values annotated with @TypesafeConfig will be scanned for on the classpath, and then bound from your supplied Typesafe Config file.

Config config = ConfigFactory.load("config.conf");
Injector injector = Guice.createInjector(
	TypesafeConfigModule.fromConfigWithPackage(config, "com.my.package");
	// ... Add your other modules here
);

Step 3:

Profit!

Features

  • Plain Old Java Objects which follow JavaBean conventions (zero-args constructor, getters and setters) can be injected.
  • Supports injections of java.time.Duration objects with config parameters defined as "10 seconds", "10 minutes" etc.
  • Supports injections of com.typesafe.config.ConfigMemorySize objects with config parameters defined as "512k" or "2M" etc.
  • Supports injections of boolean, where the matching config parameter can be "true", "false", "yes" or "no".
  • Supports injections of List types of primitives: boolean, int, double, long, string, java.time.Duration, com.typesafe.config.ConfigMemorySize
  • Supports injections of java.util.Map<String, Object>
  • Supports injections of POJO Lists.
  • Extensive test coverage

AUTHOR

Jason Then

Any comments and feedback appreciated!

LICENSE

Copyright 2018 Jason Then

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.

You can’t perform that action at this time.