I never liked to create “wrapper” classes for properties files. Do you know… those classes like:

public class MyAppConfig {
    private static Properties p = ...;

    public static String serverName() {
        return p.getProperty("server.name");
    }

    public static int serverPort() {
        return Integer.parseInt(p.getProperty("server.port"));
    }

    ....
}

There’s nothing really bad about those classes. Only that they don’t do actually anything useful; plus, you need to keep things in sync with the properties file associated.

So, I always preferred to directly use Properties.getProperty() and pass a config properties to objects:

   
public class MyBusinessClass {
    private final Properties conf;
    public MyBusinessClass(..., Properties conf) {
        this.conf = conf;
    }    

    public void doSomething() {
        String serverName = conf.getProperty("server.name");
        int serverPort = Integer.parseInt(conf.getProperty("server.port"));
    }
}

99% of the times, you need a configuration setting in a single point. So that’s good enough, and I don’t have to write (and keep in sync) a class that I can spare.

But… what about this?

public interface MyAppConfig extends Config {

    @DefaultValue("foobar.com")
    @Key("server.name");
    String serverName();

    @DefaultValue("80");
    @Key("server.port");
    int serverPort();
    ...
}

Add to this, a smart -annotation based- configuration loading:

@Sources({"file:~/.myapp.config", "file:/etc/myapp.config", "classpath:foo/bar/baz.properties"})
public interface MyAppConfig extends Config {
...

And a simple instantiation:

    MyAppConfig conf = ConfigFactory.create(MyAppConfig.class);

And you have OWNER. A little configuration framework based on Java properties.

BSD license.
Credits to Google GWT, that does similar things with i18n.


5 Responses to “Introducing OWNER, a tiny framework for Java Properties files.”  

  1. 1 Filippo

    Excellent!
    Hopefully I can be one of the first users, rather than rewriting the same boring code every time!

  2. 2 Luigi

    Let me know how it goes. I am planning to submit the jars to Maven Central asap; in 1.1-SNAPSHOT I already removed commons-lang dependency.

  3. 3 Shamim

    Smart and compact, nice work

  4. 4 Feaa

    Thank you, kind of hard to find a library like this these days, i stumbled on it accidentally (maybe i wasn;t looking good enough though), most of the people either go the usual way or hack one depending on their needs or yet again… use the one that comes with the framework. Good job and Thank you!:)

  1. 1 Owner 1.0.3 what’s new? Part 1: variable expansion - NewInstance


Leave a Reply

XHTML: You can use these tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>


Current day month ye@r *


Calendar

December 2012
M T W T F S S
« Nov   Feb »
 12
3456789
10111213141516
17181920212223
24252627282930
31  

Follow me

twitter flickr LinkedIn feed

Subscribe by email

Enter your email address:

Archives


Categories

Tag Cloud


Listening