Configurate

https://github.com/spongepowered/configurate
Admin
Configurate is a simple configuration library for Java applications that provides a node-based...
Tokens:114,313
Snippets:697
Trust Score:9.9
License:Apache-2.0
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Standalone ObjectMapper setup with HOCON loader and @ConfigSerializable classes

Source: https://github.com/spongepowered/configurate/wiki/Object-Mapper

Complete example of loading a configuration from a HOCON file, populating a @ConfigSerializable object, modifying it, and saving back. Demonstrates field-based mapping, @Comment, transient fields, and nested @ConfigSerializable classes.

```java
public final class ObjectMapperExample {

    private ObjectMapperExample() {}

    public static void main(final String[] args) throws ConfigurateException {
        final Path file = Paths.get(args[0]);
        final HoconConfigurationLoader loader = HoconConfigurationLoader.builder()
                .path(file) // or url(), or source/sink
                .build();

        final CommentedConfigurationNode node = loader.load(); // Load from file
        final MyConfiguration config = node.get(MyConfiguration.class); // Populate object

        // Do whatever actions with the configuration, then...
        config.itemName("Steve");

        node.set(MyConfiguration.class, config); // Update the backing node
        loader.save(node); // Write to the original file
    }

    @ConfigSerializable
    static class MyConfiguration {

        // Fields must be non-final to be modified

        private @Nullable String itemName;

        @Comment("Here is a comment to describe the purpose of this field")
        private Pattern filter = Pattern.compile("cars?"); // Set defaults by initializing the field

        // As long as custom classes are annotated with @ConfigSerializable, they can be nested as ordinary fields.
        private List<Section> sections = new ArrayList<>();

        // This won't be written to the file because it's marked as `transient`
        private transient @MonotonicNonNull String decoratedName;

        public @Nullable String itemName() {
            return this.itemName;
        }

        public void itemName(final String itemName) {
            this.itemName = requireNonNull(itemName, "itemName");
        }

        public Pattern filter() {
            return this.filter;
        }

        public List<Section> sections() {
            return this.sections;
        }

        public String decoratedItemName() {
            if (this.decoratedName == null) {
                this.decoratedName = "[" + this.itemName + "]";
            }
            return this.decoratedName;
        }

    }

    @ConfigSerializable
    static class Section {

        private String name;
        private UUID id;

        // the ObjectMapper resolves settings based on fields -- these methods are provided as a convenience
        public String name() {
            return this.name;
        }

        public UUID id() {
            return this.id;
        }

    }

}
```

--------------------------------

### YamlConfigurationLoader usage example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-yaml.md

Complete usage example: builds a loader with path, indent, and node style, loads a YAML file, modifies nodes, and saves. Note that NODE_STYLE applies globally to all collections.

```java
final YamlConfigurationLoader loader = YamlConfigurationLoader.builder()
        .path(Paths.get("config.yaml"))
        .indent(2)
        .nodeStyle(NodeStyle.BLOCK)
        .build();

final CommentedConfigurationNode root = loader.load();
root.node("database", "host").set("localhost");
root.node("database", "ports").setList(Integer.class, List.of(3306, 3307));
loader.save(root);
```

--------------------------------

### Example — fan-out with cancellation

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/reactive.md

Example demonstrating the use of Processor.Iso for fan-out with cancellation.

```APIDOC
## Example — fan-out with cancellation

### Description
Demonstrates creating a Processor.Iso, subscribing, submitting, injecting, disposing, and closing when unsubscribed.

### Code Example
```java
final Processor.Iso<String> bus = Processor.create();
final Disposable sub = bus.subscribe(msg -> System.out.println("got: " + msg));

bus.submit("hello");          // prints "got: hello"
bus.inject("raw");            // Iso: same as submit
sub.dispose();
bus.closeIfUnsubscribed();    // true once no subscribers remain
```
```

--------------------------------

### Usage example loading and saving JSON with GsonConfigurationLoader

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-gson.md

Illustrates typical usage: building a loader with a path, indent, and lenient options, then loading a BasicConfigurationNode, reading a value with getString, saving the node, and using seamless JsonElement interop via get and set with JsonElement.class.

```java
final GsonConfigurationLoader loader = GsonConfigurationLoader.builder()
        .path(Paths.get("config.json"))
        .indent(4)                 // pretty-print with 4 spaces
        .lenient(true)
        .build();

final BasicConfigurationNode root = loader.load();
final String name = root.node("name").getString();
loader.save(root);

// Seamless JsonElement interop
final JsonObject extra = root.node("extra").get(JsonElement.class).getAsJsonObject();
root.node("extra").set(JsonElement.class, extra);
```

