valorless.valorlessutils.config.Config

public class Config extends Object

YAML-backed configuration wrapper for ValorlessUtils and dependent plugins.

This class wraps YamlFile and exposes convenience getters/setters for common Bukkit and utility types, while also providing a lightweight validation mechanism to ensure that required keys exist in the configuration.

File lifecycle

Config(JavaPlugin, String): creates/loads a config located in the plugin's data folder. If missing, the resource is copied from the plugin JAR via JavaPlugin.saveResource(String, boolean).
Config(File), Config(Path), Config(String): load an existing file by location; if the file does not exist, an IllegalArgumentException is thrown.

Supported value types

In addition to primitive and boxed types that Bukkit/YAML supports by default, this wrapper includes helpers for:

Vector2 and Vector3 stored as nested keys (e.g. myVector.x, myVector.y, myVector.z).
Material stored by its Enum.name() value.
ItemStack stored using Bukkit's built-in serialization.
Lists (string/int/double and generic lists) using Bukkit's configuration API.

Validation

Validation entries can be registered via addValidationEntry(String, Object) (including vector overloads). When validate() runs, missing keys are added with their default values and the configuration is saved. reload() reloads the file content from disk.

Notes

Most setters update the in-memory configuration only; call saveConfig() to persist.
hasKey(String) and section accessors log errors and may return null when invoked with a null or empty key.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

Config.ValidationListEntry

Represents a key-value entry for configuration validation.
Constructor Summary

Constructors

Constructor

Description

Config(File file)

Constructs a new Config object.

Config(String path)

Constructs a new Config object.

Config(Path path)

Constructs a new Config object.

Config(org.bukkit.plugin.java.JavaPlugin plugin, String file)

Constructs a new Config object.
Method Summary

Modifier and Type

Method

Description

void

addValidationEntry(String key, Object value)

Adds a validation entry.

void

addValidationEntry(String key, Object value, String comment)

Adds a validation entry with a single comment line.

void

addValidationEntry(String key, Object value, String comment, boolean inline)

Adds a validation entry with a single comment line and an inline flag.

void

addValidationEntry(String key, Object value, List<String> comments)

Adds a validation entry with comments.

void

addValidationEntry(String key, Object value, List<String> comments, boolean inline)

Adds a validation entry with comments and an inline flag.

<T extends Number> void

addValidationEntry(String key, Vector2<T> value)

Adds validation entries for a Vector2 under key.

<T extends Number> void

addValidationEntry(String key, Vector3<T> value)

Adds validation entries for a Vector3 under key.

void

AddValidationEntry(String key, Object value)

Deprecated.
Use addValidationEntry(String, Object).

void

AddValidationEntry(String key, Object value, String comment)

Deprecated.
Use addValidationEntry(String, Object, String).

void

AddValidationEntry(String key, Object value, List<String> comments)

Deprecated.
Use addValidationEntry(String, Object, List).

<T extends Number> void

AddValidationEntry(String key, Vector2<T> value)

Deprecated.
Use addValidationEntry(String, Vector2).

<T extends Number> void

AddValidationEntry(String key, Vector3<T> value)

Deprecated.
Use addValidationEntry(String, Vector3).

Object

get(String key)

Gets a raw value from the underlying Bukkit configuration.

Object

Get(String key)

Deprecated.
Use get(String).

Boolean

getBool(String key)

Gets a boolean value.

Boolean

GetBool(String key)

Deprecated.
Use getBool(String).

List<String>

getComments(String key)

Gets comments associated with a key.

List<String>

GetComments(String key)

Deprecated.
Use getComments(String).

org.bukkit.configuration.ConfigurationSection

getConfigurationSection(String key)

Gets a ConfigurationSection at the given key.

org.bukkit.configuration.ConfigurationSection

GetConfigurationSection(String key)

Deprecated.
Use getConfigurationSection(String).

Double

getDouble(String key)

Gets a double value.

Double

GetDouble(String key)

Deprecated.
Use getDouble(String).

List<Double>

getDoubleList(String key)

Gets a list of doubles.

List<Double>

GetDoubleList(String key)

Deprecated.
Use getDoubleList(String).

YamlFile

getFile()

Returns the underlying YAML file wrapper.

YamlFile

GetFile()

Deprecated.
Use getFile().

