jconf's Introduction

JConf

JConf is a easy and light library for config module in Java or Groovy applications.

Currently this library support JSON, YAML, INI, XML, Properties

Visit http://jconf.readthedocs.org/en/latest/ for more detail info

Usage

For maven

add dependency

    <dependency>
        <groupId>com.github.nateriver520</groupId>
        <artifactId>jconf</artifactId>
        <version>0.2.1</version>
    </dependency>

Example

if I want to load a json config like this:

    {
      "person": {
        "name": "Guillaume",
        "age": 33,
        "score": 93.3,
        "id": 110000012129,
        "pets": [
          "dog",
          "cat"
        ],
        "is_admin": true
      },
      "work": "cs"
    }

Here is example

    // support yaml, ini
    // also support load from text or stream
    def conf = new Config('conf.json')

    conf.getString("person.name") // "Guillaume"
    conf.getInteger("person.age") // 33
    conf.getDouble("person.score") // 93.3
    conf.getFloat("person.score") // 93.3
    conf.getLong("person.id") // 110000012129
    conf.getBoolean("person.is_admin") // true
    conf.getList("person.pets") // ["dog", "cat"]
    conf.getString("work") //"cs"

    // default value
    // don't exist so return default value: "[email protected]"
    conf.getString("persion.mail", "[email protected]")

    // use other separator
    // set separator with ::
    conf.separator = "::"

    conf.getString("person::name") // "Guillaume"

    // we also can set config manually
    conf.set("person::name", "jack")
    conf.get("person::name") // "jack"

    // delete conf
    conf.del("person::name")
    conf.exist("person::name") // false

    // we can reset config to the origin version without change
    conf.reset()