--------------------------------

### Load, read, modify, and save a HOCON configuration with Configurate

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/index.md

Shows the basic usage of Configurate: building a HOCON loader, loading a configuration file, reading values with defaults, modifying a node with a comment and appending a list element, and saving the changes. The example is from the Tutorial.java file in the examples module.

```java
final HoconConfigurationLoader loader = HoconConfigurationLoader.builder()
        .path(Paths.get("myproject.conf")) // Set where we will load and save to
        .build();

final CommentedConfigurationNode root;
try {
    root = loader.load();
} catch (final ConfigurateException e) {
    System.err.println("An error occurred while loading this configuration: " + e.getMessage());
    ...
}

final @Nullable String name = root.node("name").getString();
final int count = root.node("messages", "count").getInt(Integer.MIN_VALUE);
root.node("accesses").act(n -> {
    n.commentIfAbsent("The times messages have been accessed");
    n.appendListNode().set(System.currentTimeMillis());
});
loader.save(root);
```

--------------------------------

### HoconConfigurationLoader usage example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-hocon.md

Example usage of HoconConfigurationLoader: builds a loader with path and options, loads a configuration, sets comments and values, and saves. Comments are preserved on save.

```java
final HoconConfigurationLoader loader = HoconConfigurationLoader.builder()
        .path(Paths.get("app.conf"))
        .prettyPrinting(true)
        .indent(4)
        .emitComments(true)
        .build();

final CommentedConfigurationNode root = loader.load();

root.node("database").comment("Connection settings");
root.node("database", "host").set("db.internal");
root.node("database", "port").raw(5432);

loader.save(root);   // header comments and node comments are preserved
```

--------------------------------

### Create custom TypeSerializerCollection and use with ConfigurationOptions

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/serialization.md

Builds a custom TypeSerializerCollection by starting from defaults and registering a serializer for Instant and a map of String to Instant. Then creates ConfigurationOptions with these serializers and a BasicConfigurationNode to set and get an Instant value, demonstrating custom serialization in action.

```java
final TypeSerializerCollection custom = TypeSerializerCollection.defaults().childBuilder()
        .register(Instant.class, INSTANT)
        .registerExact(new TypeToken<Map<String, Instant>>() {}, instantMapSerializer)
        .build();

final ConfigurationOptions opts = ConfigurationOptions.defaults().serializers(custom);
final BasicConfigurationNode node = BasicConfigurationNode.root(opts);

node.set(Instant.class, Instant.EPOCH);
final Instant back = node.get(Instant.class);
```

--------------------------------

### NodePath usage example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/node-path-hints.md

Usage example for NodePath static factory and instance methods. Shows path("server", "bind-address") creating a path, withAppendedChild("port") appending a child, with(1, "listen") replacing an element, and plus(path("b")) concatenating paths.

```java
import static org.spongepowered.configurate.NodePath.path;

NodePath p = path("server", "bind-address");   // [server, bind-address]
NodePath q = p.withAppendedChild("port");       // [server, bind-address, port]
NodePath r = p.with(1, "listen");               // [server, listen]
NodePath combined = path("a").plus(path("b"));  // [a, b]
```

--------------------------------

### Example usage of Kotlin extensions

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/extra-kotlin.md

Shows how to use the Kotlin extensions: building a commented node, getting a typed value with `get<Int>()`, and setting a typed value with `typedSet`.

```kotlin
import org.spongepowered.configurate.kotlin.commented
import org.spongepowered.configurate.kotlin.extensions.get

val root = commented { "server" in this }          // build + init in one block
root["greeting" ] = ...                            // (via set extensions)
val port: Int? = root.node("server", "port").get<Int>()
root.node("server").typedSet(8080)
```

--------------------------------

### DataFixerTransformation migration example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/extra-dfu.md

Shows how to define a schema with DFU DSL and migrate loaded configurations. Builds a DataFixerTransformation with a DataFixer, version key, target version, and type mapping, then applies it to a loaded node and saves.

