At first you create a class which represents the Java Properties files as an object. In this example, this class will have the name "configuration".
The class needs the @ConfigFile annotation with a path as parameter. The path can be relative or absolute in the file system, but the path must exist, otherwise a "PathNotFoundException" will appear. The library will recognize the @ConfigFile annotation.
All class members you want to save in the properties file, must be annotated with @ConfigProperty, additional "getter" and "setter" must be added.
import com.laurencetrippen.jpg.ConfigFile;
import com.laurencetrippen.jpg.ConfigProperty;
@ConfigFile(path = "C:/config.properties")
public class Configuration {
@ConfigProperty
private int port;
@ConfigProperty
private String ip;
@ConfigProperty
private float timeout;
@ConfigProperty
private double delay;
@ConfigProperty
private boolean lazyLoading;
public int getPort() {
return port;
}
public void setPort(int port) {
this.port = port;
}
public String getIp() {
return ip;
}
public void setIp(String ip) {
this.ip = ip;
}
public float getTimeout() {
return timeout;
}
public void setTimeout(float timeout) {
this.timeout = timeout;
}
public double getDelay() {
return delay;
}
public void setDelay(double delay) {
this.delay = delay;
}
public boolean isLazyLoading() {
return lazyLoading;
}
public void setLazyLoading(boolean lazyLoading) {
this.lazyLoading = lazyLoading;
}
}
To use and manage the configuration class, you must instantiate a ConfigManager. The ConfigManager class is a generic class that requires the configuration class as a parameter. Also the constructor of the ConfigMananger class needs the class type of the desired configuration class.
After the creation of the "ConfigManager"- object, you need to invoke the generateConfig() method to generate the Java properties file in the filesystem.
After this you can load the properties file in the represtional object which we defined as Configuration class in this example.
With the represtional object you can manipulate the data with getters and setter. Now you can save the data using the save() method of the ConfigManager.
import com.laurencetrippen.jpg.ConfigManager;
import com.laurencetrippen.jpg.exception.ConfigFileAlreadyExistException;
import com.laurencetrippen.jpg.exception.ConfigFileNotDefinedException;
import com.laurencetrippen.jpg.exception.ConfigFileNotExistException;
import com.laurencetrippen.jpg.exception.PathNotExistException;
public class Tester {
public static void main(String[] args) throws ConfigFileNotDefinedException, PathNotExistException {
ConfigManager<Configuration> cm = new ConfigManager<>(Configuration.class);
try {
cm.generateConfig(ConfigManager.GenerationMode.NO_OVERRIDE);
} catch (ConfigFileAlreadyExistException e) {
e.printStackTrace();
}
Configuration cfg = null;
try {
cfg = cm.load();
cfg.setPort(880);
cfg.setIp("255.255.255.255");
cfg.setTimeout(20.2f);
cfg.setDelay(20.4054);
cfg.setLazyLoading(true);
} catch (ConfigFileNotExistException e) {
e.printStackTrace();
}
cm.save(cfg);
}
}