Double

getFloat(String key)

Deprecated.
This method is outdated and will be removed in future versions.

Double

GetFloat(String key)

Deprecated.
Use getFloat(String).

List<String>

getInlineComment(String key)

Gets inline comments associated with a key.

Integer

getInt(String key)

Gets an integer value.

Integer

GetInt(String key)

Deprecated.
Use getInt(String).

List<Integer>

getIntList(String key)

Gets a list of integers.

List<Integer>

GetIntList(String key)

Deprecated.
Use getIntList(String).

org.bukkit.inventory.ItemStack

getItemStack(String key)

Gets an ItemStack.

org.bukkit.inventory.ItemStack

GetItemStack(String key)

Deprecated.
Use getItemStack(String).

List<?>

getList(String key)

Gets a raw list.

List<?>

GetList(String key)

Deprecated.
Use getList(String).

org.bukkit.Material

getMaterial(String key)

Gets a Material by name.

org.bukkit.Material

GetMaterial(String key)

Deprecated.
Use getMaterial(String).

org.bukkit.OfflinePlayer

getOfflinePlayer(String key)

Gets an OfflinePlayer value.

org.bukkit.plugin.java.JavaPlugin

getPlugin()

Returns the plugin instance associated with this config.

org.bukkit.plugin.java.JavaPlugin

GetPlugin()

Deprecated.
Use getPlugin().

org.bukkit.configuration.ConfigurationSection

getSection(String key)

Gets a section at the given key.

org.bukkit.configuration.ConfigurationSection

GetSection(String key)

Deprecated.
Use getSection(String).

<T extends org.bukkit.configuration.serialization.ConfigurationSerializable> T

getSerializable(String key, Class<T> type)

Gets a ConfigurationSerializable value.

String

getString(String key)

Gets a string value.

String

GetString(String key)

Deprecated.
Use getString(String).

List<String>

getStringList(String key)

Gets a list of strings.

List<String>

GetStringList(String key)

Deprecated.
Use getStringList(String).

<T extends Number> Vector2<T>

getVector2(String key)

Gets a 2D vector.

<T extends Number> Vector2<T>

GetVector2(String key)

Deprecated.
Use getVector2(String).

<T extends Number> Vector3<T>

getVector3(String key)

Gets a 3D vector.

<T extends Number> Vector3<T>

GetVector3(String key)

Deprecated.
Use getVector3(String).

Boolean

hasKey(String key)

Checks whether a key exists.

Boolean

HasKey(String key)

Deprecated.
Use hasKey(String).

void

reload()

Reloads the configuration from disk.

void

Reload()

Deprecated.
Use reload().

void

saveConfig()

Saves the configuration to disk.

void

SaveConfig()

Deprecated.
Use saveConfig().

void

set(String key, Object value)

Sets a raw value in the underlying Bukkit configuration (in-memory).

void

Set(String key, Object value)

Deprecated.
Use set(String, Object).

void

setBool(String key, Boolean value)

Sets a boolean value in-memory.

void

SetBool(String key, Boolean value)

Deprecated.
Use setBool(String, Boolean).

void

setComments(String key, List<String> comments)

Sets comments for a key.

void

SetComments(String key, List<String> comments)

Deprecated.
Use setComments(String, List).

void

setDouble(String key, Double value)

Sets a double value in-memory.

void

SetDouble(String key, Double value)

Deprecated.
Use setDouble(String, Double).

void

setDoubleList(String key, List<Double> value)

Sets a list of doubles in-memory.

void

SetDoubleList(String key, List<Double> value)

Deprecated.
Use setDoubleList(String, List).

void

setInlineComment(String key, List<String> comments)

Sets inline comments for a key.

void

setInt(String key, Integer value)

Sets an integer value in-memory.

void

SetInt(String key, Integer value)

Deprecated.
Use setInt(String, Integer).

void

setIntList(String key, List<Integer> value)

Sets a list of integers in-memory.

void

SetIntList(String key, List<Integer> value)

Deprecated.
Use setIntList(String, List).

void

setItemStack(String key, org.bukkit.inventory.ItemStack item)

Stores an ItemStack (in-memory).

void

SetItemStack(String key, org.bukkit.inventory.ItemStack item)

Deprecated.
Use setItemStack(String, ItemStack).