```java
// Define the schema with DFU DSL, then migrate loaded configurations
final DataFixer fixer = ...; // com.mojang.datafixers.DataFixer

final DataFixerTransformation upgrade = DataFixerTransformation.dfuBuilder()
        .dataFixer(fixer)
        .versionKey("version")
        .targetVersion(3)
        .addType(MySchema.TYPE, "servers")
        .build();

final CommentedConfigurationNode root = loader.load();
upgrade.apply(root); // node is now at the target schema version
loader.save(root);
```

--------------------------------

### Publisher.execute and cache usage example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/reactive.md

Shows creating a publisher with `execute`, subscribing to print a computed value, and caching the mapped result with an initial value. The cached value prints the latest result.

```java
final Publisher<Integer> numbers = Publisher.execute(() -> 41 + 1);
numbers.subscribe(n -> System.out.println("Computed: " + n));   // prints "Computed: 42"

final Publisher.Cached<String> cached = numbers.map(Object::toString).cache("unset");
System.out.println(cached.get());        // "42" (latest)
```

--------------------------------

### NodeStyle.FLOW output example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-yaml.md

Example YAML output for NodeStyle.FLOW, which always uses flow style.

```yaml
key: [value]
```

--------------------------------

### Options node for ConfigurationFormat.create

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/configuration.md

Example options node passed to ConfigurationFormat.create(Path, ConfigurationNode). Map children are fed back into the loader's option state via ValueSources.node, allowing per-format options like indentation and leniency to be set.

```yaml
# options.yaml
gson:indent: 4
gson:lenient: false
```

--------------------------------

### GsonConfigurationFormat provider example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/loader-format.md

Example provider extending AbstractConfigurationFormat, simplified from GsonConfigurationFormat. Registers the format with id "gson" and supports the "json" extension.

```java
public final class GsonConfigurationFormat extends AbstractConfigurationFormat<
        BasicConfigurationNode, GsonConfigurationLoader, GsonConfigurationLoader.Builder> {

    public GsonConfigurationFormat() {
        super("gson", GsonConfigurationLoader::builder, UnmodifiableCollections.toSet("json"));
    }
}
```

--------------------------------

### Example HOCON configuration file

Source: https://github.com/spongepowered/configurate/wiki/Getting-Started

A sample HOCON configuration file named myproject.conf. It contains a name string, a messages object with a count and a mood enum value.

```hocon
name = "Alice"
messages {
    # Alice hasn't checked their messages in a while
    count = 20
    mood = CONFUSED
}
```

--------------------------------

### JacksonConfigurationLoader usage example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-jackson.md

Shows how to build a JacksonConfigurationLoader with a path, custom indent, and no-space field value separator, then load a configuration, modify a node, and save it. The loader tolerates comments, single quotes, and unquoted field names.

```java
final JacksonConfigurationLoader loader = JacksonConfigurationLoader.builder()
        .path(Paths.get("settings.json"))
        .indent(4)
        .fieldValueSeparatorStyle(FieldValueSeparatorStyle.NO_SPACE)
        .build();

final BasicConfigurationNode root = loader.load();
// Loader tolerates comments/single quotes/unquoted field names
root.node("server", "port").raw(8443);
loader.save(root);
```

--------------------------------

### Load, modify, and save XML with XmlConfigurationLoader

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-xml.md

Demonstrates loading, modifying, and saving an XML configuration file using XmlConfigurationLoader. The example sets the path and indent, loads the root node, reads an attribute, adds a child node with a tag name and attribute, then saves the changes.

```java
final XmlConfigurationLoader loader = XmlConfigurationLoader.builder()
        .path(Paths.get("config.xml"))
        .indent(4)
        .build();

final AttributedConfigurationNode root = loader.load();
final String host = root.attribute("host");                 // root <attribute>s
final AttributedConfigurationNode first = root.node("server");
first.tagName("server");                                    // element name
first.addAttribute("port", "8080");                         // <server port="8080">
loader.save(root);
```

--------------------------------

### AbstractConfigurationFormat

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/loader-format.md

Documentation for the AbstractConfigurationFormat class, including its constructor, methods, and an example subclass.

