SlimeyData

SlimeyData aims to be a simple API for storing arbitrary data on any object without the need to create different methods inside of classes.

public class Keys {
    public static final Key<Value<String>> MY_KEY = Key.from(ResourceKey.of("example", "my_key"));
}

public class MyDataHolder implements DataHolder {
    // ... other methods ...
}

public class Main {
    public static void main(final String[] args) {
        MyDataHolder myDataHolder = new MyDataHolder();
        myDataHolder.offer(Keys.MY_KEY, "hello!");
        myDataHolder.get(Keys.MY_KEY).ifPresent(value -> {
            // Use the value of the key!
            System.out.println(value); // Prints: "hello"
        });
    }
}

The theory

Keys

A Key allows a reference something which will be stored on a DataHolder later.

public static final Key<Value<String>> MY_KEY = Key.from(ResourceKey.of("testing", "test_key"), String.class);

Data holders

A DataHolder is something which holds data, you may offer it data or get it (in the form of an optional)

myDataHolder.offer(Keys.MY_KEY, "hello!");
myDataHolder.get(Keys.MY_KEY).ifPresent(value -> {
    // Use the value of the key!
    System.out.println(value); // Prints: "hello"
});

Resource Keys

A ResourceKey stores a namespace and an id, this is intended for developers to use when storing them in some form of persistent storage (like a database)

String representation of a ResourceKey is namespace:id. For example: cake:flavour

Inspiration

SpongeAPI has a very similar system which I thought was super cool and useful, but I didn't want to depend on Sponge's systems so I made my own!