void

setList(String key, List<?> value)

Sets a raw list in-memory.

void

SetList(String key, List<?> value)

Deprecated.
Use setList(String, List).

void

setMaterial(String key, org.bukkit.Material material)

Stores a Material as its enum name.

void

SetMaterial(String key, org.bukkit.Material material)

Deprecated.
Use setMaterial(String, Material).

void

setOfflinePlayer(String key, org.bukkit.OfflinePlayer value)

Sets an OfflinePlayer value in-memory.

void

setSerializable(String key, org.bukkit.configuration.serialization.ConfigurationSerializable value)

Sets a ConfigurationSerializable value in-memory.

void

setString(String key, String value)

Sets a string value in-memory.

void

SetString(String key, String value)

Deprecated.
Use setString(String, String).

void

setStringList(String key, List<String> value)

Sets a list of strings in-memory.

void

SetStringList(String key, List<String> value)

Deprecated.
Use setStringList(String, List).

<T extends Number> void

setVector2(String key, Vector2<T> value)

Sets a 2D vector in-memory.

<T extends Number> void

SetVector2(String key, Vector2<T> value)

Deprecated.
Use setVector2(String, Vector2).

<T extends Number> void

setVector3(String key, Vector3<T> value)

Sets a 3D vector in-memory.

<T extends Number> void

SetVector3(String key, Vector3<T> value)

Deprecated.
Use setVector3(String, Vector3).

void

validate()

Ensures all registered validation keys exist.

void

Validate()

Deprecated.
Use validate().

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Config
  
  public Config(org.bukkit.plugin.java.JavaPlugin plugin, String file)
  
  Constructs a new Config object.
  If the file does not exist, it will be copied from the plugin's resources.
  
  Parameters:
  
  plugin - The JavaPlugin instance.
  
  file - The name of the configuration file.
- Config
  
  public Config(File file)
  
  Constructs a new Config object.
  If the file does not exist, an error is thrown.
  
  Parameters:
  
  file - The File of the configuration file.
- Config
  
  public Config(Path path)
  
  Constructs a new Config object.
  If the file does not exist, an error is thrown.
  
  Parameters:
  
  path - The Path of the configuration file.
- Config
  
  public Config(String path)
  
  Constructs a new Config object.
  If the file does not exist, an error is thrown.
  
  Parameters:
  
  path - The path of the configuration file.
Method Details
- getPlugin
  
  public org.bukkit.plugin.java.JavaPlugin getPlugin()
  
  Returns the plugin instance associated with this config.
  When this Config instance was created without an explicit plugin (e.g. via the Config(File), Config(Path) or Config(String) constructors), the implementation currently logs an error and may return null.
  
  Returns:
  
  the attached JavaPlugin, or null when no plugin is attached.
- GetPlugin
  
  @Deprecated @MarkedForRemoval public org.bukkit.plugin.java.JavaPlugin GetPlugin()
  
  Deprecated.
  Use getPlugin().
- getString
  
  public String getString(String key)
  
  Gets a string value.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  string value or null if not present
- GetString
  
  @Deprecated @MarkedForRemoval public String GetString(String key)
  
  Deprecated.
  Use getString(String).
- setString
  
  public void setString(String key, String value)
  
  Sets a string value in-memory.
  Parameters:
  
  key - config path
  
  value - value to set
  
  See Also:
  
  saveConfig()
- SetString
  
  @Deprecated @MarkedForRemoval public void SetString(String key, String value)
  
  Deprecated.
  Use setString(String, String).
- getBool
  
  public Boolean getBool(String key)
  
  Gets a boolean value.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  boolean value (defaults to false if missing)
- GetBool
  
  @Deprecated @MarkedForRemoval public Boolean GetBool(String key)
  
  Deprecated.
  Use getBool(String).
- setBool
  
  public void setBool(String key, Boolean value)
  
  Sets a boolean value in-memory.
  Parameters:
  
  key - config path
  
  value - value to set
  
  See Also:
  
  saveConfig()
- SetBool
  
  @Deprecated @MarkedForRemoval public void SetBool(String key, Boolean value)
  
  Deprecated.
  Use setBool(String, Boolean).
- getInt
  
  public Integer getInt(String key)
  
  Gets an integer value.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  integer value (defaults to 0 if missing)