```APIDOC
## AbstractConfigurationFormat

### Description
Reduces boilerplate for formats built on AbstractConfigurationLoader. Subclasses must expose a zero-argument constructor for ServiceLoader.

### Constructor
`protected AbstractConfigurationFormat(final String id, final Supplier<B> builderMaker, final Set<String> supportedExtensions)`

### Methods
- `String id()` - Returns the format identifier.
- `Set<String> supportedExtensions()` - Returns the set of supported file extensions.
- `ConfigurationLoader<? extends @NonNull Object> create(final Path file)` - Creates a loader for the given file path.
- `ConfigurationLoader<? extends @NonNull Object> create(final Path file, final ConfigurationNode options)` - Creates a loader for the given file path with options.
- `ConfigurationLoader<? extends @NonNull Object> create(final URL url)` - Creates a loader for the given URL.
- `ConfigurationLoader<? extends @NonNull Object> create(final URL url, final ConfigurationNode options)` - Creates a loader for the given URL with options.

### Example Provider
```java
public final class GsonConfigurationFormat extends AbstractConfigurationFormat<
        BasicConfigurationNode, GsonConfigurationLoader, GsonConfigurationLoader.Builder> {

    public GsonConfigurationFormat() {
        super("gson", GsonConfigurationLoader::builder, UnmodifiableCollections.toSet("json"));
    }
}
```
```

--------------------------------

### Usage - Guice module wiring

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/extra-guice.md

Shows how to bind ObjectMapper.Factory to GuiceObjectMapperProvider in a Guice module and use the injected factory to create and load a mapper for a @ConfigSerializable type. Includes commented bind example for dependencies and demonstrates loading a ServerConfig from a ConfigurationNode.

```java
final Injector injector = Guice.createInjector(new AbstractModule() {
    @Override protected void configure() {
        // Provide the mapper factory itself
        bind(ObjectMapper.Factory.class).toProvider(GuiceObjectMapperProvider.class);
        // Bind dependencies of your @ConfigSerializable types:
        //   bind(Database.class).to(PostgresDatabase.class);
    }
});

// Later, wherever Guice injects ObjectMapper.Factory:
final ObjectMapper<ServerConfig> mapper = factory.get(ServerConfig.class);
final ServerConfig config = mapper.load(node);
```

--------------------------------

### Set up WatchServiceListener and ValueReferences

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/examples.md

Creates a WatchServiceListener, listens to a configuration file, and sets up typed references for name, cookie-count, and complex objects. Subscribes to update and error events, then saves the configuration after initialization.

```java
this.listener = WatchServiceListener.create();
this.base = this.listener.listenToConfiguration(file -> HoconConfigurationLoader.builder()
        .defaultOptions(opts -> opts.shouldCopyDefaults(true))
        .path(file)
        .build(), configFile);

// Perform actions on successful and unsuccessful reloads
this.base.updates().subscribe($ -> System.out.println("Configuration auto-reloaded"));
this.base.errors().subscribe(err -> {
    final Throwable thr = err.getValue();
    System.out.println("Unable to " + err.getKey() + " the configuration: " + thr.getMessage());
    if (thr.getCause() != null) {
        System.out.println(thr.getCause().getMessage());
    }
});

// Get node references
this.name = this.base.referenceTo(String.class, "name");
this.name.subscribe(newName -> System.out.println("Reloaded, name is: " + newName));
this.cookieCount = this.base.referenceTo(Integer.class, NodePath.path("cookie-count"), 5);
this.complex = this.base.referenceTo(new TypeToken<List<TestObject>>() {}, "complex");

this.base.save(); // save now that values have been initialized
```

--------------------------------

### TypeSerializerCollection class API

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/serialization.md

Shows the public methods of TypeSerializerCollection, including get overloads and builder accessors. The get(Class) method throws for raw parameterized types, and get(AnnotatedType) is available since 4.2.0.

```java
public final class TypeSerializerCollection {

    public <T> @Nullable TypeSerializer<T> get(final TypeToken<T> token)
    public <T> @Nullable TypeSerializer<T> get(final Class<T> token)       // throws for raw parameterized types
    public @Nullable TypeSerializer<?> get(final Type type)
    public @Nullable TypeSerializer<?> get(final AnnotatedType type)       // since 4.2.0
    public Builder childBuilder()
    public static Builder builder()     // no parent
    public static TypeSerializerCollection defaults()
}
```

--------------------------------

### Discover format at runtime with ConfigurationFormat.forExtension

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/loader-format.md

Uses ConfigurationFormat.forExtension("yaml") to obtain a format without compile-time dependencies. The result may be null if the format is not available. If non-null, creates a ConfigurationLoader for the given path and loads a ConfigurationNode.

```java
// Discover formats at runtime without compile-time dependencies
final ConfigurationFormat format = ConfigurationFormat.forExtension("yaml"); // may be null
if (format != null) {
    final ConfigurationLoader<? extends @NonNull Object> loader = format.create(Paths.get("settings.yml"));
    final ConfigurationNode node = loader.load();
}
```

