Getting started with ConfigureMe
To get started with ConfigureMe you need three things. First you need something to configure which we call configurable. Than you need something to configure your configurable with, that'll be the configuration. And finally you need to ask the ConfigurationManager to configure your configurable with your configuration somewhere in your code.
Selling hamburgers
Lets get concrete. Imagine you are opening a fast food restaurant. To make it real fast you offer just one product. Since you are a great developer you are writing the software for your cash box yourself, and you want the price to come from a configuration file to be able to react to the financial crises fast.
Creating a configurable
First of all we need an object to store the prices, our configurable object:
package pricing; import org.configureme.annotations.Configure; import org.configureme.annotations.ConfigureMe; @ConfigureMe public class Pricing { /** * The local currency. */ @Configure private String currency; /** * The price of the BigPack in local currency. */ @Configure private float price; public void setCurrency(String aCurrency){ currency = aCurrency; } public void setPrice(float aPrice){ price = aPrice; } /** * Returns the price for the customer. */ public String getProductPrice(){ return price+" "+currency; } }
Our configurable is nothing more than a JavaBean which an additional method: getProductPrice_ which return the price we have to show the customer. Since we are planing to get international pretty soon, we introduced a special field for the currency, to be able to operate in different countries.
Creating a configuration file.
Now that we have a configurable we need a configuration.
{ price: 3.57, currency: "$", }
Note that the default name resolution is deduced from the class name, but you can change it Annotations#ConfigureMe.