- GetInt
  
  @Deprecated @MarkedForRemoval public Integer GetInt(String key)
  
  Deprecated.
  Use getInt(String).
- setInt
  
  public void setInt(String key, Integer value)
  
  Sets an integer value in-memory.
  Parameters:
  
  key - config path
  
  value - value to set
  
  See Also:
  
  saveConfig()
- SetInt
  
  @Deprecated @MarkedForRemoval public void SetInt(String key, Integer value)
  
  Deprecated.
  Use setInt(String, Integer).
- getFloat
  
  @Deprecated @MarkedForRemoval public Double getFloat(String key)
  
  Deprecated.
  This method is outdated and will be removed in future versions. Use getDouble(String).
  
  Retrieves a float (double) value from the config.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  double value stored at key
- GetFloat
  
  @Deprecated @MarkedForRemoval public Double GetFloat(String key)
  
  Deprecated.
  Use getFloat(String).
  
  Retrieves a float (double) value from the config.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  double value stored at key
- getDouble
  
  public Double getDouble(String key)
  
  Gets a double value.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  double value (defaults to 0.0 if missing)
- GetDouble
  
  @Deprecated @MarkedForRemoval public Double GetDouble(String key)
  
  Deprecated.
  Use getDouble(String).
- setDouble
  
  public void setDouble(String key, Double value)
  
  Sets a double value in-memory.
  Parameters:
  
  key - config path
  
  value - value to set
  
  See Also:
  
  saveConfig()
- SetDouble
  
  @Deprecated @MarkedForRemoval public void SetDouble(String key, Double value)
  
  Deprecated.
  Use setDouble(String, Double).
- getOfflinePlayer
  
  public org.bukkit.OfflinePlayer getOfflinePlayer(String key)
  
  Gets an OfflinePlayer value.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  OfflinePlayer value or null if not present
- setOfflinePlayer
  
  public void setOfflinePlayer(String key, org.bukkit.OfflinePlayer value)
  
  Sets an OfflinePlayer value in-memory.
  Parameters:
  
  key - config path
  
  value - value to set
  
  See Also:
  
  saveConfig()
- setSerializable
  
  public void setSerializable(String key, org.bukkit.configuration.serialization.ConfigurationSerializable value)
  
  Sets a ConfigurationSerializable value in-memory.
  Parameters:
  
  key - config path
  
  value - value to set
  
  See Also:
  
  saveConfig()
- getSerializable
  
  public <T extends org.bukkit.configuration.serialization.ConfigurationSerializable> T getSerializable(String key, Class<T> type)
  
  Gets a ConfigurationSerializable value.
  
  Parameters:
  
  key - config path
  
  type - class of the value to get
  
  Returns:
  
  deserialized value, or null if not present
- getVector2
  
  public <T extends Number> Vector2<T> getVector2(String key)
  
  Gets a 2D vector.
  Values are read from nested keys: key + ".x" and key + ".y".
  
  Parameters:
  
  key - base config path
  
  Returns:
  
  vector composed from the stored x/y values (may contain nulls if keys are missing)
- GetVector2
  
  @Deprecated @MarkedForRemoval public <T extends Number> Vector2<T> GetVector2(String key)
  
  Deprecated.
  Use getVector2(String).
- setVector2
  
  public <T extends Number> void setVector2(String key, Vector2<T> value)
  
  Sets a 2D vector in-memory.
  Values are written to nested keys: key + ".x" and key + ".y".
  Parameters:
  
  key - base config path
  
  value - vector to store
  
  See Also:
  
  saveConfig()
- SetVector2
  
  @Deprecated @MarkedForRemoval public <T extends Number> void SetVector2(String key, Vector2<T> value)
  
  Deprecated.
  Use setVector2(String, Vector2).
- getVector3
  
  public <T extends Number> Vector3<T> getVector3(String key)
  
  Gets a 3D vector.
  Values are read from nested keys: key + ".x", key + ".y", key + ".z".
  
  Parameters:
  
  key - base config path
  
  Returns:
  
  vector composed from the stored x/y/z values (may contain nulls if keys are missing)
- GetVector3
  
  @Deprecated @MarkedForRemoval public <T extends Number> Vector3<T> GetVector3(String key)
  
  Deprecated.
  Use getVector3(String).