--------------------------------

### NodeStyle.BLOCK output example

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-yaml.md

Example YAML output for NodeStyle.BLOCK, which always uses block style.

```yaml
key:
  - value
```

--------------------------------

### Initial configuration before transformation

Source: https://github.com/spongepowered/configurate/wiki/Transformations-and-Visitors

Input configuration file before applying the initialTransform. Shows the original structure with serverVersion and section prefixes.

```hocon
serverVersion=1.15-1
section {
    red {
        prefix="happy"
    },
    green {
        prefix="grumpy"
    }
}
```

--------------------------------

### Typed read with error handling

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/core-node.md

Shows typed reads with error handling: get(int.class, 8080) returns the default 8080 on null, while get(UUID.class) returns null if missing. Both throw SerializationException on deserialization failure.

```java
final int port;
try {
    port = root.node("server", "port").get(int.class, 8080);
} catch (final SerializationException e) {
    System.err.println("Invalid 'server.port': " + e.getMessage());
}

final @Nullable UUID id = root.node("client", "id").get(UUID.class);
```

--------------------------------

### ConfigurationTransformation.Builder.moveStrategy()

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/transformations.md

Gets the current move strategy.

```APIDOC
## ConfigurationTransformation.Builder.moveStrategy()

### Description
Gets the current move strategy.

### Method
instance

### Signature
`public MoveStrategy moveStrategy()`

### Returns
The current `MoveStrategy`.
```

--------------------------------

### JacksonConfigurationLoader.Builder.indent()

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-jackson.md

Gets the configured indentation width.

```APIDOC
## JacksonConfigurationLoader.Builder.indent()

### Description
Returns the current indentation setting.

### Method
public

### Endpoint
JacksonConfigurationLoader.Builder.indent()

### Parameters
None

### Returns
The current indentation value as an int.

### Example
```java
int indent = builder.indent();
```

```

--------------------------------

### Serializing complex types: Bukkit getLocation vs Configurate get(Location.class)

Source: https://github.com/spongepowered/configurate/wiki/From-Bukkit-Configuration

Compares retrieving a complex type: Bukkit has specific methods for Bukkit types, while Configurate uses Type Serializers via the get(TypeToken<T>, Object) method.

```java
conf.getLocation("a.b")
```

```java
conf.node("a", "b").get(Location.class)
```

--------------------------------

### JacksonConfigurationLoader.Builder.fieldValueSeparatorStyle()

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-jackson.md

Gets the configured field-value separator style.

```APIDOC
## JacksonConfigurationLoader.Builder.fieldValueSeparatorStyle()

### Description
Returns the current field-value separator style.

### Method
public

### Endpoint
JacksonConfigurationLoader.Builder.fieldValueSeparatorStyle()

### Parameters
None

### Returns
The current FieldValueSeparatorStyle.

### Example
```java
FieldValueSeparatorStyle style = builder.fieldValueSeparatorStyle();
```

```

--------------------------------

### ConfigurateOps.instance()

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/extra-dfu.md

Returns a shared DynamicOps<ConfigurationNode> instance for DFU operations. Optionally enables compressed key encoding.

```APIDOC
## ConfigurateOps.instance()

### Description
Returns a shared DynamicOps<ConfigurationNode> instance for DFU operations. When compressed is true, switches key encoding to the compact type/data leaf form used in compressed DFU values.

### Method
GET

### Endpoint
ConfigurateOps.instance()

### Parameters
#### Query Parameters
- **compressed** (boolean) - Optional - If true, enables compressed key encoding.

### Request Example
// No request body required

### Response
#### Success Response (200)
- **result** (DynamicOps<ConfigurationNode>) - A shared instance of DynamicOps<ConfigurationNode>.

#### Response Example
// Returns a DynamicOps<ConfigurationNode> instance
```

--------------------------------

### Build Configurate with Gradle

Source: https://github.com/spongepowered/configurate/blob/trunk/README.md

Builds Configurate. Compiled JAR files are placed in ./build/libs of each subproject, labeled like '<subproject>-x.x.x-SNAPSHOT.jar'. Requires Java 17 to build; Gradle will download necessary JDK versions.

```bash
gradle build
```

--------------------------------

### ConfigurationOptions.shouldCopyDefaults()

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/configuration-options.md

Returns whether defaults passed to get getters are written back into the node.

