Config

note

You need to initialize PineappleLib with PineappleLib.initialize(Plugin) before you can use this API

Annotations

All the annotations PineappleLib provides for your configs

@ConfigPath

This annotation is the only annotation required for your configs to work, it registries a variable as a config entry and allows you to set the path of it inside of your YAML file. Example:

Parent Section

@ConfigPath("foo")
public static String bar = "foobar";

Will end up as the following in config

foo: "foobar"

Sub Section

@ConfigPath("foo.bar")
public static String bar = "foobar";

Will end up as the following in config

foo:
  bar: "foobar"

@Comment

This annotation allows you to create a comment on an Entry, it also allows for multiple per entry Example:

One Comment

@Comment("foobar, foobar")
@ConfigPath("foo")
public static String bar = "foobar";

Will end up as the following in config

#foobar, foobar
foo: "foobar"

Multiple Comments

@Comment("foobar, foobar")
@Comment("barfoo, barfoo")
@ConfigPath("foo")
public static String bar = "foobar";

Will end up as the following in config

#foobar, foobar
#barfoo, barfoo
foo: "foobar"

Creating a Reloadable Config

All configs inside of Pineapple are reloadable you just have to retain an instance of the ConfigWrapper

PluginSettings.java

public class PluginSettings {
  
  @ConfigPath("foo")
  public static String BAR = "foobar"

}

PluginMain.java

private ConfigWrapper pluginConfig;

private void setupConfig() {
    pluginConfig = PineappleLib.getConfigurationManager().createDefault(new File(this.getDataFolder(), "config.yml"), PluginSettings.class);
}

public void reload() {
  pluginConfig.load();
}

Accessing the values:

public void sendValue(Player player) {
  player.sendMessage(PluginSettings.BAR);
}

Custom Adapater

PineappleLib allows for you create a custom adapters for your data classes, we include a TypeAdapter which could serialize to anything or a StringAdapater which would serialize to a String

String Adapter

The PlayerData class to serialize

PlayerData.java

public class PlayerData {

  private final UUID uuid;
  private int kills = 0;

  public PlayerData(UUID uuid, int kills) {
    this.uuid = uuid;
    this.kills = kills;
  }

  @Override
  public String toString() {
    return uuid.toString() + ";" + kills;
  }
}

The StringAdapter

PlayerDataAdapter.java

public class PlayerDataAdapter implements TypeAdapterString<PlayerData> {

  @Override
  public Class<PlayerData> getRuntimeType() {
    return PlayerData.class;
  }

  @Override
  public String toString(PlayerData data) {
    return data.toString();
  }

  @Override
  public PlayerData fromString(String value) {
    String[] split = value.split(";");
    return new PlayerData(split[0], Integer.parseInt(split[1]));
  }
}

How it would look like used in a config:

PluginSettings.java

public class PluginSettings {

  @ConfigPath("owner-data")
  public static PlayerData OWNER_DATA = new PlayerData(UUID.randomUUID(), 20);

}

How to register the adapter:

private void registerAdapter() {
  PineappleLib.getConfigurationManager().registerTypeAdapter(new PlayerDataAdapter());
}

Complex Adapter

The PlayerData class to serialize

PlayerData.java

public class PlayerData {

  private final UUID uuid;
  private int kills = 0;

  public PlayerData(UUID uuid, int kills) {
    this.uuid = uuid;
    this.kills = kills;
  }

  public UUID getUUID() {
    return this.uuid;
  }

  public int getKills() {
    return this.kills;
  }
}

The StringAdapter

PlayerDataAdapter.java

public class PlayerDataAdapter implements TypeAdapter<Map<String, Object>, PlayerData> {

  @Override
  public Class<Map<String, Object>> getSavedType() {
      return (Class<Map<String, Object>>) (Object) Map.class;
  }
   
  @Override
  public Class<PlayerData> getRuntimeType() {
      return PlayerData.class;
  }

  @Override
  public PlayerData read(Map<String, Object> value) {
    return new PlayerData(UUID.fromString(value.get("uuid").toString()), (Integer) value.get("kills"));
  }

  @Override
  public Map<String, Object> write(PlayerData value, Map<String, Object> existing, boolean replace) {
    if (existing == null) {
      existing = new HashMap<>();
    }

    if (!existing.containsKey("uuid") || replace) {
      existing.put("uuid", value.getUUID().toString());
    }

    if (!existing.containsKey("kills") || replace) {
      existing.put("kills", value.getKills());
    }
      
    return existing;
  }
}

How it would look like used in a config:

PluginSettings.java

public class PluginSettings {

  @ConfigPath("owner-data")
  public static PlayerData OWNER_DATA = new PlayerData(UUID.randomUUID(), 20);

}

How to register the adapter:

private void registerAdapter() {
  PineappleLib.getConfigurationManager().registerTypeAdapter(PlayerData.class, new PlayerDataAdapter());
}