- setVector3
  
  public <T extends Number> void setVector3(String key, Vector3<T> value)
  
  Sets a 3D vector in-memory.
  Values are written to nested keys: key + ".x", key + ".y", key + ".z".
  Parameters:
  
  key - base config path
  
  value - vector to store
  
  See Also:
  
  saveConfig()
- SetVector3
  
  @Deprecated @MarkedForRemoval public <T extends Number> void SetVector3(String key, Vector3<T> value)
  
  Deprecated.
  Use setVector3(String, Vector3).
- getMaterial
  
  public org.bukkit.Material getMaterial(String key)
  
  Gets a Material by name.
  
  Parameters:
  
  key - config path containing the material name
  
  Returns:
  
  resolved material, or null if the name is missing/invalid
- GetMaterial
  
  @Deprecated @MarkedForRemoval public org.bukkit.Material GetMaterial(String key)
  
  Deprecated.
  Use getMaterial(String).
- setMaterial
  
  public void setMaterial(String key, org.bukkit.Material material)
  
  Stores a Material as its enum name.
  Parameters:
  
  key - config path
  
  material - material to store
  
  See Also:
  
  saveConfig()
- SetMaterial
  
  @Deprecated @MarkedForRemoval public void SetMaterial(String key, org.bukkit.Material material)
  
  Deprecated.
  Use setMaterial(String, Material).
- get
  
  public Object get(String key)
  
  Gets a raw value from the underlying Bukkit configuration.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  stored value, or null if missing
- Get
  
  @Deprecated @MarkedForRemoval public Object Get(String key)
  
  Deprecated.
  Use get(String).
- set
  
  public void set(String key, Object value)
  
  Sets a raw value in the underlying Bukkit configuration (in-memory).
  Parameters:
  
  key - config path
  
  value - value to set
  
  See Also:
  
  saveConfig()
- Set
  
  @Deprecated @MarkedForRemoval public void Set(String key, Object value)
  
  Deprecated.
  Use set(String, Object).
- getStringList
  
  public List<String> getStringList(String key)
  
  Gets a list of strings.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  list (never null; may be empty)
- GetStringList
  
  @Deprecated @MarkedForRemoval public List<String> GetStringList(String key)
  
  Deprecated.
  Use getStringList(String).
- setStringList
  
  public void setStringList(String key, List<String> value)
  
  Sets a list of strings in-memory.
  Parameters:
  
  key - config path
  
  value - list to store
  
  See Also:
  
  saveConfig()
- SetStringList
  
  @Deprecated @MarkedForRemoval public void SetStringList(String key, List<String> value)
  
  Deprecated.
  Use setStringList(String, List).
- getIntList
  
  public List<Integer> getIntList(String key)
  
  Gets a list of integers.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  list (never null; may be empty)
- GetIntList
  
  @Deprecated @MarkedForRemoval public List<Integer> GetIntList(String key)
  
  Deprecated.
  Use getIntList(String).
- setIntList
  
  public void setIntList(String key, List<Integer> value)
  
  Sets a list of integers in-memory.
  Parameters:
  
  key - config path
  
  value - list to store
  
  See Also:
  
  saveConfig()
- SetIntList
  
  @Deprecated @MarkedForRemoval public void SetIntList(String key, List<Integer> value)
  
  Deprecated.
  Use setIntList(String, List).
- getDoubleList
  
  public List<Double> getDoubleList(String key)
  
  Gets a list of doubles.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  list (never null; may be empty)
- GetDoubleList
  
  @Deprecated @MarkedForRemoval public List<Double> GetDoubleList(String key)
  
  Deprecated.
  Use getDoubleList(String).
- setDoubleList
  
  public void setDoubleList(String key, List<Double> value)
  
  Sets a list of doubles in-memory.
  Parameters:
  
  key - config path
  
  value - list to store
  
  See Also:
  
  saveConfig()
- SetDoubleList
  
  @Deprecated @MarkedForRemoval public void SetDoubleList(String key, List<Double> value)
  
  Deprecated.
  Use setDoubleList(String, List).
- getList
  
  public List<?> getList(String key)
  
  Gets a raw list.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  list, or null if missing
- GetList
  
  @Deprecated @MarkedForRemoval public List<?> GetList(String key)
  
  Deprecated.
  Use getList(String).
