ultraq/preferences

A simplified and typesafe entry point to the Java Preferences API (java.util.prefs)

Preferences

A simplified and typesafe entry point to the Java Preferences API (java.util.prefs). I wrote this library out of my wish to use the then-new Java 5 feature of enum's as keys for preference values instead of String constants like most people were doing before Java 5 days.

Installation

Minimum of Java 8 required.

For Maven and Maven-compatible dependency managers

Add a dependency to your project with the following co-ordinates:

• GroupId: nz.net.ultraq.preferences
• ArtifactId: preferences
• Version: 3.1.0

Check the project releases for a list of available versions. Each release page also includes a downloadable JAR if you want to manually add it to your project classpath.

Usage

Implement enums that extend from UserPreference or SystemPreference to create user/system preferences respectively. Then, use those enum values over an instance of nz.net.ultraq.preferences.Preferences to load/save the relevant preferences. eg:

public enum MyPreferences implements UserPreference {

  WINDOW_WIDTH  (800),
  WINDOW_HEIGHT (600);

  public final Object defaultValue;

  MyPreferences(Object defaultValue) {
    this.defaultValue = defaultValue;
  }

  @Override
  public Object getDefaultValue() {
    return defaultValue;
  }
}

public class MyClass {

  public static void main(String[] args) {

    Preferences preferences = new Preferences();

    int windowWidth = preferences.get(MyPreferences.WINDOW_WIDTH);
    int windowHeight = preferences.get(MyPreferences.WINDOW_HEIGHT);

    preferences.set(MyPreferences.WINDOW_WIDTH, 1024);
  }
}

API

Browse the online groovydocs for this library here: https://javadoc.io/doc/nz.net.ultraq.preferences/preferences