Skip to content
This repository was archived by the owner on Aug 9, 2025. It is now read-only.

Introduction.md

Latest commit

 

History

History
91 lines (61 loc) · 2.77 KB

Introduction.md

File metadata and controls

91 lines (61 loc) · 2.77 KB
Raw

Configurations Package

Overview

The configurations package provides utilities for managing configuration data in various formats for NDCore plugins. It offers a structured way to load, manipulate, and save configuration data, making it easier to handle plugin settings and data persistence.

Key Components

FileConfiguration

FileConfiguration is an abstract base class that extends Bukkit's FileConfiguration to provide enhanced error handling and validation:

  • Robust Error Handling: Methods like getOrThrow, getStringOrThrow, etc. that provide strong validation and clear error messages
  • Type-Safe Value Retrieval: Methods that ensure values are not null and of the expected type
  • Empty Value Validation: Checks for empty strings and lists, throwing appropriate exceptions

JSONConfiguration

A concrete implementation of FileConfiguration that provides JSON-specific functionality:

  • Loading and Saving: Methods to load JSON from files or readers and save configuration data as JSON
  • Conversion Utilities: Tools to convert between Bukkit's ConfigurationSection objects and JSON structures
  • Pretty Printing: Options to format JSON output for better readability

Options

An inner class of JSONConfiguration that provides configuration options specific to JSON:

  • Pretty Printing Control: Enable or disable formatted JSON output
  • Path Separator Configuration: Customize the character used to separate paths in the configuration
  • Default Value Handling: Control whether default values are copied when accessing missing keys

Common Use Cases

  • Loading plugin settings from JSON files
  • Saving structured data in a human-readable JSON format
  • Converting between Bukkit's configuration sections and JSON objects
  • Working with web APIs that use JSON
  • Maintaining configuration files that need to be both human-readable and machine-parseable

Integration with Other Packages

The configurations package works closely with:

  • Core plugin initialization to load settings
  • Other components that need to store or retrieve configuration data

Example Usage

// Load a JSON configuration file
File configFile = new File(plugin.getDataFolder(), "config.json");
JSONConfiguration config = JSONConfiguration.loadConfiguration(configFile);

// Access configuration values
String serverName = config.getString("server.name");
int maxPlayers = config.getInt("server.max-players");

// Modify configuration
config.

set("server.name","My Awesome Server");
config.

set("server.max-players",100);

// Enable pretty printing
config.

options().

prettyPrinting(true);

// Save changes
try{
        config.

save(configFile);
}catch(
IOException e){
        plugin.

getLogger().

severe("Could not save configuration: "+e.getMessage());
        }