- setList
  
  public void setList(String key, List<?> value)
  
  Sets a raw list in-memory.
  Parameters:
  
  key - config path
  
  value - list to store
  
  See Also:
  
  saveConfig()
- SetList
  
  @Deprecated @MarkedForRemoval public void SetList(String key, List<?> value)
  
  Deprecated.
  Use setList(String, List).
- getItemStack
  
  public org.bukkit.inventory.ItemStack getItemStack(String key)
  
  Gets an ItemStack.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  deserialized item, or null if missing
- GetItemStack
  
  @Deprecated @MarkedForRemoval public org.bukkit.inventory.ItemStack GetItemStack(String key)
  
  Deprecated.
  Use getItemStack(String).
- setItemStack
  
  public void setItemStack(String key, org.bukkit.inventory.ItemStack item)
  
  Stores an ItemStack (in-memory).
  Parameters:
  
  key - config path
  
  item - item to store
  
  See Also:
  
  saveConfig()
- SetItemStack
  
  @Deprecated @MarkedForRemoval public void SetItemStack(String key, org.bukkit.inventory.ItemStack item)
  
  Deprecated.
  Use setItemStack(String, ItemStack).
- hasKey
  
  public Boolean hasKey(String key)
  
  Checks whether a key exists.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  true if present; false if not present; or null when key is null/empty (also logs an error)
- HasKey
  
  @Deprecated @MarkedForRemoval public Boolean HasKey(String key)
  
  Deprecated.
  Use hasKey(String).
- getConfigurationSection
  
  public org.bukkit.configuration.ConfigurationSection getConfigurationSection(String key)
  
  Gets a ConfigurationSection at the given key.
  This first attempts MemorySection.getConfigurationSection(String). If that returns null, it falls back to getSection(String) for compatibility with different underlying YAML implementations.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  the configuration section for key, or null if key is null/empty (logs an error) or the section does not exist
- GetConfigurationSection
  
  @Deprecated @MarkedForRemoval public org.bukkit.configuration.ConfigurationSection GetConfigurationSection(String key)
  
  Deprecated.
  Use getConfigurationSection(String).
- getSection
  
  public org.bukkit.configuration.ConfigurationSection getSection(String key)
  
  Gets a section at the given key.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  the section, or null if missing/invalid key
- GetSection
  
  @Deprecated @MarkedForRemoval public org.bukkit.configuration.ConfigurationSection GetSection(String key)
  
  Deprecated.
  Use getSection(String).
- getComments
  
  public List<String> getComments(String key)
  
  Gets comments associated with a key.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  comment lines, or null if key is null/empty
- GetComments
  
  @Deprecated @MarkedForRemoval public List<String> GetComments(String key)
  
  Deprecated.
  Use getComments(String).
- setComments
  
  public void setComments(String key, List<String> comments)
  
  Sets comments for a key.
  
  Parameters:
  
  key - config path
  
  comments - comment lines to store
- SetComments
  
  @Deprecated @MarkedForRemoval public void SetComments(String key, List<String> comments)
  
  Deprecated.
  Use setComments(String, List).
- getInlineComment
  
  public List<String> getInlineComment(String key)
  
  Gets inline comments associated with a key.
  
  Parameters:
  
  key - config path
  
  Returns:
  
  inline comment lines, or null if key is null/empty
- setInlineComment
  
  public void setInlineComment(String key, List<String> comments)
  
  Sets inline comments for a key.
  
  Parameters:
  
  key - config path
  
  comments - inline comment lines to store
- getFile
  
  public YamlFile getFile()
  
  Returns the underlying YAML file wrapper.
  
  Returns:
  
  backing YamlFile
- GetFile
  
  @Deprecated @MarkedForRemoval public YamlFile GetFile()
  
  Deprecated.
  Use getFile().
- reload
  
  public void reload()
  
  Reloads the configuration from disk.
- Reload
  
  @Deprecated @MarkedForRemoval public void Reload()
  
  Deprecated.
  Use reload().
- saveConfig
  
  public void saveConfig()
  
  Saves the configuration to disk.
- SaveConfig
  
  @Deprecated @MarkedForRemoval public void SaveConfig()
  
  Deprecated.
  Use saveConfig().