```APIDOC
## ConfigurationOptions.shouldCopyDefaults()

### Description
Returns whether defaults passed to get getters are written back into the node.

### Method
Getter

### Signature
`public abstract boolean shouldCopyDefaults()`

### Returns
`boolean` - true if defaults are copied, false otherwise.
```

--------------------------------

### JacksonConfigurationLoader.Builder.build()

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/format-jackson.md

Constructs a configured JacksonConfigurationLoader.

```APIDOC
## JacksonConfigurationLoader.Builder.build()

### Description
Builds a JacksonConfigurationLoader with the current builder settings.

### Method
public

### Endpoint
JacksonConfigurationLoader.Builder.build()

### Parameters
None

### Returns
A new JacksonConfigurationLoader instance.

### Example
```java
JacksonConfigurationLoader loader = JacksonConfigurationLoader.builder()
    .path(Paths.get("settings.json"))
    .indent(4)
    .fieldValueSeparatorStyle(FieldValueSeparatorStyle.NO_SPACE)
    .build();
```

```

--------------------------------

### ConfigurationNode Reading Methods

Source: https://github.com/spongepowered/configurate/blob/trunk/_autodocs/api-reference/core-node.md

All get, require, and primitive convenience methods for reading values from a ConfigurationNode.

```APIDOC
## get(TypeToken<V>)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(TypeToken<V>)

### Parameters
#### Path Parameters
- **type** (TypeToken<V>) - Required - The type token to deserialize to.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, or null if the node value is null.

#### Response Example
```java
V value = node.get(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(TypeToken<V>, V def)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the default value (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(TypeToken<V>, V def)

### Parameters
#### Path Parameters
- **type** (TypeToken<V>) - Required - The type token to deserialize to.
- **def** (V) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, or the default if the node value is null.

#### Response Example
```java
V value = node.get(type, def);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(TypeToken<V>, Supplier<V>)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the value from the supplier (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the node value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(TypeToken<V>, Supplier<V>)

### Parameters
#### Path Parameters
- **type** (TypeToken<V>) - Required - The type token to deserialize to.
- **defSupplier** (Supplier<V>) - Required - Supplier of the default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, or the supplied default if the node value is null.

#### Response Example
```java
V value = node.get(type, defSupplier);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(Class<V>)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(Class<V>)

### Parameters
#### Path Parameters
- **type** (Class<V>) - Required - The class to deserialize to.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, or null if the node value is null.

#### Response Example
```java
V value = node.get(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(Class<V>, V def)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the default value (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(Class<V>, V def)

### Parameters
#### Path Parameters
- **type** (Class<V>) - Required - The class to deserialize to.
- **def** (V) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, or the default if the node value is null.

#### Response Example
```java
V value = node.get(type, def);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(Class<V>, Supplier<V>)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the value from the supplier (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the node value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(Class<V>, Supplier<V>)

### Parameters
#### Path Parameters
- **type** (Class<V>) - Required - The class to deserialize to.
- **defSupplier** (Supplier<V>) - Required - Supplier of the default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, or the supplied default if the node value is null.

#### Response Example
```java
V value = node.get(type, defSupplier);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(Type)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(Type)

### Parameters
#### Path Parameters
- **type** (Type) - Required - The type to deserialize to.

### Response
#### Success Response (200)
- **value** (Object) - The deserialized value, or null if the node value is null.

#### Response Example
```java
Object value = node.get(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(Type, Object)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the default value (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(Type, Object)

### Parameters
#### Path Parameters
- **type** (Type) - Required - The type to deserialize to.
- **def** (Object) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (Object) - The deserialized value, or the default if the node value is null.

#### Response Example
```java
Object value = node.get(type, def);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(Type, Supplier<?>)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the value from the supplier (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the node value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(Type, Supplier<?>)

### Parameters
#### Path Parameters
- **type** (Type) - Required - The type to deserialize to.
- **defSupplier** (Supplier<?>) - Required - Supplier of the default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (Object) - The deserialized value, or the supplied default if the node value is null.

#### Response Example
```java
Object value = node.get(type, defSupplier);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(AnnotatedType)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Throws SerializationException on failure. Available since 4.2.0.

### Method
GET

### Endpoint
ConfigurationNode.get(AnnotatedType)

### Parameters
#### Path Parameters
- **type** (AnnotatedType) - Required - The annotated type to deserialize to.

### Response
#### Success Response (200)
- **value** (Object) - The deserialized value, or null if the node value is null.

#### Response Example
```java
Object value = node.get(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(AnnotatedType, Object)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the default value (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(AnnotatedType, Object)

### Parameters
#### Path Parameters
- **type** (AnnotatedType) - Required - The annotated type to deserialize to.
- **def** (Object) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (Object) - The deserialized value, or the default if the node value is null.

#### Response Example
```java
Object value = node.get(type, def);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## get(AnnotatedType, Supplier<?>)

### Description
Deserializes the node's raw value using the TypeSerializer resolved from options().serializers(), falling back to a plain instanceof cast when no serializer exists. Returns the value from the supplier (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the node value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.get(AnnotatedType, Supplier<?>)

### Parameters
#### Path Parameters
- **type** (AnnotatedType) - Required - The annotated type to deserialize to.
- **defSupplier** (Supplier<?>) - Required - Supplier of the default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (Object) - The deserialized value, or the supplied default if the node value is null.

#### Response Example
```java
Object value = node.get(type, defSupplier);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## getList(TypeToken<V>)

### Description
Deserializes the node's raw value as a list of the given element type. Unwraps list children; a scalar node is treated as a single-element list. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.getList(TypeToken<V>)

### Parameters
#### Path Parameters
- **type** (TypeToken<V>) - Required - The type token of the list element type.

### Response
#### Success Response (200)
- **value** (List<V>) - The deserialized list, or null if the node value is null.

#### Response Example
```java
List<V> value = node.getList(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## getList(TypeToken<V>, List<V> def)

### Description
Deserializes the node's raw value as a list of the given element type. Unwraps list children; a scalar node is treated as a single-element list. Returns the default value (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.getList(TypeToken<V>, List<V> def)

### Parameters
#### Path Parameters
- **elementType** (TypeToken<V>) - Required - The type token of the list element type.
- **def** (List<V>) - Required - The default list to return if the node value is null.

### Response
#### Success Response (200)
- **value** (List<V>) - The deserialized list, or the default if the node value is null.

#### Response Example
```java
List<V> value = node.getList(elementType, def);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## getList(Class<V>)

### Description
Deserializes the node's raw value as a list of the given element type. Unwraps list children; a scalar node is treated as a single-element list. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.getList(Class<V>)

### Parameters
#### Path Parameters
- **type** (Class<V>) - Required - The class of the list element type.

### Response
#### Success Response (200)
- **value** (List<V>) - The deserialized list, or null if the node value is null.

#### Response Example
```java
List<V> value = node.getList(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## getList(Class<V>, List<V>)

### Description
Deserializes the node's raw value as a list of the given element type. Unwraps list children; a scalar node is treated as a single-element list. Returns the default value (and, if options().shouldCopyDefaults(), writes it into the node) rather than throwing when the value is null. Throws SerializationException on failure.

### Method
GET

### Endpoint
ConfigurationNode.getList(Class<V>, List<V>)

### Parameters
#### Path Parameters
- **elementType** (Class<V>) - Required - The class of the list element type.
- **def** (List<V>) - Required - The default list to return if the node value is null.

### Response
#### Success Response (200)
- **value** (List<V>) - The deserialized list, or the default if the node value is null.

#### Response Example
```java
List<V> value = node.getList(elementType, def);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
```

```APIDOC
## require(TypeToken<V>)

### Description
Asserts a non-null result from get(TypeToken<V>). Throws NoSuchElementException when get returns null. Available since 4.1.0.

### Method
GET

### Endpoint
ConfigurationNode.require(TypeToken<V>)

### Parameters
#### Path Parameters
- **type** (TypeToken<V>) - Required - The type token to deserialize to.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, guaranteed non-null.

#### Response Example
```java
V value = node.require(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
- **NoSuchElementException** - Thrown when get returns null.
```

```APIDOC
## require(Class<V>)

### Description
Asserts a non-null result from get(Class<V>). Throws NoSuchElementException when get returns null. Available since 4.1.0.

### Method
GET

### Endpoint
ConfigurationNode.require(Class<V>)

### Parameters
#### Path Parameters
- **type** (Class<V>) - Required - The class to deserialize to.

### Response
#### Success Response (200)
- **value** (V) - The deserialized value, guaranteed non-null.

#### Response Example
```java
V value = node.require(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
- **NoSuchElementException** - Thrown when get returns null.
```

```APIDOC
## require(Type)

### Description
Asserts a non-null result from get(Type). Throws NoSuchElementException when get returns null. Available since 4.1.0.

### Method
GET

### Endpoint
ConfigurationNode.require(Type)

### Parameters
#### Path Parameters
- **type** (Type) - Required - The type to deserialize to.

### Response
#### Success Response (200)
- **value** (Object) - The deserialized value, guaranteed non-null.

#### Response Example
```java
Object value = node.require(type);
```

### Error Handling
- **SerializationException** - Thrown when deserialization fails.
- **NoSuchElementException** - Thrown when get returns null.
```

```APIDOC
## getString()

### Description
Convenience getter for a String value, delegating to Scalars.STRING. Returns null if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getString()

### Response
#### Success Response (200)
- **value** (String) - The string value, or null if the node value is null.

#### Response Example
```java
String value = node.getString();
```
```

```APIDOC
## getString(String def)

### Description
Convenience getter for a String value, delegating to Scalars.STRING. Returns the default if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getString(String def)

### Parameters
#### Path Parameters
- **def** (String) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (String) - The string value, or the default if the node value is null.

#### Response Example
```java
String value = node.getString(def);
```
```

```APIDOC
## getFloat()

### Description
Convenience getter for a float value, delegating to Scalars. Returns 0 (NUMBER_DEF) if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getFloat()

### Response
#### Success Response (200)
- **value** (float) - The float value, or 0 if the node value is null.

#### Response Example
```java
float value = node.getFloat();
```
```

```APIDOC
## getFloat(float def)

### Description
Convenience getter for a float value, delegating to Scalars. Returns the default if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getFloat(float def)

### Parameters
#### Path Parameters
- **def** (float) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (float) - The float value, or the default if the node value is null.

#### Response Example
```java
float value = node.getFloat(def);
```
```

```APIDOC
## getDouble()

### Description
Convenience getter for a double value, delegating to Scalars. Returns 0 (NUMBER_DEF) if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getDouble()

### Response
#### Success Response (200)
- **value** (double) - The double value, or 0 if the node value is null.

#### Response Example
```java
double value = node.getDouble();
```
```

```APIDOC
## getDouble(double def)

### Description
Convenience getter for a double value, delegating to Scalars. Returns the default if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getDouble(double def)

### Parameters
#### Path Parameters
- **def** (double) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (double) - The double value, or the default if the node value is null.

#### Response Example
```java
double value = node.getDouble(def);
```
```

```APIDOC
## getInt()

### Description
Convenience getter for an int value, delegating to Scalars. Returns 0 (NUMBER_DEF) if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getInt()

### Response
#### Success Response (200)
- **value** (int) - The int value, or 0 if the node value is null.

#### Response Example
```java
int value = node.getInt();
```
```

```APIDOC
## getInt(int def)

### Description
Convenience getter for an int value, delegating to Scalars. Returns the default if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getInt(int def)

### Parameters
#### Path Parameters
- **def** (int) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (int) - The int value, or the default if the node value is null.

#### Response Example
```java
int value = node.getInt(def);
```
```

```APIDOC
## getLong()

### Description
Convenience getter for a long value, delegating to Scalars. Returns 0 (NUMBER_DEF) if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getLong()

### Response
#### Success Response (200)
- **value** (long) - The long value, or 0 if the node value is null.

#### Response Example
```java
long value = node.getLong();
```
```

```APIDOC
## getLong(long def)

### Description
Convenience getter for a long value, delegating to Scalars. Returns the default if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getLong(long def)

### Parameters
#### Path Parameters
- **def** (long) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (long) - The long value, or the default if the node value is null.

#### Response Example
```java
long value = node.getLong(def);
```
```

```APIDOC
## getBoolean()

### Description
Convenience getter for a boolean value, delegating to Scalars. Returns false if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getBoolean()

### Response
#### Success Response (200)
- **value** (boolean) - The boolean value, or false if the node value is null.

#### Response Example
```java
boolean value = node.getBoolean();
```
```

```APIDOC
## getBoolean(boolean def)

### Description
Convenience getter for a boolean value, delegating to Scalars. Returns the default if the node value is null.

### Method
GET

### Endpoint
ConfigurationNode.getBoolean(boolean def)

### Parameters
#### Path Parameters
- **def** (boolean) - Required - The default value to return if the node value is null.

### Response
#### Success Response (200)
- **value** (boolean) - The boolean value, or the default if the node value is null.

#### Response Example
```java
boolean value = node.getBoolean(def);
```
```
Tokens:
Raw