- addValidationEntry
  
  public void addValidationEntry(String key, Object value)
  
  Adds a validation entry.
  During validate(), missing keys will be created with value.
  
  Parameters:
  
  key - config path
  
  value - default value to write when missing
- AddValidationEntry
  
  @Deprecated @MarkedForRemoval public void AddValidationEntry(String key, Object value)
  
  Deprecated.
  Use addValidationEntry(String, Object).
- addValidationEntry
  
  public void addValidationEntry(String key, Object value, List<String> comments)
  
  Adds a validation entry with comments.
  
  Parameters:
  
  key - config path
  
  value - default value to write when missing
  
  comments - comment lines to associate with the key
- AddValidationEntry
  
  @Deprecated @MarkedForRemoval public void AddValidationEntry(String key, Object value, List<String> comments)
  
  Deprecated.
  Use addValidationEntry(String, Object, List).
- addValidationEntry
  
  public void addValidationEntry(String key, Object value, String comment)
  
  Adds a validation entry with a single comment line.
  
  Parameters:
  
  key - config path
  
  value - default value to write when missing
  
  comment - comment line to associate with the key
- AddValidationEntry
  
  @Deprecated @MarkedForRemoval public void AddValidationEntry(String key, Object value, String comment)
  
  Deprecated.
  Use addValidationEntry(String, Object, String).
- addValidationEntry
  
  public void addValidationEntry(String key, Object value, List<String> comments, boolean inline)
  
  Adds a validation entry with comments and an inline flag.
  
  Parameters:
  
  key - config path
  
  value - default value to write when missing
  
  comments - comment lines to associate with the key
  
  inline - whether the comments should be inline (true) or block (false)
- addValidationEntry
  
  public void addValidationEntry(String key, Object value, String comment, boolean inline)
  
  Adds a validation entry with a single comment line and an inline flag.
  
  Parameters:
  
  key - config path
  
  value - default value to write when missing
  
  comment - comment line to associate with the key
  
  inline - whether the comment should be inline (true) or block (false)
- addValidationEntry
  
  public <T extends Number> void addValidationEntry(String key, Vector2<T> value)
  
  Adds validation entries for a Vector2 under key.
  This registers key + ".x" and key + ".y".
  
  Parameters:
  
  key - base config path
  
  value - vector providing default x/y values
- AddValidationEntry
  
  @Deprecated @MarkedForRemoval public <T extends Number> void AddValidationEntry(String key, Vector2<T> value)
  
  Deprecated.
  Use addValidationEntry(String, Vector2).
- addValidationEntry
  
  public <T extends Number> void addValidationEntry(String key, Vector3<T> value)
  
  Adds validation entries for a Vector3 under key.
  This registers key + ".x", key + ".y" and key + ".z".
  
  Parameters:
  
  key - base config path
  
  value - vector providing default x/y/z values
- AddValidationEntry
  
  @Deprecated @MarkedForRemoval public <T extends Number> void AddValidationEntry(String key, Vector3<T> value)
  
  Deprecated.
  Use addValidationEntry(String, Vector3).
- validate
  
  public void validate()
  
  Ensures all registered validation keys exist.
  If any keys are missing, they are added with their defaults and the file is saved.
- Validate
  
  @Deprecated @MarkedForRemoval public void Validate()
  
  Deprecated.
  Use validate().

Class Config

File lifecycle

Supported value types

Validation

Notes

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Config

Config

Config

Config

Method Details

getPlugin

GetPlugin

getString

GetString

setString

SetString

getBool

GetBool

setBool

SetBool

getInt

GetInt

setInt

SetInt

getFloat

GetFloat

getDouble

GetDouble

setDouble

SetDouble

getOfflinePlayer

setOfflinePlayer

setSerializable

getSerializable

getVector2

GetVector2

setVector2

SetVector2

getVector3

GetVector3

setVector3

SetVector3

getMaterial

GetMaterial

setMaterial

SetMaterial

get

Get

set

Set

getStringList

GetStringList

setStringList

SetStringList

getIntList

GetIntList

setIntList

SetIntList

getDoubleList

GetDoubleList

setDoubleList

SetDoubleList

getList

GetList

setList

SetList

getItemStack

GetItemStack

setItemStack

SetItemStack

hasKey

HasKey

getConfigurationSection

GetConfigurationSection

getSection