A B C D E F G H I J K L M N O P R S T U V W X Y 
All Classes All Packages

A

AbstractConfigurationFormat<N extends ScopedConfigurationNode<N>,​L extends AbstractConfigurationLoader<N>,​B extends AbstractConfigurationLoader.Builder<B,​L>> - Class in org.spongepowered.configurate.loader
An implementation of ConfigurationFormat designed to work with AbstractConfigurationLoader.
AbstractConfigurationFormat(String, Supplier<B>, Set<String>) - Constructor for class org.spongepowered.configurate.loader.AbstractConfigurationFormat
Create a new configuration format.
AbstractConfigurationLoader<N extends ScopedConfigurationNode<N>> - Class in org.spongepowered.configurate.loader
Base class for many stream-based configuration loaders.
AbstractConfigurationLoader(AbstractConfigurationLoader.Builder<?, ?>, CommentHandler[]) - Constructor for class org.spongepowered.configurate.loader.AbstractConfigurationLoader
Create a loader instance from a builder.
AbstractConfigurationLoader.Builder<T extends AbstractConfigurationLoader.Builder<T,​L>,​L extends AbstractConfigurationLoader<?>> - Class in org.spongepowered.configurate.loader
An abstract builder implementation for AbstractConfigurationLoaders.
AbstractListChildSerializer<T> - Class in org.spongepowered.configurate.serialize
A serializer for nodes that are 'list-like' (i.e may be stored in nodes where ConfigurationNode.isList() is true.
AbstractListChildSerializer() - Constructor for class org.spongepowered.configurate.serialize.AbstractListChildSerializer
Create a new serializer, only for use by subclasses.
accept(I, Object, Supplier<Object>) - Method in interface org.spongepowered.configurate.objectmapping.FieldData.Deserializer
Apply either a new value or implicit initializer to the intermediate object as appropriate.
accept(String, AnnotatedType, AnnotatedElement, FieldData.Deserializer<I>, CheckedFunction<V, Object, Exception>) - Method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer.FieldCollector
Accept metadata that defines a specific field.
accept(V) - Method in interface org.spongepowered.configurate.util.CheckedConsumer
Accept a value.
acceptsType(Class<?>) - Method in class org.spongepowered.configurate.ConfigurationOptions
Gets whether objects of the provided type are natively accepted as values for nodes with this as their options object.
act(CheckedConsumer<? super N, E>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Execute an action on this node.
addAction(NodePath, TransformAction) - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.Builder
Adds an action to the transformation.
addAttribute(String, String) - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Adds an attribute to this node.
addConstraint(Class<A>, Class<T>, Constraint.Factory<A, T>) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Register a Constraint that will be used to validate fields.
addConstraint(Class<A>, Constraint.Factory<A, Object>) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Register a Constraint that will be used to validate fields.
addDiscoverer(FieldDiscoverer<?>) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Add a discoverer for a type of object.
addNodeResolver(NodeResolver.Factory) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Add a resolver that will locate a node for a field.
addProcessor(Class<A>, Class<T>, Processor.Factory<A, T>) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Register a Processor that will process fields after write.
addProcessor(Class<A>, Processor.Factory<A, Object>) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Register a Processor that will process fields after write.
addType(DSL.TypeReference, Object...) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
Map values at path to being of type.
addType(DSL.TypeReference, Object...) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
Map values at path to being of type.
addType(DSL.TypeReference, NodePath) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
Map values at path to being of type.
addType(DSL.TypeReference, NodePath) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
Map values at path to being of type.
addVersion(int, ConfigurationTransformation) - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.VersionedBuilder
Adds a transformation to this builder for the given version.
addVersion(int, ConfigurationTransformation...) - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.VersionedBuilder
Adds a new series of transformations for a version.
allSuperTypes(Type) - Static method in class org.spongepowered.configurate.util.Types
Get all supertypes of this object with type parameters.
allSuperTypesAndInterfaces(Type) - Static method in class org.spongepowered.configurate.util.Types
Get all supertypes and interfaces of the provided type.
appendListNode() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets a new child node created as the next entry in the list.
appendListNode() - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Gets a new child node created as the next entry in the list.
apply(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation
 
apply(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation
 
apply(I) - Method in interface org.spongepowered.configurate.util.CheckedFunction
Perform the action.
apply(ConfigurationNode) - Method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation
Apply this transformation to a given node.
array() - Method in interface org.spongepowered.configurate.NodePath
Returns a copy of the original path array.
asTypeSerializer() - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory
Creates a TypeSerializer that uses this factory.
atomicBufferedWriter(Path, Charset) - Static method in class org.spongepowered.configurate.loader.AtomicFiles
Creates and returns an "atomic" writer for the given path.
AtomicFiles - Class in org.spongepowered.configurate.loader
A utility for creating "atomic" file writers.
atomicWriterFactory(Path, Charset) - Static method in class org.spongepowered.configurate.loader.AtomicFiles
Creates and returns an "atomic" writer factory for the given path.
attribute(String) - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Gets the value of an attribute, or null if this node doesn't have the given attribute.
AttributedConfigurationNode - Interface in org.spongepowered.configurate
A configuration node that can have both comments and attributes attached.
attributes() - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Gets the attributes this node has.
attributes(Map<String, String>) - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Sets the attributes of this node.

B

BasicConfigurationNode - Interface in org.spongepowered.configurate
A standard configuration node, without any additional options.
begin() - Method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer.InstanceFactory
Return a new instance of the intermediary type to be populated.
beginTransaction(V) - Method in interface org.spongepowered.configurate.reactive.TransactionalSubscriber
Receive a new value, and validate it.
beginVisit(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
Called at the beginning of the visit with a state object created.
beginVisit(ConfigurationNode, Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
beginVisit(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
Called at the beginning of the visit with a state object created.
beginVisit(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
BLOCK - org.spongepowered.configurate.yaml.NodeStyle
Always use block style.
BOOLEAN - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for boolean values.
box(Type) - Static method in class org.spongepowered.configurate.util.Types
Box the input type if it is an unboxed primitive Class.
build() - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Create a new ops instance.
build() - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
Create a new transformation based on the provided info.
build() - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Create a new ops instance.
build() - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
Create a new transformation based on the provided info.
build() - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader.Builder
 
build() - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader.Builder
 
build() - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder
 
build() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Builds the loader.
build() - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Create a new factory using the current configuration.
build() - Method in class org.spongepowered.configurate.reference.WatchServiceListener.Builder
Create a new listener, using default values for any unset parameters.
build() - Method in class org.spongepowered.configurate.RepresentationHint.Builder
Create a new hint from the provided options.
build() - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Create a new type serializer collection.
build() - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.Builder
Builds the transformation.
build() - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.VersionedBuilder
Builds the transformation.
build() - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
 
build() - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader.Builder
 
buildAndLoadString(String) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Configure to read from a string, build, and load in one step.
buildAndSaveString(ConfigurationNode) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Configure to write to a string, build, and save in one step.
builder() - Static method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new builder for an ops instance.
builder() - Static method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new builder for an ops instance.
builder() - Static method in class org.spongepowered.configurate.gson.GsonConfigurationLoader
Creates a new GsonConfigurationLoader builder.
builder() - Static method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader
Creates a new HoconConfigurationLoader builder.
builder() - Static method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader
Creates a new JacksonConfigurationLoader builder.
builder() - Static method in class org.spongepowered.configurate.reference.WatchServiceListener
Returns a new builder for a WatchServiceListener to create a customized listener.
builder() - Static method in class org.spongepowered.configurate.RepresentationHint
Create a builder for a new hint.
builder() - Static method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
Create a builder for a new type serializer collection without a parent set.
builder() - Static method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation
Create a new builder to create a basic configuration transformation.
builder() - Static method in class org.spongepowered.configurate.xml.XmlConfigurationLoader
Creates a new XmlConfigurationLoader builder.
builder() - Static method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader
Creates a new YamlConfigurationLoader builder.
Builder() - Constructor for class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
 
Builder() - Constructor for class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
 
Builder() - Constructor for class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Create a new builder.
buildMap(Consumer<Map<K, V>>) - Static method in class org.spongepowered.configurate.util.UnmodifiableCollections
Build an unmodifiable map.
buildWrapping(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Build a new ops instance, returned as part of a Dynamic.
buildWrapping(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Build a new ops instance, returned as part of a Dynamic.
BYTE - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for Byte values.

C

cache() - Method in interface org.spongepowered.configurate.reactive.Publisher
Return a publisher that will track its most recent value.
cache(V) - Method in interface org.spongepowered.configurate.reactive.Publisher
Create a cached publisher with an initial value.
CAMEL_CASE - org.spongepowered.configurate.util.NamingSchemes
Reformats names to camelCase style.
canCreateInstances() - Method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer.InstanceFactory
Get whether or not new object instances can be created.
canCreateInstances() - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
Get whether or not this mapper is capable of creating new instances of its mapped type.
canLoad() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
 
canLoad() - Method in interface org.spongepowered.configurate.loader.ConfigurationLoader
Gets if this loader is capable of loading configurations.
canSave() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
 
canSave() - Method in interface org.spongepowered.configurate.loader.ConfigurationLoader
Gets if this loader is capable of saving configurations.
chain(ConfigurationTransformation...) - Static method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation
Creates a chain of ConfigurationTransformations.
CHAR - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for char values.
checkCanWrite(ConfigurationNode) - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader
 
checkCanWrite(ConfigurationNode) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader
 
checkCanWrite(ConfigurationNode) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
Perform format-specific validation of a node.
CheckedConsumer<V,​E extends Throwable> - Interface in org.spongepowered.configurate.util
A functional interface similar to Consumer, except allowing contained methods to throw exceptions.
CheckedFunction<I,​O,​E extends Exception> - Interface in org.spongepowered.configurate.util
A function with one input and one output which may throw a checked exception.
CheckedSupplier<V,​E extends Throwable> - Interface in org.spongepowered.configurate.util
A functional interface similar to Supplier, except allowing contained methods to throw exceptions.
childBuilder() - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
Create a new builder to begin building a collection of type serializers that inherits from this collection.
childrenList() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the "list children" attached to this node, if it has any.
childrenList() - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Gets the "list children" attached to this node, if it has any.
childrenMap() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the "map children" attached to this node, if it has any.
childrenMap() - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Gets the "map children" attached to this node, if it has any.
close() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
close() - Method in class org.spongepowered.configurate.reference.WatchServiceListener
 
closeIfUnsubscribed() - Method in interface org.spongepowered.configurate.reactive.Processor
Close this processor if there are no remaining subscriptions.
codec(TypeToken<S>) - Static method in class org.spongepowered.configurate.extra.dfu.v3.DfuSerializers
Create a new codec that uses the default type serializer collection to serialize an object of the provided type.
codec(TypeToken<S>) - Static method in class org.spongepowered.configurate.extra.dfu.v4.DfuSerializers
Create a new codec that uses the default type serializer collection to serialize an object of the provided type.
codec(TypeToken<V>, TypeSerializerCollection) - Static method in class org.spongepowered.configurate.extra.dfu.v3.DfuSerializers
Create a new codec based on a Configurate TypeSerializer.
codec(TypeToken<V>, TypeSerializerCollection) - Static method in class org.spongepowered.configurate.extra.dfu.v4.DfuSerializers
Create a new codec based on a Configurate TypeSerializer.
coerce(String) - Method in interface org.spongepowered.configurate.util.NamingScheme
Given an input string of unknown formatting, make it follow a naming scheme.
CoercionFailedException - Exception in org.spongepowered.configurate.serialize
Error thrown when a value fails to be converted to an expected type.
CoercionFailedException(Object, String) - Constructor for exception org.spongepowered.configurate.serialize.CoercionFailedException
Indicate that a value transformation has failed.
CoercionFailedException(Type, Object, String) - Constructor for exception org.spongepowered.configurate.serialize.CoercionFailedException
Indicate that a value transformation has failed.
column() - Method in exception org.spongepowered.configurate.loader.ParsingException
Column most closely associated with the error.
combinedAnnotations(AnnotatedElement...) - Static method in class org.spongepowered.configurate.util.Types
Get an element containing the annotations of all the provided elements.
comment() - Method in interface org.spongepowered.configurate.CommentedConfigurationNodeIntermediary
Gets the current value for the comment.
comment(String) - Method in interface org.spongepowered.configurate.CommentedConfigurationNodeIntermediary
Sets the comment for this configuration node.
Comment - Annotation Type in org.spongepowered.configurate.objectmapping.meta
A comment that will be applied to a configuration node if possible.
CommentedConfigurationNode - Interface in org.spongepowered.configurate
A configuration node that can have a comment attached to it.
CommentedConfigurationNodeIntermediary<N extends CommentedConfigurationNodeIntermediary<N>> - Interface in org.spongepowered.configurate
Intermediate interface for different types of commented configuration nodes.
CommentHandler - Interface in org.spongepowered.configurate.loader
Extracts comments from a buffered reader or collection of lines.
CommentHandlers - Enum in org.spongepowered.configurate.loader
Defines a number of default CommentHandlers.
commentIfAbsent(String) - Method in interface org.spongepowered.configurate.CommentedConfigurationNodeIntermediary
Set a comment on this node if it does not presently have a comment.
comments() - Static method in interface org.spongepowered.configurate.objectmapping.meta.Processor
Apply comments from Comment annotation on save.
commit() - Method in interface org.spongepowered.configurate.reactive.TransactionalSubscriber
Expose a transaction's result.
complete(I) - Method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer.InstanceFactory
Return a finalized object based on the provided intermediate.
complete(Object, I) - Method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer.MutableInstanceFactory
Apply the intermediate data to an existing object.
composite(LoaderOptionSource...) - Static method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Create an option source that will try the provided sources in order.
compressed(boolean) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Set whether Keyable values should be compressed.
compressed(boolean) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Set whether Keyable values should be compressed.
compressMaps() - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Whether data passed through this ops will be compressed or not.
compressMaps() - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Whether data passed through this ops will be compressed or not.
ConfigSerializable - Annotation Type in org.spongepowered.configurate.objectmapping
Indicates that the given type is capable of being serialized and deserialized by an object mapper.
CONFIGURATE_LINE_PATTERN - Static variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
A pattern that will match line breaks in comments.
CONFIGURATE_LINE_SEPARATOR - Static variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
The escape sequence used by Configurate to separate comment lines.
ConfigurateException - Exception in org.spongepowered.configurate
Any sort of error thrown within Configurate.
ConfigurateException() - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new unknown exception.
ConfigurateException(String, Throwable) - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new exception with informational message and cause.
ConfigurateException(String) - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new exception at unknown path with provided informational message.
ConfigurateException(Throwable) - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new exception with a cause and unknown message.
ConfigurateException(ConfigurationNode, String, Throwable) - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new exception pre-initialized with path, message, and cause.
ConfigurateException(ConfigurationNode, String) - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new exception pre-initialized with path and message.
ConfigurateException(ConfigurationNode, Throwable) - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new exception pre-initialized with path and cause.
ConfigurateException(NodePath, String, Throwable) - Constructor for exception org.spongepowered.configurate.ConfigurateException
Create a new exception pre-initialized with path, message, and cause.
ConfigurateOps - Class in org.spongepowered.configurate.extra.dfu.v2
Implementation of DataFixerUpper's DynamicOps.
ConfigurateOps - Class in org.spongepowered.configurate.extra.dfu.v3
Implementation of DataFixerUpper's DynamicOps.
ConfigurateOps - Class in org.spongepowered.configurate.extra.dfu.v4
Implementation of DataFixerUpper's DynamicOps.
ConfigurateOps.Protection - Enum in org.spongepowered.configurate.extra.dfu.v3
Protection level for configuration node accesses through ops instance.
ConfigurateOps.Protection - Enum in org.spongepowered.configurate.extra.dfu.v4
Protection level for configuration node accesses through ops instance.
ConfigurateOpsBuilder - Class in org.spongepowered.configurate.extra.dfu.v3
A builder for ConfigurateOps instances.
ConfigurateOpsBuilder - Class in org.spongepowered.configurate.extra.dfu.v4
A builder for ConfigurateOps instances.
ConfigurationFormat - Interface in org.spongepowered.configurate.loader
A service provider interface declaring a specific configuration format.
ConfigurationLoader<N extends ConfigurationNode> - Interface in org.spongepowered.configurate.loader
Represents an object which can load and save ConfigurationNode objects in a specific configuration format.
ConfigurationNode - Interface in org.spongepowered.configurate
A node in the configuration tree.
ConfigurationNodeFactory<N extends ConfigurationNode> - Interface in org.spongepowered.configurate
Something that can create a customized node.
ConfigurationOptions - Class in org.spongepowered.configurate
This object is a holder for general configuration options.
ConfigurationReference<N extends ConfigurationNode> - Interface in org.spongepowered.configurate.reference
An updating reference to a base configuration node.
ConfigurationReference.ErrorPhase - Enum in org.spongepowered.configurate.reference
Representing the phase where an error occurred.
ConfigurationTransformation - Interface in org.spongepowered.configurate.transformation
Represents a set of transformations on a configuration.
ConfigurationTransformation.Builder - Class in org.spongepowered.configurate.transformation
ConfigurationTransformation.Versioned - Interface in org.spongepowered.configurate.transformation
A transformation that is aware of node versions.
ConfigurationTransformation.VersionedBuilder - Class in org.spongepowered.configurate.transformation
Builds a versioned ConfigurationTransformation.
ConfigurationVisitor<S,​T,​E extends Exception> - Interface in org.spongepowered.configurate
A visitor to traverse node hierarchies in a depth-first order.
ConfigurationVisitor.Safe<S,​T> - Interface in org.spongepowered.configurate
A subinterface for visitors that do not throw any checked exceptions during their execution.
ConfigurationVisitor.Stateless<E extends Exception> - Interface in org.spongepowered.configurate
Stateless specialization of visitors, where both the state and terminal type are Void.
Constraint<V> - Interface in org.spongepowered.configurate.objectmapping.meta
Perform a validation on data upon load.
Constraint.Factory<A extends Annotation,​V> - Interface in org.spongepowered.configurate.objectmapping.meta
Provider for a specific constraint given a field type.
context() - Method in exception org.spongepowered.configurate.loader.ParsingException
A context line from the source, if available.
convertTo(DynamicOps<U>, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a copy of the source node converted to a different data structure.
convertTo(DynamicOps<U>, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a copy of the source node converted to a different data structure.
copy() - Method in interface org.spongepowered.configurate.ConfigurationNode
Creates a deep copy of this node.
copy() - Method in interface org.spongepowered.configurate.NodePath
Create a new node path with the same data as this path.
copy() - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Creates a deep copy of this node.
COPY_DEEP - org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps.Protection
When an operation is executed on the node, make a deep copy of the result.
COPY_DEEP - org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps.Protection
When an operation is executed on the node, make a deep copy of the result.
copyOf(List<E>) - Static method in class org.spongepowered.configurate.util.UnmodifiableCollections
Creates an unmodifiable copy of the given List instance.
copyOf(Map<K, V>) - Static method in class org.spongepowered.configurate.util.UnmodifiableCollections
Creates an unmodifiable copy of the given Map instance.
copyOf(Set<E>) - Static method in class org.spongepowered.configurate.util.UnmodifiableCollections
Creates an unmodifiable copy of the given Set instance.
create() - Static method in interface org.spongepowered.configurate.reactive.Processor
Create a Processor instance that simply broadcasts submitted values to its subscribers.
create() - Static method in class org.spongepowered.configurate.reference.WatchServiceListener
Create a new WatchServiceListener using a new cached thread pool executor and the default filesystem.
create() - Method in interface org.spongepowered.configurate.util.MapFactory
Create a new map instance for the given types.
create(URL) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationFormat
 
create(URL) - Method in interface org.spongepowered.configurate.loader.ConfigurationFormat
Create a new loader configured to load from the provided URL, with default style options.
create(URL, ConfigurationNode) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationFormat
 
create(URL, ConfigurationNode) - Method in interface org.spongepowered.configurate.loader.ConfigurationFormat
Create a new loader configured to load from the provided URL.
create(Path) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationFormat
 
create(Path) - Method in interface org.spongepowered.configurate.loader.ConfigurationFormat
Create a new loader configured to load from the provided file, with default style options.
create(Path, ConfigurationNode) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationFormat
 
create(Path, ConfigurationNode) - Method in interface org.spongepowered.configurate.loader.ConfigurationFormat
Create a new loader configured to load from the provided file.
create(Executor) - Static method in interface org.spongepowered.configurate.reactive.Processor
Create a Processor instance that simply broadcasts submitted values to its subscribers.
createBoolean(boolean) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
createBoolean(boolean) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new node using this ops instance's node factory, and set its value to the provided boolean.
createBoolean(boolean) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new node using this ops instance's node factory, and set its value to the provided boolean.
createList(Stream<ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
createList(Stream<ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new node containing values emitted by input as list elements.
createList(Stream<ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new node containing values emitted by input as list elements.
createMap(Map<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
createMap(Map<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new node containing the map entries from the map values.
createMap(Map<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new node containing the map entries from the map values.
createMap(Stream<Pair<ConfigurationNode, ConfigurationNode>>) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new node containing the map entries from the stream values.
createMap(Stream<Pair<ConfigurationNode, ConfigurationNode>>) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new node containing the map entries from the stream values.
createNew(int, Type) - Method in class org.spongepowered.configurate.serialize.AbstractListChildSerializer
Create a new instance of the collection.
createNode() - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create a new node with default options.
createNode(ConfigurationOptions) - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader
 
createNode(ConfigurationOptions) - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create an empty node with the provided options.
createNode(ConfigurationOptions) - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader
 
createNode(ConfigurationOptions) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader
 
createNode(ConfigurationOptions) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader
 
createNode(ConfigurationOptions) - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader
 
createNode(ConfigurationOptions, CheckedConsumer<N, E>) - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create a new node with the provided options and initialize it with the provided action.
createNode(CheckedConsumer<N, E>) - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create a new node with default options and initialize it with the provided action.
createNumeric(Number) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
createNumeric(Number) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new node using this ops instance's node factory, and set its value to the provided number.
createNumeric(Number) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new node using this ops instance's node factory, and set its value to the provided number.
createString(String) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
createString(String) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new node using this ops instance's node factory, and set its value to the provided string.
createString(String) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new node using this ops instance's node factory, and set its value to the provided string.
createTransactional() - Static method in interface org.spongepowered.configurate.reactive.Processor
Create a processor instance that is aware of transactions.
createTransactional(Executor) - Static method in interface org.spongepowered.configurate.reactive.Processor
Create a processor instance that is aware of transactions.

D

dataFixer(DataFixer) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
Set the fixer to use to process.
dataFixer(DataFixer) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
Set the fixer to use to process.
DataFixerTransformation - Class in org.spongepowered.configurate.extra.dfu.v3
A transformation that exposes a single DataFixer to a configuration in a friendly way.
DataFixerTransformation - Class in org.spongepowered.configurate.extra.dfu.v4
A transformation that exposes a single DataFixer to a configuration in a friendly way.
DataFixerTransformation.Builder - Class in org.spongepowered.configurate.extra.dfu.v3
DataFixerTransformation.Builder - Class in org.spongepowered.configurate.extra.dfu.v4
DEFAULT_OPTIONS_SOURCE - Static variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
 
defaultCommentHandler() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
Gets the primary CommentHandler used by this loader.
defaultNamingScheme(NamingScheme) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory.Builder
Set the naming scheme to use as a default for field names.
defaultOptions - Variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
 
defaultOptions() - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Default options for the types of nodes created by this factory.
defaultOptions() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Gets the default configuration options to be used by the resultant loader.
defaultOptions() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
 
defaultOptions(UnaryOperator<ConfigurationOptions>) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the default configuration options to be used by the resultant loader by providing a function which takes the current default options and applies any desired changes.
defaultOptions(ConfigurationOptions) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the default configuration options to be used by the resultant loader.
defaults() - Static method in class org.spongepowered.configurate.ConfigurationOptions
Get the default set of options.
defaults() - Static method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
Get a collection containing all of Configurate's built-in type serializers.
defaultTagName() - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Gets the default tag name to be used by the resultant loader.
defaultTagName(String) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Sets the default tag name the resultant loader should use.
defaultValue() - Method in class org.spongepowered.configurate.RepresentationHint
If a value for a representation hint cannot be found by quering a node or any of this parents, the default value will be returned.
defaultValue(V) - Method in class org.spongepowered.configurate.RepresentationHint.Builder
Set the default value when this hint is not present in the hierarchy.
defaultValue(Class<?>) - Static method in class org.spongepowered.configurate.util.Types
Get the default value for a type.
deserialize(Object) - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
Attempt to deserialize the provided object using an unspecialized type.
deserialize(Type, Object) - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
Given an object of unknown type, attempt to convert it into the given type.
deserialize(Type, ConfigurationNode) - Method in class org.spongepowered.configurate.serialize.AbstractListChildSerializer
 
deserialize(Type, ConfigurationNode) - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
 
deserialize(Type, ConfigurationNode) - Method in interface org.spongepowered.configurate.serialize.TypeSerializer
Deserialize an object (of the correct type) from the given configuration node.
deserializeSingle(int, T, Object) - Method in class org.spongepowered.configurate.serialize.AbstractListChildSerializer
Place a single deserialized value into the collection being deserialized.
dfuBuilder() - Static method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation
Create a builder that can work with any DFU DataFixer.
dfuBuilder() - Static method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation
Create a builder that can work with any DFU DataFixer.
DfuSerializers - Class in org.spongepowered.configurate.extra.dfu.v3
A bridge between Configurate and DataFixerUpper serialization systems.
DfuSerializers - Class in org.spongepowered.configurate.extra.dfu.v4
A bridge between Configurate and DataFixerUpper serialization types.
discover(AnnotatedType, FieldDiscoverer.FieldCollector<I, V>) - Method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer
Inspect the target type for fields to be supplied to the collector.
Disposable - Interface in org.spongepowered.configurate.reactive
A representation of something that requires resources.
dispose() - Method in interface org.spongepowered.configurate.reactive.Disposable
Clean up and remove any references to resources used by this object.
DOUBLE - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for Double values.
DOUBLE_SLASH - org.spongepowered.configurate.loader.CommentHandlers
CommentHandler for comments prefixed by a // escape.

E

elementType(Type) - Method in class org.spongepowered.configurate.serialize.AbstractListChildSerializer
Given the type of container, provide the expected type of an element.
emitComments(boolean) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader.Builder
Set whether comments should be emitted.
emitJsonCompatible(boolean) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader.Builder
Set whether output generated by this loader should be json-compatible.
empty() - Method in interface org.spongepowered.configurate.ConfigurationNode
Return true when this node has a null or empty value.
empty() - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
empty() - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Create a new empty node using this ops instance's factory.
empty() - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Create a new empty node using this ops instance's factory.
empty() - Static method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation
Get an empty transformation.
emptyConstructorObject() - Static method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer
Create a new discoverer for object instance fields.
emptyFactoryBuilder() - Static method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
Create an empty builder.
emptyList() - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
 
emptyList() - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
 
emptyMap() - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
 
emptyMap() - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
 
emptyValue(Type, ConfigurationOptions) - Method in class org.spongepowered.configurate.serialize.AbstractListChildSerializer
 
emptyValue(Type, ConfigurationOptions) - Method in interface org.spongepowered.configurate.serialize.TypeSerializer
Create an empty value of the appropriate type.
endVisit() - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
Called after every node has been visited, to allow for cleanup and validation.
endVisit(Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
endVisit(S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
Called after every node has been visited, to allow for cleanup and validation.
endVisit(S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
enterListNode(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
enterListNode(ConfigurationNode, Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
enterListNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
enterListNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
enterMappingNode(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
enterMappingNode(ConfigurationNode, Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
enterMappingNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
enterMappingNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
enterNode(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
Called once per node, for every node.
enterNode(ConfigurationNode, Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
enterNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
Called once per node, for every node.
enterNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
enterScalarNode(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
enterScalarNode(ConfigurationNode, Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
enterScalarNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
enterScalarNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
ENUM - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for values in enum classes.
EnumLookup - Class in org.spongepowered.configurate.util
Utility class to cache more flexible enum lookup.
environmentVariables() - Static method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Retrieve loader options from environment variables.
environmentVariables(String) - Static method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Retrieve loader options from environment variables.
equals(Object) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
 
errors() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
A stream that will receive errors that occur while loading or saving to this reference.
execute(CheckedSupplier<V, E>) - Static method in interface org.spongepowered.configurate.reactive.Publisher
Execute an action returning a single value on the common ForkJoinPool, and pass the result to any subscribers.
execute(CheckedSupplier<V, E>, Executor) - Static method in interface org.spongepowered.configurate.reactive.Publisher
Execute an action returning a single value on the provided Executor, and pass the result to any subscribers.
executor() - Method in interface org.spongepowered.configurate.reactive.Publisher
Get the executor used to handle published events.
exitListNode(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
Called for a list node after the node and any of its children have been visited.
exitListNode(ConfigurationNode, Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
exitListNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
Called for a list node after the node and any of its children have been visited.
exitListNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
exitMappingNode(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
Called for a mapping node after the node and any of its children have been visited.
exitMappingNode(ConfigurationNode, Void) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
exitMappingNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor
Called for a list node after the node and any of its children have been visited.
exitMappingNode(ConfigurationNode, S) - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
expectedType() - Method in exception org.spongepowered.configurate.serialize.SerializationException
Get the desired type associated with the failed object mapping operation.
extractComment(BufferedReader, Iterable<CommentHandler>) - Static method in enum org.spongepowered.configurate.loader.CommentHandlers
Uses provided comment handlers to extract a comment from the reader.
extractHeader(BufferedReader) - Method in interface org.spongepowered.configurate.loader.CommentHandler
Defines the handlers behaviour for reading comments.
extractHeader(BufferedReader) - Method in enum org.spongepowered.configurate.loader.CommentHandlers
 

F

factory() - Static method in interface org.spongepowered.configurate.AttributedConfigurationNode
Create a new factory providing AttributedConfigurationNode instances.
factory() - Static method in interface org.spongepowered.configurate.BasicConfigurationNode
Create a new factory providing BasicConfigurationNode instances.
factory() - Static method in interface org.spongepowered.configurate.CommentedConfigurationNode
Create a new factory providing CommentedConfigurationNode instances.
factory() - Static method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
Get the default object mapper factory instance.
factory(ConfigurationNodeFactory<? extends ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Set the node factory for the returned ops.
factory(ConfigurationNodeFactory<? extends ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Set the node factory for the returned ops.
factoryBuilder() - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder
Gets the JsonFactory used to configure the implementation.
factoryBuilder() - Static method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
Create a builder populated with default settings.
factoryFromNode(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Set the node factory based on the options of the provided node.
factoryFromNode(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Set the node factory based on the options of the provided node.
factoryFromSerializers(TypeSerializerCollection) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Set a node factory that will use the provided collection.
factoryFromSerializers(TypeSerializerCollection) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Set a node factory that will use the provided collection.
failureMessage() - Method in annotation type org.spongepowered.configurate.objectmapping.meta.Matches
Message to throw in an exception when a match fails.
fallbackHandler(Subscriber<O>) - Method in interface org.spongepowered.configurate.reactive.Processor
Provide a Subscriber that will handle events submitted to this processor, but only if no other subscription is active.
FieldData<I,​O> - Class in org.spongepowered.configurate.objectmapping
Holder for field-specific information.
FieldData.Deserializer<I> - Interface in org.spongepowered.configurate.objectmapping
A deserialization handler to appropriately place object data into fields.
FieldDiscoverer<I> - Interface in org.spongepowered.configurate.objectmapping
Interface that gathers metadata from classes.
FieldDiscoverer.FieldCollector<I,​V> - Interface in org.spongepowered.configurate.objectmapping
A collector for the necessary metadata for fields.
FieldDiscoverer.InstanceFactory<I> - Interface in org.spongepowered.configurate.objectmapping
A handler that controls the deserialization process for an object.
FieldDiscoverer.MutableInstanceFactory<I> - Interface in org.spongepowered.configurate.objectmapping
A handler for working with mutable objects in the object mapper.
fields() - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
Get the parameters that will be handled by this mapper.
fieldValueSeparatorStyle() - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder
Gets the field value separator style to be used by the built loader.
fieldValueSeparatorStyle(FieldValueSeparatorStyle) - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder
Sets the field value separator style the resultant loader should use.
FieldValueSeparatorStyle - Enum in org.spongepowered.configurate.jackson
Enumeration of field value separator styles.
file(File) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the sink and source of the resultant loader to the given file.
fileSystem(FileSystem) - Method in class org.spongepowered.configurate.reference.WatchServiceListener.Builder
Set the filesystem expected to be used for paths.
fixed(ConfigurationLoader<? extends N>) - Static method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a new configuration reference that will only update when loaded.
flags() - Method in annotation type org.spongepowered.configurate.objectmapping.meta.Matches
Flags to pass to the compiled Pattern.
FLOAT - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for Float values.
FLOW - org.spongepowered.configurate.yaml.NodeStyle
Always use flow style.
forEachElement(T, CheckedConsumer<Object, SerializationException>) - Method in class org.spongepowered.configurate.serialize.AbstractListChildSerializer
Perform the provided action on each element of the provided collection.
forExtension(String) - Static method in interface org.spongepowered.configurate.loader.ConfigurationFormat
Get a configuration format that can handle the specified extension.
forSerializers(TypeSerializerCollection) - Static method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get an ops instance that will create nodes using the provided collection.
forSerializers(TypeSerializerCollection) - Static method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get an ops instance that will create nodes using the provided collection.
from(Consumer<V>) - Static method in interface org.spongepowered.configurate.util.CheckedConsumer
Create an instance from an ordinary consumer.
from(Function<I, O>) - Static method in interface org.spongepowered.configurate.util.CheckedFunction
Convert a JDK Function into its checked variant.
from(Supplier<V>) - Static method in interface org.spongepowered.configurate.util.CheckedSupplier
Create an instance from an ordinary supplier.
from(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationNode
Apply all data from other to this node, overwriting any existing data.
from(ConfigurationNode) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Apply all data from other to this node, overwriting any existing data.
from(LoaderOptionSource) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Populate this builder by reading options from the provided source.
fromNode(ConfigurationNode) - Static method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Configure an ops instance using the options of an existing node.
fromNode(ConfigurationNode) - Static method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Configure an ops instance using the options of an existing node.

G

get() - Method in class org.spongepowered.configurate.objectmapping.guice.GuiceObjectMapperProvider
Get the default factory, with guice support added.
get() - Method in interface org.spongepowered.configurate.reactive.Publisher.Cached
Get the last cached value.
get() - Method in interface org.spongepowered.configurate.reference.ValueReference
Get the current value at this node.
get() - Method in interface org.spongepowered.configurate.util.CheckedSupplier
Perform an operation that returns a value.
get(int) - Method in interface org.spongepowered.configurate.NodePath
Gets a specific element from the path array.
get(TypeToken<T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
Resolve a type serializer.
get(TypeToken<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(TypeToken<V>) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory
Get an object mapper for the provided type.
get(TypeToken<V>, Supplier<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(TypeToken<V>, V) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(Class<T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
Resolve a type serializer.
get(Class<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(Class<V>) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory
Get an object mapper for the unparameterized type clazz.
get(Class<V>, Supplier<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(Class<V>, V) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(Iterable<?>) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Get the node at the given path, relative to the root node.
get(Object...) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Get the node at the given path, relative to the root node.
get(Type) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(Type) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Factory
Get the object mapper for the provided type.
get(Type) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
Resolve a type serializer.
get(Type, Object) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(Type, Supplier<?>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node.
get(String...) - Method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Get the value at the provided path.
get(ConfigurationNode, String) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
get(ConfigurationNode, String) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Attempt to get the child of input at key.
get(ConfigurationNode, String) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Attempt to get the child of input at key.
getBoolean() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getBoolean(boolean) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getBoolean(boolean, String...) - Method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Get the value at the provided path as a boolean.
getDouble() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getDouble(double) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getDouble(double, String...) - Method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Get the value at the provided path as a double.
getEnum(Class<T>, String...) - Method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Get the value at the provided path as an enum constant.
getEnum(Class<T>, T, String...) - Method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Get the value at the provided path as an enum constant.
getFloat() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getFloat(float) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getGeneric(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
getGeneric(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get a child of the provided node at key.
getGeneric(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get a child of the provided node at key.
getInt() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getInt(int) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getInt(int, String...) - Method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Get the value at the provided path as an integer.
getList(TypeToken<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
getList(TypeToken<V>, Supplier<List<V>>) - Method in interface org.spongepowered.configurate.ConfigurationNode
If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
getList(TypeToken<V>, List<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
getList(Class<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
getList(Class<V>, Supplier<List<V>>) - Method in interface org.spongepowered.configurate.ConfigurationNode
If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
getList(Class<V>, List<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
If this node has list values, this function unwraps them and converts them to an appropriate type based on the provided function.
getList(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get a consumer that takes an action to perform on every element of list node input.
getList(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get a consumer that takes an action to perform on every element of list node input.
getLong() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getLong(long) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getMap(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get a map-like view of a copy of the contents of input.
getMap(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get a map-like view of a copy of the contents of input.
getMapValues(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
getMapValues(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Return a stream of pairs of (key, value) for map data in the input node.
getMapValues(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Return a stream of pairs of (key, value) for map data in the input node.
getMessage() - Method in exception org.spongepowered.configurate.ConfigurateException
Get a description of the location of this error, with path included.
getMessage() - Method in exception org.spongepowered.configurate.loader.ParsingException
 
getMessage() - Method in exception org.spongepowered.configurate.serialize.SerializationException
 
getNumberValue(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
getNumberValue(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get the value of the provided node if it is a number or boolean.
getNumberValue(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get the value of the provided node if it is a number or boolean.
getOr(String, String...) - Method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Get the value at the provided path.
getStream(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
getStream(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get the contents of list node input as a Stream of nodes.
getStream(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get the contents of list node input as a Stream of nodes.
getString() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getString(String) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the value typed using the appropriate type conversion from Scalars.
getStringValue(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
getStringValue(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get the value of the provided node if it is a scalar, converted to a String.
getStringValue(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get the value of the provided node if it is a scalar, converted to a String.
getType(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
GsonConfigurationFormat - Class in org.spongepowered.configurate.gson
A ConfigurationFormat for the GSON configuration loader.
GsonConfigurationFormat() - Constructor for class org.spongepowered.configurate.gson.GsonConfigurationFormat
For use by service loader only.
GsonConfigurationLoader - Class in org.spongepowered.configurate.gson
A loader for JSON-formatted configurations, using the GSON library for parsing and generation.
GsonConfigurationLoader.Builder - Class in org.spongepowered.configurate.gson
gsonSerializers() - Static method in class org.spongepowered.configurate.gson.GsonConfigurationLoader
Get a TypeSerializerCollection for handling Gson types.
GuiceObjectMapperProvider - Class in org.spongepowered.configurate.objectmapping.guice
A factory for ObjectMappers that will inherit the injector from wherever it is provided.

H

hasAttributes() - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Gets if this node has any attributes.
hasChild(Iterable<?>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Checks whether or not a non-virtual node is present at the relative path path.
hasChild(Object...) - Method in interface org.spongepowered.configurate.ConfigurationNode
Checks whether or not a non-virtual node is present at the relative path path.
HASH - org.spongepowered.configurate.loader.CommentHandlers
CommentHandler for comments prefixed by the # character.
hashCode() - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
 
hasSubscribers() - Method in interface org.spongepowered.configurate.reactive.Publisher
Return whether or not this Publisher has any subscribers.
header() - Method in class org.spongepowered.configurate.ConfigurationOptions
Gets the header specified in these options.
header(String) - Method in class org.spongepowered.configurate.ConfigurationOptions
Creates a new ConfigurationOptions instance, with the specified header set, and all other settings copied from this instance.
headerMode - Variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
 
headerMode() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Gets the header mode to be used by the resultant loader.
headerMode(HeaderMode) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the header mode of the resultant loader.
HeaderMode - Enum in org.spongepowered.configurate.loader
Modes which ConfigurationLoaders can use to manipulate headers when loading/saving.
hint(RepresentationHint<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Query a representation hint from this node.
hint(RepresentationHint<V>, V) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set a representation hint on this node.
hint(RepresentationHint<V>, V) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
 
HoconConfigurationFormat - Class in org.spongepowered.configurate.hocon
A ConfigurationFormat for the HOCON configuration loader.
HoconConfigurationFormat() - Constructor for class org.spongepowered.configurate.hocon.HoconConfigurationFormat
For use by service loader only.
HoconConfigurationLoader - Class in org.spongepowered.configurate.hocon
A loader for HOCON (Hodor)-formatted configurations, using the lightbend config library for parsing and generation.
HoconConfigurationLoader.Builder - Class in org.spongepowered.configurate.hocon

I

id() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationFormat
 
id() - Method in interface org.spongepowered.configurate.loader.ConfigurationFormat
An identifier describing this loader.
identifier() - Method in class org.spongepowered.configurate.RepresentationHint
An identifier used to represent this hint in error messages.
identifier(String) - Method in class org.spongepowered.configurate.RepresentationHint.Builder
Set the identifier to refer to this hint.
immutableMapEntry(K, V) - Static method in class org.spongepowered.configurate.util.UnmodifiableCollections
Creates an immutable instance of Map.Entry.
implicitInitialization() - Method in class org.spongepowered.configurate.ConfigurationOptions
Get whether values should be implicitly initialized.
implicitInitialization(boolean) - Method in class org.spongepowered.configurate.ConfigurationOptions
Create a new ConfigurationOptions instance with the specified implicit initialization setting.
includesXmlDeclaration() - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Gets if the resultant loader should include the XML declaration header when saving.
includesXmlDeclaration(boolean) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Sets if the resultant loader should include the XML declaration header when saving.
indent() - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader.Builder
Gets the level of indentation to be used by the resultant loader.
indent() - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder
Gets the level of indentation to be used by the resultant loader.
indent() - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Gets the level of indentation to be used by the resultant loader.
indent() - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader.Builder
Gets the level of indentation to be used by the resultant loader.
indent(int) - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader.Builder
Sets the level of indentation the resultant loader should use.
indent(int) - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder
Sets the level of indentation the resultant loader should use.
indent(int) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Sets the level of indentation the resultant loader should use.
indent(int) - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader.Builder
Sets the level of indentation the resultant loader should use.
inheritable() - Method in class org.spongepowered.configurate.RepresentationHint
Get whether or not this hint can draw its value from parent nodes.
inheritable(boolean) - Method in class org.spongepowered.configurate.RepresentationHint.Builder
Set whether or not the hint can be inherited.
initPath(Supplier<NodePath>) - Method in exception org.spongepowered.configurate.ConfigurateException
Initialize path if none has been set.
initType(Type) - Method in exception org.spongepowered.configurate.serialize.SerializationException
Initialize the expected type.
inject(O) - Method in interface org.spongepowered.configurate.reactive.Processor
Submit an element of the observed type, bypassing any mapping this Processor may do.
inject(V) - Method in interface org.spongepowered.configurate.reactive.Processor.Iso
 
injectedObjectDiscoverer(Injector) - Static method in class org.spongepowered.configurate.objectmapping.guice.GuiceObjectMapperProvider
Create a field discoverer that uses the provided injector.
insertionOrdered() - Static method in class org.spongepowered.configurate.util.MapFactories
Returns a MapFactory which creates maps which are sorted by insertion order.
instance() - Static method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
Get the shared instance of this class, which creates new nodes using the default factory.
instance() - Static method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get the shared instance of this class, which creates new nodes using the default factory.
instance() - Static method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get the shared instance of this class, which creates new nodes using the default factory.
instance(boolean) - Static method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get the shared instance of this class, which creates new nodes using the default factory.
instance(boolean) - Static method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get the shared instance of this class, which creates new nodes using the default factory.
INTEGER - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for Integer values.
isArray(Type) - Static method in class org.spongepowered.configurate.util.Types
Get if the provided type is an array type.
isBlank(String) - Static method in class org.spongepowered.configurate.util.Strings
Return if the input string is empty or has no non-whitespace characters.
isBoxedPrimitive(Type) - Static method in class org.spongepowered.configurate.util.Types
Get whether or not the provided input type is a boxed primitive type.
isList() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets if this node has "list children".
isMap() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets if this node has "map children".
isNull() - Method in interface org.spongepowered.configurate.ConfigurationNode
Get if this node has a 'null' value.
isValid(Object) - Method in class org.spongepowered.configurate.objectmapping.FieldData
Test if an object would be valid for this field.
iterator() - Method in interface org.spongepowered.configurate.NodePath
Returns an iterator over the path.

J

JacksonConfigurationFormat - Class in org.spongepowered.configurate.jackson
A ConfigurationFormat for the Jackson configuration loader.
JacksonConfigurationFormat() - Constructor for class org.spongepowered.configurate.jackson.JacksonConfigurationFormat
For use by service loader only.
JacksonConfigurationLoader - Class in org.spongepowered.configurate.jackson
A loader for JSON-formatted configurations, using the jackson library for parsing and generation.
JacksonConfigurationLoader.Builder - Class in org.spongepowered.configurate.jackson

K

key() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the "key" of this node.
keyFromSetting() - Static method in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver
Creates resolvers that get the node at a key defined by Setting.

L

latestVersion() - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation
 
latestVersion() - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation
 
latestVersion() - Method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation.Versioned
Get the latest version that nodes can be updated to.
lenient() - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader.Builder
Gets if the resultant loader should parse leniently.
lenient(boolean) - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader.Builder
Sets if the resultant loader should parse leniently.
line() - Method in exception org.spongepowered.configurate.loader.ParsingException
Line most closely associated with this error.
listenToConfiguration(Function<Path, ConfigurationLoader<? extends N>>, Path) - Method in class org.spongepowered.configurate.reference.WatchServiceListener
Create a new ConfigurationReference subscribed to FS updates.
listenToDirectory(Path, Subscriber<WatchEvent<?>>) - Method in class org.spongepowered.configurate.reference.WatchServiceListener
Listen to a directory.
listenToFile(Path, Subscriber<WatchEvent<?>>) - Method in class org.spongepowered.configurate.reference.WatchServiceListener
Listen for changes to a specific file or directory.
load() - Method in interface org.spongepowered.configurate.loader.ConfigurationLoader
Attempts to load a ConfigurationNode using this loader, from the defined source.
load() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Reload a configuration using the provided loader.
load(ConfigurationOptions) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader
 
load(ConfigurationNode) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
Create a new object instance.
load(ConfigurationOptions) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
 
load(ConfigurationOptions) - Method in interface org.spongepowered.configurate.loader.ConfigurationLoader
Attempts to load a ConfigurationNode using this loader, from the defined source.
load(V, ConfigurationNode) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper.Mutable
Load data from node into an existing instance.
loader() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Get the loader this reference uses to load and save its node.
LoaderOptionSource - Interface in org.spongepowered.configurate.loader
A provider for ConfigurationLoader options.
LOADING - org.spongepowered.configurate.reference.ConfigurationReference.ErrorPhase
While loading a configuration node from an external location.
loadInternal(N, BufferedReader) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
Using a created node, attempt to read a configuration file.
loadInternal(AttributedConfigurationNode, BufferedReader) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader
 
loadInternal(BasicConfigurationNode, BufferedReader) - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader
 
loadInternal(BasicConfigurationNode, BufferedReader) - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader
 
loadInternal(CommentedConfigurationNode, BufferedReader) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader
 
loadInternal(CommentedConfigurationNode, BufferedReader) - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader
 
loadToReference() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
 
loadToReference() - Method in interface org.spongepowered.configurate.loader.ConfigurationLoader
Attempts to load data from the defined source into a ConfigurationReference.
localizedComments(ResourceBundle) - Static method in interface org.spongepowered.configurate.objectmapping.meta.Processor
Apply localized comments from Comment annotation on save.
localizedPattern(ResourceBundle) - Static method in interface org.spongepowered.configurate.objectmapping.meta.Constraint
Require values to match the pattern provided.
LONG - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for Long values.
lookupEnum(Class<T>, String) - Static method in class org.spongepowered.configurate.util.EnumLookup
Perform a fuzzy lookup of key in enum clazz.
LOWER_CASE_DASHED - org.spongepowered.configurate.util.NamingSchemes
Reformats names to lower-case-dashed format.

M

make(A, Type) - Method in interface org.spongepowered.configurate.objectmapping.meta.Constraint.Factory
Create a new specialized constraint.
make(A, Type) - Method in interface org.spongepowered.configurate.objectmapping.meta.Processor.Factory
Create a new processor given the annotation and data type.
make(String, AnnotatedElement) - Method in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver.Factory
Create a function that resolves a child node from its parent.
makeList(Class<T>) - Static method in class org.spongepowered.configurate.util.Types
Given an element type, create a new list type.
makeListType(TypeToken<T>) - Static method in class org.spongepowered.configurate.util.Types
Given an element type, create a new list type.
makeMap(TypeToken<K>, TypeToken<V>) - Static method in class org.spongepowered.configurate.util.Types
Given an element type, create a new Map type.
makeMap(TypeToken<K>, Class<V>) - Static method in class org.spongepowered.configurate.util.Types
Given an element type, create a new Map type.
makeMap(Class<K>, TypeToken<V>) - Static method in class org.spongepowered.configurate.util.Types
Given an element type, create a new Map type.
makeMap(Class<K>, Class<V>) - Static method in class org.spongepowered.configurate.util.Types
Given an element type, create a new Map type.
makeVersion(int, Consumer<? super ConfigurationTransformation.Builder>) - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.VersionedBuilder
Create and add a new transformation to this builder.
map(CheckedFunction<? super O, ? extends R, TransactionFailedException>) - Method in interface org.spongepowered.configurate.reactive.Processor
Create a new publisher that will transform events published.
map(CheckedFunction<? super V, ? extends R, TransactionFailedException>) - Method in interface org.spongepowered.configurate.reactive.Publisher
Create a new publisher that will transform events published.
MapFactories - Class in org.spongepowered.configurate.util
Default implementations of MapFactory.
mapFactory() - Method in class org.spongepowered.configurate.ConfigurationOptions
Gets the MapFactory specified in these options.
mapFactory(MapFactory) - Method in class org.spongepowered.configurate.ConfigurationOptions
Creates a new ConfigurationOptions instance, with the specified MapFactory set, and all other settings copied from this instance.
MapFactory - Interface in org.spongepowered.configurate.util
A factory which creates thread-safe map instances.
mappedType() - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
The generic type of object that this mapper instance handles.
Matches - Annotation Type in org.spongepowered.configurate.objectmapping.meta
Constrains a field value to ensure it matches the provided expression.
merge(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
Merge into a newly created node.
MERGE - org.spongepowered.configurate.transformation.MoveStrategy
mergeFrom(ConfigurationNode) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set all the values from the given node that are not present in this node to their values in the provided node.
mergeFrom(ConfigurationNode) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Set all the values from the given node that are not present in this node to their values in the provided node.
mergeInto(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
mergeInto(ConfigurationNode, ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
mergeToList(ConfigurationNode, List<ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Appends nodes in values to copy of list node input.
mergeToList(ConfigurationNode, List<ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Appends nodes in values to copy of list node input.
mergeToList(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Appends element value to list node input.
mergeToList(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Appends element value to list node input.
mergeToMap(ConfigurationNode, ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Update the child of input at key with value.
mergeToMap(ConfigurationNode, ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Update the child of input at key with value.
mergeToPrimitive(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Return a result where if prefix is empty, the node is value, but otherwise returns an error.
mergeToPrimitive(ConfigurationNode, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Return a result where if prefix is empty, the node is value, but otherwise returns an error.
move(T, T) - Method in enum org.spongepowered.configurate.transformation.MoveStrategy
Moves source to target.
moveStrategy() - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.Builder
Gets the move strategy to be used by the resultant transformation.
moveStrategy(MoveStrategy) - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.Builder
Sets the mode strategy to be used by the resultant transformation.
MoveStrategy - Enum in org.spongepowered.configurate.transformation
Strategy to use when moving a node from one path to another.

N

name() - Method in class org.spongepowered.configurate.objectmapping.FieldData
The name of the field.
NamingScheme - Interface in org.spongepowered.configurate.util
An enforced style of naming.
NamingSchemes - Enum in org.spongepowered.configurate.util
Standard naming schemes.
nativeTypes(Set<Class<?>>) - Method in class org.spongepowered.configurate.ConfigurationOptions
Creates a new ConfigurationOptions instance, with the specified native types set, and all other settings copied from this instance.
newState() - Method in interface org.spongepowered.configurate.ConfigurationVisitor
Called to provide a state object if a visit is initiated without one already existing.
newState() - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Safe
 
newState() - Method in interface org.spongepowered.configurate.ConfigurationVisitor.Stateless
 
NO_SPACE - org.spongepowered.configurate.jackson.FieldValueSeparatorStyle
Style which uses no spaces.
node() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Get the base node this reference refers to.
node() - Method in interface org.spongepowered.configurate.reference.ValueReference
Get the node this value reference points to.
node(Iterable<?>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the node at the given (relative) path, possibly traversing multiple levels of nodes.
node(Iterable<?>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Gets the node at the given (relative) path, possibly traversing multiple levels of nodes.
node(Object...) - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the node at the given (relative) path, possibly traversing multiple levels of nodes.
node(Object...) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Gets the node at the given (relative) path, possibly traversing multiple levels of nodes.
node(ConfigurationNode) - Static method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Create an option source that will read from an existing configuration node.
nodeFromParent() - Static method in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver
A resolver that uses the containing node of a field.
nodeFromParent() - Method in annotation type org.spongepowered.configurate.objectmapping.meta.Setting
Whether a field should use its containing node for its value.
nodeKey() - Static method in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver
Creates resolvers that provide the key of the containing node for values.
NodeKey - Annotation Type in org.spongepowered.configurate.objectmapping.meta
Marks a field that gets its value from the node's key.
NodePath - Interface in org.spongepowered.configurate
Represents the path to a given node.
NodeResolver - Interface in org.spongepowered.configurate.objectmapping.meta
A function to resolve nodes for a specific field.
NodeResolver.Factory - Interface in org.spongepowered.configurate.objectmapping.meta
Provides fields.
nodeStyle() - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader.Builder
Gets the node style to be used by the resultant loader.
nodeStyle(NodeStyle) - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader.Builder
Sets the node style the built loader should use.
NodeStyle - Enum in org.spongepowered.configurate.yaml
Representation of collections and mappings in a YAML document.
NONE - org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps.Protection
Directly pass on nodes, still attached to their original structure.
NONE - org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps.Protection
Directly pass on nodes, still attached to their original structure.
NONE - org.spongepowered.configurate.loader.HeaderMode
Ignore any header present in input, and do not output any header.
NUMBER_DEF - Static variable in interface org.spongepowered.configurate.ConfigurationNode
Default value for unknown number results.

O

object(CheckedFunction<AnnotatedType, Supplier<Object>, SerializationException>) - Static method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer
Create a new discoverer for object instance fields.
object(CheckedFunction<AnnotatedType, Supplier<Object>, SerializationException>, String) - Static method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer
Create a new discoverer for object instance fields.
ObjectMapper<V> - Interface in org.spongepowered.configurate.objectmapping
A mapper that converts between configuration nodes and Java objects.
ObjectMapper.Factory - Interface in org.spongepowered.configurate.objectmapping
Provider for object mappers.
ObjectMapper.Factory.Builder - Interface in org.spongepowered.configurate.objectmapping
A builder for a configured factory producing object mappers.
ObjectMapper.Mutable<V> - Interface in org.spongepowered.configurate.objectmapping
An object mapper capable of loading data into an existing object.
of(Class<T>, BiFunction<T, Predicate<Class<?>>, Object>, CheckedFunction<Object, T, SerializationException>) - Static method in interface org.spongepowered.configurate.serialize.TypeSerializer
Given the provided functions, create a new serializer for a scalar value.
of(Object[]) - Static method in interface org.spongepowered.configurate.NodePath
Create a node path reference.
of(Type, BiFunction<T, Predicate<Class<?>>, Object>, CheckedFunction<Object, T, SerializationException>) - Static method in interface org.spongepowered.configurate.serialize.TypeSerializer
Given the provided functions, create a new serializer for a scalar value.
of(String, TypeToken<V>) - Static method in class org.spongepowered.configurate.RepresentationHint
Create a new basic representation hint.
of(String, Class<V>) - Static method in class org.spongepowered.configurate.RepresentationHint
Create a new basic representation hint.
of(Collection<?>) - Static method in interface org.spongepowered.configurate.NodePath
Create a node path reference.
onClose() - Method in interface org.spongepowered.configurate.reactive.Subscriber
When the Publisher this is subscribed to closes without error, this method will be called.
onError(Throwable) - Method in interface org.spongepowered.configurate.reactive.Subscriber
When an error occurs while subscribing to an Publisher, or is thrown during the execution of Subscriber.submit(Object) that is not otherwise handled, this method will be called with the error.
onlyWithAnnotation(Class<? extends Annotation>) - Static method in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver
A resolver that skips any field not annotated with annotation.
onlyWithSetting() - Static method in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver
A resolver that will skip any field not annotated with Setting.
options() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the options that currently apply to this node.
org.spongepowered.configurate - package org.spongepowered.configurate
Core node data structures and supports
org.spongepowered.configurate.extra.dfu.v2 - package org.spongepowered.configurate.extra.dfu.v2
Integration with DataFixerUpper v2.
org.spongepowered.configurate.extra.dfu.v3 - package org.spongepowered.configurate.extra.dfu.v3
Implementation of DataFixerUpper interfaces for Configurate types.
org.spongepowered.configurate.extra.dfu.v4 - package org.spongepowered.configurate.extra.dfu.v4
Implementation of DataFixerUpper interfaces for Configurate types.
org.spongepowered.configurate.gson - package org.spongepowered.configurate.gson
Configuration loader for the JSON format.
org.spongepowered.configurate.hocon - package org.spongepowered.configurate.hocon
Configuration loader for the HOCON library.
org.spongepowered.configurate.jackson - package org.spongepowered.configurate.jackson
Configuration loader for the JSON format using Jackson.
org.spongepowered.configurate.loader - package org.spongepowered.configurate.loader
Base infrastructure for configuration loaders
org.spongepowered.configurate.objectmapping - package org.spongepowered.configurate.objectmapping
Object mapper to handle converting between raw nodes and POJOs.
org.spongepowered.configurate.objectmapping.guice - package org.spongepowered.configurate.objectmapping.guice
An extension to the object mapper that will create constructors using Guice Injectors.
org.spongepowered.configurate.objectmapping.meta - package org.spongepowered.configurate.objectmapping.meta
Metadata annotations for use with the object mapper.
org.spongepowered.configurate.reactive - package org.spongepowered.configurate.reactive
This package contains a rudimentary implementation of a reactive programming API.
org.spongepowered.configurate.reference - package org.spongepowered.configurate.reference
File watcher and infrastructure to support dynamically updating configurations.
org.spongepowered.configurate.serialize - package org.spongepowered.configurate.serialize
Type serializer mechanisms and the standard type serializers shipped with Configurate.
org.spongepowered.configurate.transformation - package org.spongepowered.configurate.transformation
Configuration tree transformations
org.spongepowered.configurate.util - package org.spongepowered.configurate.util
Utilities for implementation.
org.spongepowered.configurate.xml - package org.spongepowered.configurate.xml
Configuration loader for the XML format.
org.spongepowered.configurate.yaml - package org.spongepowered.configurate.yaml
Configuration loader for the YAML 1.1 format.
override() - Method in annotation type org.spongepowered.configurate.objectmapping.meta.Comment
Whether or not to override existing comments on a node.
OVERWRITE - org.spongepowered.configurate.transformation.MoveStrategy
ownHint(RepresentationHint<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Query a representation hint from this node.
ownHints() - Method in interface org.spongepowered.configurate.ConfigurationNode
Get an unmodifiable copy of representation hints stored on this node.

P

parent() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the parent of this node.
parent() - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Gets the parent of this node.
ParsingException - Exception in org.spongepowered.configurate.loader
Indicates an error that occurred while parsing the configuration.
ParsingException(int, int, String, String, Throwable) - Constructor for exception org.spongepowered.configurate.loader.ParsingException
Create a new parsing exception.
ParsingException(ConfigurationNode, int, int, String, String, Throwable) - Constructor for exception org.spongepowered.configurate.loader.ParsingException
Create a new parsing exception.
ParsingException(ConfigurationNode, int, int, String, String) - Constructor for exception org.spongepowered.configurate.loader.ParsingException
Create a new parsing exception.
PASSTHROUGH - org.spongepowered.configurate.util.NamingSchemes
Passes through names unchanged.
path() - Method in exception org.spongepowered.configurate.ConfigurateException
Get the path associated with this failure.
path() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets the full path of keys from the root node to this node.
path() - Static method in interface org.spongepowered.configurate.NodePath
Get an empty node path.
path(Object...) - Static method in interface org.spongepowered.configurate.NodePath
Create a node path reference.
path(Path) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the sink and source of the resultant loader to the given path.
pattern() - Static method in interface org.spongepowered.configurate.objectmapping.meta.Constraint
Require values to match the pattern provided.
PATTERN - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for Pattern values.
plus(NodePath) - Method in interface org.spongepowered.configurate.NodePath
Create a new path from the combination of this and other.
populate(LoaderOptionSource) - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader.Builder
 
populate(LoaderOptionSource) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader.Builder
 
populate(LoaderOptionSource) - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader.Builder
 
populate(LoaderOptionSource) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Populate options from the provided source.
populate(LoaderOptionSource) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
 
populate(LoaderOptionSource) - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader.Builder
 
PRESERVE - org.spongepowered.configurate.loader.HeaderMode
Use the header loaded from an existing file, replacing any header set in the options.
PRESET - org.spongepowered.configurate.loader.HeaderMode
Ignore any header present in input, and output a header if one has been set in the options.
prettyPrinting(boolean) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader.Builder
Set whether output from this loader will be pretty-printed or not.
process(V, ConfigurationNode) - Method in interface org.spongepowered.configurate.objectmapping.meta.Processor
Transform the output node on write.
Processor<V> - Interface in org.spongepowered.configurate.objectmapping.meta
Performs a transformation on a value annotated with a specific type.
Processor<I,​O> - Interface in org.spongepowered.configurate.reactive
A combination of an Publisher and Subscriber.
Processor.Factory<A extends Annotation,​T> - Interface in org.spongepowered.configurate.objectmapping.meta
Provider to, given an annotation instance and the type it's on, create a Processor.
Processor.Iso<V> - Interface in org.spongepowered.configurate.reactive
A Processor that has the same type for inputs and outputs.
Processor.Transactional<I,​O> - Interface in org.spongepowered.configurate.reactive
A processor that supports transactions.
Processor.TransactionalIso<V> - Interface in org.spongepowered.configurate.reactive
A processor that supports transactions using the same input and outputs.
Publisher<V> - Interface in org.spongepowered.configurate.reactive
Something that can publish events.
Publisher.Cached<V> - Interface in org.spongepowered.configurate.reactive
A publisher that caches the last value received.

R

raw() - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the raw value of this node.
raw(Object) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set the raw value of this node.
raw(Object) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Set the raw value of this node.
rawMessage() - Method in exception org.spongepowered.configurate.ConfigurateException
Get the exception's message without any extra formatting.
rawScalar() - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the raw value of this node if the node is a scalar.
readProtection(ConfigurateOps.Protection) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Set how nodes returned from read methods will be protected from modification.
readProtection(ConfigurateOps.Protection) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Set how nodes returned from read methods will be protected from modification.
readWriteProtection(ConfigurateOps.Protection) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Set how nodes will be protected from both read and write modifications.
readWriteProtection(ConfigurateOps.Protection) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Set how nodes will be protected from both read and write modifications.
record() - Static method in interface org.spongepowered.configurate.objectmapping.FieldDiscoverer
Create a new field discoverer that will handle record classes.
referenceTo(TypeToken<T>, Object...) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a reference to the node at the provided path.
referenceTo(TypeToken<T>, NodePath) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a reference to the node at the provided path.
referenceTo(TypeToken<T>, NodePath, T) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a reference to the node at the provided path.
referenceTo(Class<T>, Object...) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a reference to the node at the provided path.
referenceTo(Class<T>, NodePath) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a reference to the node at the provided path.
referenceTo(Class<T>, NodePath, T) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a reference to the node at the provided path.
register(TypeToken<T>, TypeSerializer<? super T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register a type serializer for a given type.
register(Class<T>, TypeSerializer<? super T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register a type serializer for a given type.
register(Predicate<Type>, TypeSerializer<? super T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register a type serializer matching against a given predicate.
register(ScalarSerializer<T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register a scalar serializer with its own attached type token.
registerAll(TypeSerializerCollection) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register all serializers from other into this collection.
registerAnnotatedObjects(ObjectMapper.Factory) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register a customized object mapper to handle ConfigSerializable-annotated objects.
registerExact(TypeToken<T>, TypeSerializer<? super T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register an exact type serializer for a given type.
registerExact(Class<T>, TypeSerializer<? super T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register an exact type serializer for a given type.
registerExact(ScalarSerializer<T>) - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection.Builder
Register a scalar serializer with its own attached type token.
remove() - Static method in interface org.spongepowered.configurate.transformation.TransformAction
Create a transform action that will remove the node at a specified path.
remove(ConfigurationNode, String) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
remove(ConfigurationNode, String) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Get a copy of input without the value at node key.
remove(ConfigurationNode, String) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Get a copy of input without the value at node key.
removeAttribute(String) - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Removes an attribute from this node.
removeChild(Object) - Method in interface org.spongepowered.configurate.ConfigurationNode
Removes a direct child of this node.
rename(Object) - Static method in interface org.spongepowered.configurate.transformation.TransformAction
Rename a node
repeat(String, int) - Static method in class org.spongepowered.configurate.util.Strings
Create a new string with the contents of the provided string repeated times times.
RepresentationHint<V> - Class in org.spongepowered.configurate
A flag for configuration loaders describing how a node should be serialized.
RepresentationHint.Builder<V> - Class in org.spongepowered.configurate
A builder for RepresentationHints.
require(TypeToken<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node, asserting that it is non-null.
require(Class<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node, asserting that it is non-null.
require(Type) - Method in interface org.spongepowered.configurate.ConfigurationNode
Get the current value associated with this node, asserting that it is non-null.
requireCompleteParameters(Type) - Static method in class org.spongepowered.configurate.util.Types
Throw an exception if the passed type is raw (missing parameters)..
required() - Static method in interface org.spongepowered.configurate.objectmapping.meta.Constraint
Require a value to be present for fields marked with the annotation T.
Required - Annotation Type in org.spongepowered.configurate.objectmapping.meta
Indicates that a field is required.
resolve(ConfigurationNode) - Method in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver
Given a parent node, resolve an appropriate child.
resolvedType() - Method in class org.spongepowered.configurate.objectmapping.FieldData
The calculated type of this field within the object type.
resolveNode(ConfigurationNode) - Method in class org.spongepowered.configurate.objectmapping.FieldData
Use this field's node resolvers to determine a target node.
resolvesExternalContent() - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Get whether external content should be resolved.
resolvesExternalContent(boolean) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Sets whether external content should be resolved when loading data.
rollback() - Method in interface org.spongepowered.configurate.reactive.TransactionalSubscriber
Called when a transaction has failed, to revert any prepared changes.
root() - Static method in interface org.spongepowered.configurate.AttributedConfigurationNode
Create a new root node with the default tag name.
root() - Static method in interface org.spongepowered.configurate.BasicConfigurationNode
Create a new empty root node.
root() - Static method in interface org.spongepowered.configurate.CommentedConfigurationNode
Create a new empty root node.
root(String) - Static method in interface org.spongepowered.configurate.AttributedConfigurationNode
Create a new root node with the provided tag name but default options.
root(String, ConfigurationOptions) - Static method in interface org.spongepowered.configurate.AttributedConfigurationNode
Create a new root node with the provided tag name and options.
root(String, ConfigurationOptions, CheckedConsumer<? super AttributedConfigurationNode, E>) - Static method in interface org.spongepowered.configurate.AttributedConfigurationNode
Create a new root node with the provided tag name, options and initializer.
root(String, CheckedConsumer<? super AttributedConfigurationNode, E>) - Static method in interface org.spongepowered.configurate.AttributedConfigurationNode
Create a new root node with the provided tag name and default options.
root(ConfigurationOptions) - Static method in interface org.spongepowered.configurate.BasicConfigurationNode
Create a new empty root node with the provided options.
root(ConfigurationOptions) - Static method in interface org.spongepowered.configurate.CommentedConfigurationNode
Create a new empty root node with the provided options.
root(ConfigurationOptions, CheckedConsumer<? super BasicConfigurationNode, E>) - Static method in interface org.spongepowered.configurate.BasicConfigurationNode
Create a new root node with the provided options and initializer.
root(ConfigurationOptions, CheckedConsumer<? super CommentedConfigurationNode, E>) - Static method in interface org.spongepowered.configurate.CommentedConfigurationNode
Create a new root node with the provided options and initializer.
root(CheckedConsumer<? super AttributedConfigurationNode, E>) - Static method in interface org.spongepowered.configurate.AttributedConfigurationNode
Create a new root node with default tag name and default options.
root(CheckedConsumer<? super BasicConfigurationNode, E>) - Static method in interface org.spongepowered.configurate.BasicConfigurationNode
Create a new root node with the provided initializer which may throw.
root(CheckedConsumer<? super CommentedConfigurationNode, E>) - Static method in interface org.spongepowered.configurate.CommentedConfigurationNode
Create a new root node with the provided initializer.

S

save() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Save this configuration using the provided loader.
save(ConfigurationNode) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
 
save(ConfigurationNode) - Method in interface org.spongepowered.configurate.loader.ConfigurationLoader
Attempts to save a ConfigurationNode using this loader, to the defined sink.
save(ConfigurationNode) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Update the configuration node pointed to by this reference, and save it using the reference's loader.
save(V, ConfigurationNode) - Method in interface org.spongepowered.configurate.objectmapping.ObjectMapper
Write data from the provided object to the target.
saveAsync() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Save this configuration using the provided loader.
saveInternal(ConfigurationNode, Writer) - Method in class org.spongepowered.configurate.gson.GsonConfigurationLoader
 
saveInternal(ConfigurationNode, Writer) - Method in class org.spongepowered.configurate.hocon.HoconConfigurationLoader
 
saveInternal(ConfigurationNode, Writer) - Method in class org.spongepowered.configurate.jackson.JacksonConfigurationLoader
 
saveInternal(ConfigurationNode, Writer) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
Perform a save of the node to the provided writer.
saveInternal(ConfigurationNode, Writer) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader
 
saveInternal(ConfigurationNode, Writer) - Method in class org.spongepowered.configurate.yaml.YamlConfigurationLoader
 
SAVING - org.spongepowered.configurate.reference.ConfigurationReference.ErrorPhase
While saving a configuration node to an external location.
Scalars - Class in org.spongepowered.configurate.serialize
Scalar value serializers available
ScalarSerializer<T> - Class in org.spongepowered.configurate.serialize
Serialize a value that can be represented as a scalar value within a node.
ScalarSerializer(TypeToken<T>) - Constructor for class org.spongepowered.configurate.serialize.ScalarSerializer
Create a new scalar serializer that handles the provided type.
ScalarSerializer(Class<T>) - Constructor for class org.spongepowered.configurate.serialize.ScalarSerializer
Create a new scalar serializer that handles the provided type.
schema() - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Gets the Schema to be used by the resultant loader.
schema(Schema) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Sets the Schema the resultant loader should use.
ScopedConfigurationNode<N extends ScopedConfigurationNode<N>> - Interface in org.spongepowered.configurate
Intermediate node type to reduce need for casting.
self() - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Get a correctly typed instance of this node.
SerializationException - Exception in org.spongepowered.configurate.serialize
Exception thrown on errors encountered while using type serializers.
SerializationException() - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with unknown message and cause.
SerializationException(Type, String) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception without a cause.
SerializationException(Type, String, Throwable) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with message and wrapped cause.
SerializationException(Type, Throwable) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with a cause and no additional information.
SerializationException(String) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception without a cause.
SerializationException(Throwable) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with a cause and no additional information.
SerializationException(ConfigurationNode, Type, String, Throwable) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with message and wrapped cause.
SerializationException(ConfigurationNode, Type, String) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with a message and unknown cause.
SerializationException(ConfigurationNode, Type, Throwable) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with wrapped cause.
SerializationException(NodePath, Type, String) - Constructor for exception org.spongepowered.configurate.serialize.SerializationException
Create an exception with message and wrapped cause.
serialize(Type, T, ConfigurationNode) - Method in class org.spongepowered.configurate.serialize.AbstractListChildSerializer
 
serialize(Type, T, ConfigurationNode) - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
 
serialize(Type, T, ConfigurationNode) - Method in interface org.spongepowered.configurate.serialize.TypeSerializer
Serialize an object to the given configuration node.
serialize(T, Predicate<Class<?>>) - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
Serialize the provided value to a supported type, testing against the provided predicate.
serializer(Codec<V>) - Static method in class org.spongepowered.configurate.extra.dfu.v3.DfuSerializers
Create a new serializer wrapping the provided Codec.
serializer(Codec<V>) - Static method in class org.spongepowered.configurate.extra.dfu.v4.DfuSerializers
Create a new serializer wrapping the provided Codec.
serializers() - Method in class org.spongepowered.configurate.ConfigurationOptions
Gets the TypeSerializerCollection specified in these options.
serializers(Consumer<TypeSerializerCollection.Builder>) - Method in class org.spongepowered.configurate.ConfigurationOptions
Creates a new ConfigurationOptions instance, with a new TypeSerializerCollection created as a child of this options' current collection.
serializers(TypeSerializerCollection) - Method in class org.spongepowered.configurate.ConfigurationOptions
Creates a new ConfigurationOptions instance, with the specified TypeSerializerCollection set, and all other settings copied from this instance.
serializeToString(T) - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
Serialize the item to a String, in a representation that can be interpreted by this serializer again.
serialVersionUID - Static variable in exception org.spongepowered.configurate.serialize.SerializationException
 
set(Object) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set this node's value to the given value.
set(Object) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Set this node's value to the given value.
set(T) - Method in interface org.spongepowered.configurate.reference.ValueReference
Set the new value of this node.
set(TypeToken<V>, V) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set this node's value to the given value.
set(TypeToken<V>, V) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
 
set(TypeToken<V>, V) - Static method in interface org.spongepowered.configurate.transformation.TransformAction
Create a transform action that will change the value of a node to one of the specified type.
set(TypeToken<V>, Supplier<V>) - Static method in interface org.spongepowered.configurate.transformation.TransformAction
Create a transform action that will change the value of a node to one of the specified type.
set(Class<V>, V) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set this node's value to the given value.
set(Class<V>, V) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
 
set(Class<V>, Supplier<V>) - Static method in interface org.spongepowered.configurate.transformation.TransformAction
Create a transform action that will change the value of a node to one of the specified type.
set(Object[], Object) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Update the value of the node at the given path, using the root node as a base.
set(Object[], TypeToken<T>, T) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Set the value of the node at path to the given value.
set(Object[], Class<T>, T) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Set the value of the node at path to the given value.
set(Type, Object) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set this node's value to the given value.
set(Type, Object) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Set this node's value to the given value.
set(ConfigurationNode, String, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
set(ConfigurationNode, String, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Update a copy of input with value at path key.
set(ConfigurationNode, String, ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Update a copy of input with value at path key.
set(NodePath, Object) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Update the value of the node at the given path, using the root node as a base.
set(NodePath, TypeToken<T>, T) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Set the value of the node at path to the given value.
set(NodePath, Class<T>, T) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Set the value of the node at path to the given value.
setAndSave(T) - Method in interface org.spongepowered.configurate.reference.ValueReference
Set the new value of this node and save the underlying configuration.
setAndSaveAsync(T) - Method in interface org.spongepowered.configurate.reference.ValueReference
Set the new value of this node and save the underlying configuration asynchronously on the executor of the owning ConfigurationReference.
setList(TypeToken<V>, List<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set the node's value to the provided list.
setList(TypeToken<V>, List<V>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
 
setList(Class<V>, List<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Set the node's value to the provided list.
setList(Class<V>, List<V>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
 
Setting - Annotation Type in org.spongepowered.configurate.objectmapping.meta
Marks a field to be targeted by the object mapper.
SHORT - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for Short values.
shouldCopyDefaults() - Method in class org.spongepowered.configurate.ConfigurationOptions
Gets whether or not default parameters provided to ConfigurationNode getter methods should be set to the node when used.
shouldCopyDefaults(boolean) - Method in class org.spongepowered.configurate.ConfigurationOptions
Creates a new ConfigurationOptions instance, with the specified 'copy defaults' setting set, and all other settings copied from this instance.
sink - Variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
 
sink - Variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
The writer sink for this loader.
sink() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Gets the sink to be used by the resultant loader.
sink(Callable<BufferedWriter>) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the sink of the resultant loader.
size() - Method in interface org.spongepowered.configurate.NodePath
Gets the length of the path.
SKIP_FIELD - Static variable in interface org.spongepowered.configurate.objectmapping.meta.NodeResolver
Indicates that a field should be explicitly skipped.
SLASH_BLOCK - org.spongepowered.configurate.loader.CommentHandlers
CommentHandler for comments delineated using /* *\.
SNAKE_CASE - org.spongepowered.configurate.util.NamingSchemes
Reformats names to snake_case format.
sorted(Comparator<Object>) - Static method in class org.spongepowered.configurate.util.MapFactories
Returns a MapFactory which creates maps which are sorted using the given comparator.
sortedNatural() - Static method in class org.spongepowered.configurate.util.MapFactories
Returns a MapFactory which creates maps which are naturally sorted.
source - Variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
 
source - Variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
The reader source for this loader.
source() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Gets the source to be used by the resultant loader.
source(Callable<BufferedReader>) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the source of the resultant loader.
SPACE_AFTER - org.spongepowered.configurate.jackson.FieldValueSeparatorStyle
Style which uses a space after the : character.
SPACE_BOTH_SIDES - org.spongepowered.configurate.jackson.FieldValueSeparatorStyle
Style which uses spaces either side of the : character.
STRING - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for String values.
Strings - Class in org.spongepowered.configurate.util
Extra string utilities.
submit(V) - Method in interface org.spongepowered.configurate.reactive.Publisher.Cached
Directly submit a value to be the current cached value.
submit(V) - Method in interface org.spongepowered.configurate.reactive.Subscriber
Called to submit a new item.
submit(V) - Method in interface org.spongepowered.configurate.reactive.TransactionalSubscriber
 
subscribe(Subscriber<? super V>) - Method in interface org.spongepowered.configurate.reactive.Publisher
Subscribe to updates from this Publisher.
Subscriber<V> - Interface in org.spongepowered.configurate.reactive
A listener to events that may be called by an Publisher.
supportedExtensions() - Method in class org.spongepowered.configurate.loader.AbstractConfigurationFormat
 
supportedExtensions() - Method in interface org.spongepowered.configurate.loader.ConfigurationFormat
Get the file extensions known to be supported by this format.
supportedFormats() - Static method in interface org.spongepowered.configurate.loader.ConfigurationFormat
Get all supported configuration formats.
SYSTEM_LINE_SEPARATOR - Static variable in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
The line separator used by the system.
systemProperties() - Static method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Retrieve loader options from system properties.
systemProperties(String) - Static method in interface org.spongepowered.configurate.loader.LoaderOptionSource
Retrieve loader options from system properties.

T

TAG_ROOT - Static variable in interface org.spongepowered.configurate.AttributedConfigurationNode
The default tag name for a root node.
tagName() - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Gets the tag name of this node.
tagName(String) - Method in interface org.spongepowered.configurate.AttributedConfigurationNode
Sets the tag name of this node.
targetVersion(int) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
Set the desired target version.
targetVersion(int) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
Set the desired target version.
taskExecutor(Executor) - Method in class org.spongepowered.configurate.reference.WatchServiceListener.Builder
Set the executor that will be used to execute tasks queued based on received events.
threadFactory(ThreadFactory) - Method in class org.spongepowered.configurate.reference.WatchServiceListener.Builder
Set the thread factory that will be used to create the polling thread for the returned watch service.
toComment(Stream<String>) - Method in interface org.spongepowered.configurate.loader.CommentHandler
Converts the specified lines into a comment.
toComment(Stream<String>) - Method in enum org.spongepowered.configurate.loader.CommentHandlers
 
toList(E...) - Static method in class org.spongepowered.configurate.util.UnmodifiableCollections
Creates an unmodifiable copy of the given array as a list, preserving order.
toListCollector(TypeToken<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Create a collector that appends values to this node as list children.
toListCollector(TypeToken<V>) - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create a collector that appends values to a newly created node as list children.
toListCollector(TypeToken<V>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Create a collector that appends values to this node as list children.
toListCollector(Class<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Create a collector that appends values to this node as list children.
toListCollector(Class<V>) - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create a collector that appends values to a newly created node as list children.
toListCollector(Class<V>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Create a collector that appends values to this node as list children.
toMapCollector(TypeToken<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Create a collector that appends values to this node as map children.
toMapCollector(TypeToken<V>) - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create a collector that appends values to a newly created node as map children.
toMapCollector(TypeToken<V>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Create a collector that appends values to this node as map children.
toMapCollector(Class<V>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Create a collector that appends values to this node as map children.
toMapCollector(Class<V>) - Method in interface org.spongepowered.configurate.ConfigurationNodeFactory
Create a collector that appends values to a newly created node as map children.
toMapCollector(Class<V>) - Method in interface org.spongepowered.configurate.ScopedConfigurationNode
Create a collector that appends values to this node as map children.
toSet(E...) - Static method in class org.spongepowered.configurate.util.UnmodifiableCollections
Creates an unmodifiable copy of the given array as a set.
toString() - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
toString() - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
 
toString() - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
 
toString() - Method in class org.spongepowered.configurate.objectmapping.guice.GuiceObjectMapperProvider
 
toString() - Method in class org.spongepowered.configurate.serialize.TypeSerializerCollection
 
TransactionalSubscriber<V> - Interface in org.spongepowered.configurate.reactive
A subscriber that is transaction-aware.
TransactionFailedException - Exception in org.spongepowered.configurate.reactive
Indicate that the newly submitted value was invalid, and the transaction that submitted the new value should be marked as a failure.
TransactionFailedException() - Constructor for exception org.spongepowered.configurate.reactive.TransactionFailedException
Create an exception indicating a transaction has failed for an unknown reason.
TransactionFailedException(Throwable) - Constructor for exception org.spongepowered.configurate.reactive.TransactionFailedException
Create an exception wrapping the cause of a transaction failure.
TransformAction - Interface in org.spongepowered.configurate.transformation
Represents an action to be performed that transforms a node in the configuration tree.
tryDeserialize(Object) - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
Attempt to deserialize the provided object, but rather than throwing an exception when a deserialization error occurs, return null instead.
type() - Method in class org.spongepowered.configurate.serialize.ScalarSerializer
Get the general type token applicable for this serializer.
Types - Class in org.spongepowered.configurate.util
Utility methods for working with generic types.
TypeSerializer<T> - Interface in org.spongepowered.configurate.serialize
Represents an object which can serialize and deserialize objects of a given type.
TypeSerializerCollection - Class in org.spongepowered.configurate.serialize
A calculated collection of TypeSerializers.
TypeSerializerCollection.Builder - Class in org.spongepowered.configurate.serialize
A builder to construct new serializer collections.

U

unbox(Type) - Static method in class org.spongepowered.configurate.util.Types
Unbox the input type if it is a boxed primitive.
UNKNOWN - org.spongepowered.configurate.reference.ConfigurationReference.ErrorPhase
When no further detail is known.
UNKNOWN_POS - Static variable in exception org.spongepowered.configurate.loader.ParsingException
Indicates a line or column is unknown.
UnmodifiableCollections - Class in org.spongepowered.configurate.util
Provides a set of methods that produce unmodifiable copies of collections.
unordered() - Static method in class org.spongepowered.configurate.util.MapFactories
Returns a MapFactory which creates maps without an order.
update(Function<T, ? extends T>) - Method in interface org.spongepowered.configurate.reference.ValueReference
Update this value and the underlying node, without saving.
update(ConfigurationNode, String, Function<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
update(ConfigurationNode, String, Function<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Copies the input node and transform its child at key.
update(ConfigurationNode, String, Function<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Copies the input node and transform its child at key.
updateAsync(Function<T, ? extends T>) - Method in interface org.spongepowered.configurate.reference.ValueReference
Update, performing the action and save on the executor of the owning ConfigurationReference.
updateAsync(Function<N, ? extends N>) - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Update this configuration using the provided function, returning a Publisher which will complete with the result of the operation.
updateGeneric(ConfigurationNode, ConfigurationNode, Function<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
 
updateGeneric(ConfigurationNode, ConfigurationNode, Function<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Copies the input node and transform the node at wrappedKey.
updateGeneric(ConfigurationNode, ConfigurationNode, Function<ConfigurationNode, ConfigurationNode>) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Copies the input node and transform the node at wrappedKey.
updates() - Method in interface org.spongepowered.configurate.reference.ConfigurationReference
Access the Publisher that will broadcast update events, providing the newly created node.
URI - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for URI values.
url(URL) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader.Builder
Sets the source of the resultant loader to the given URL.
URL - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for URL values.
UUID - Static variable in class org.spongepowered.configurate.serialize.Scalars
Serializer for UUID values.

V

validate(Object) - Method in class org.spongepowered.configurate.objectmapping.FieldData
Try to ensure the provided value is acceptable.
validate(V) - Method in interface org.spongepowered.configurate.objectmapping.meta.Constraint
Check if the provided deserialized value matches an expected condition.
value() - Method in enum org.spongepowered.configurate.jackson.FieldValueSeparatorStyle
Get the literal separator for this type.
value() - Method in annotation type org.spongepowered.configurate.objectmapping.meta.Comment
The comment to use.
value() - Method in annotation type org.spongepowered.configurate.objectmapping.meta.Matches
Pattern to test string value against.
value() - Method in annotation type org.spongepowered.configurate.objectmapping.meta.Setting
The path this setting is located at.
VALUE - org.spongepowered.configurate.reference.ConfigurationReference.ErrorPhase
While deserializing a value.
valueOf(String) - Static method in enum org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps.Protection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps.Protection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.jackson.FieldValueSeparatorStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.loader.CommentHandlers
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.loader.HeaderMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.reference.ConfigurationReference.ErrorPhase
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.transformation.MoveStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.util.NamingSchemes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.spongepowered.configurate.yaml.NodeStyle
Returns the enum constant of this type with the specified name.
ValueReference<T,​N extends ConfigurationNode> - Interface in org.spongepowered.configurate.reference
A pointer to a node within a configuration tree.
values() - Static method in enum org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps.Protection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps.Protection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.jackson.FieldValueSeparatorStyle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.loader.CommentHandlers
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.loader.HeaderMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.reference.ConfigurationReference.ErrorPhase
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.transformation.MoveStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.util.NamingSchemes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.spongepowered.configurate.yaml.NodeStyle
Returns an array containing the constants of this enum type, in the order they are declared.
valueType() - Method in class org.spongepowered.configurate.RepresentationHint
The type that values of this type have to have.
valueType(TypeToken<V>) - Method in class org.spongepowered.configurate.RepresentationHint.Builder
Set the type used for this node's value.
valueType(Class<V>) - Method in class org.spongepowered.configurate.RepresentationHint.Builder
Set the type used for this node's value.
version(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation
Get the version from a specific configuration node, using the configured version key.
version(ConfigurationNode) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation
Get the version from a specific configuration node, using the configured version key.
version(ConfigurationNode) - Method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation.Versioned
Get the version of a node hierarchy.
VERSION_UNKNOWN - Static variable in interface org.spongepowered.configurate.transformation.ConfigurationTransformation.Versioned
Indicates a node with an unknown version.
versionedBuilder() - Static method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation
This creates a builder for versioned transformations.
versionKey() - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation
 
versionKey() - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation
 
versionKey() - Method in interface org.spongepowered.configurate.transformation.ConfigurationTransformation.Versioned
Get the path the node's current version is located at.
versionKey(Object...) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
Set the path of the node to query and store the node's schema version at.
versionKey(Object...) - Method in class org.spongepowered.configurate.transformation.ConfigurationTransformation.VersionedBuilder
Sets the path of the version key within the configuration.
versionKey(NodePath) - Method in class org.spongepowered.configurate.extra.dfu.v4.DataFixerTransformation.Builder
Set the path of the node to query and store the node's schema version at.
versionPath(Object...) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
Set the path of the node to query and store the node's schema version at.
versionPath(NodePath) - Method in class org.spongepowered.configurate.extra.dfu.v3.DataFixerTransformation.Builder
Set the path of the node to query and store the node's schema version at.
virtual() - Method in interface org.spongepowered.configurate.ConfigurationNode
Gets if this node is virtual.
visit(ConfigurationVisitor.Safe<S, T>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Visit this node hierarchy as described in ConfigurationVisitor.
visit(ConfigurationVisitor.Safe<S, T>, S) - Method in interface org.spongepowered.configurate.ConfigurationNode
Visit this node hierarchy as described in ConfigurationVisitor.
visit(ConfigurationVisitor<S, T, E>) - Method in interface org.spongepowered.configurate.ConfigurationNode
Visit this node hierarchy as described in ConfigurationVisitor.
visit(ConfigurationVisitor<S, T, E>, S) - Method in interface org.spongepowered.configurate.ConfigurationNode
Visit this node hierarchy as described in ConfigurationVisitor.
visitPath(NodePath, ConfigurationNode) - Method in interface org.spongepowered.configurate.transformation.TransformAction
Called at a certain path, with the node at that path.

W

watching(Function<Path, ConfigurationLoader<? extends T>>, Path, WatchServiceListener) - Static method in interface org.spongepowered.configurate.reference.ConfigurationReference
Create a new configuration reference that will automatically update when triggered by the provided WatchServiceListener.
WatchServiceListener - Class in org.spongepowered.configurate.reference
A wrapper around NIO's WatchService that uses the provided watch key to poll for changes, and calls listeners once an event occurs.
WatchServiceListener.Builder - Class in org.spongepowered.configurate.reference
Set the parameters needed to create a WatchServiceListener.
WILDCARD_OBJECT - Static variable in interface org.spongepowered.configurate.transformation.ConfigurationTransformation
A special object that represents a wildcard in a path provided to a configuration transformer.
with(int, Object) - Method in interface org.spongepowered.configurate.NodePath
Create a new path with the value at index replaced with value.
withAppendedChild(Object) - Method in interface org.spongepowered.configurate.NodePath
Create a new path with the provided element appended to the end.
withNodeFactory(Supplier<? extends ConfigurationNode>) - Static method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
Create a new instance of the ops, with a custom node factory.
wrap(ConfigurationNode) - Static method in class org.spongepowered.configurate.extra.dfu.v2.ConfigurateOps
Wrap a ConfigurationNode in a Dynamic instance.
wrap(ConfigurationNode) - Static method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOps
Wrap a ConfigurationNode in a Dynamic instance.
wrap(ConfigurationNode) - Static method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOps
Wrap a ConfigurationNode in a Dynamic instance.
wrap(ConfigurationNode, IOException) - Static method in exception org.spongepowered.configurate.ConfigurateException
Given an unknown IOException, return it as a Configurate type.
wrap(ConfigurationNode, IOException) - Static method in exception org.spongepowered.configurate.loader.ParsingException
Given an unknown IOException, return it as a Configurate type.
writeHeaderInternal(Writer) - Method in class org.spongepowered.configurate.loader.AbstractConfigurationLoader
Write out any implementation-specific file header.
writeHeaderInternal(Writer) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader
 
writeProtection(ConfigurateOps.Protection) - Method in class org.spongepowered.configurate.extra.dfu.v3.ConfigurateOpsBuilder
Set how nodes provided to mutator methods will be protected from modification.
writeProtection(ConfigurateOps.Protection) - Method in class org.spongepowered.configurate.extra.dfu.v4.ConfigurateOpsBuilder
Set how nodes provided to mutator methods will be protected from modification.
writesExplicitType() - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Gets if explicit type attributes should be written by the loader.
writesExplicitType(boolean) - Method in class org.spongepowered.configurate.xml.XmlConfigurationLoader.Builder
Sets if the resultant loader should write the explicit type of each node when saving nodes.

X

XML_STYLE - org.spongepowered.configurate.loader.CommentHandlers
CommentHandler for comments delineated using <!-- -->.
XmlConfigurationFormat - Class in org.spongepowered.configurate.xml
A ConfigurationFormat for the XML configuration loader.
XmlConfigurationFormat() - Constructor for class org.spongepowered.configurate.xml.XmlConfigurationFormat
For use by service loader only.
XmlConfigurationLoader - Class in org.spongepowered.configurate.xml
A loader for XML (Extensible Markup Language), using the native javax library for parsing and generation.
XmlConfigurationLoader.Builder - Class in org.spongepowered.configurate.xml

Y

YamlConfigurationFormat - Class in org.spongepowered.configurate.yaml
A ConfigurationFormat for the YAML configuration loader.
YamlConfigurationFormat() - Constructor for class org.spongepowered.configurate.yaml.YamlConfigurationFormat
For use by service loader only.
YamlConfigurationLoader - Class in org.spongepowered.configurate.yaml
A loader for YAML-formatted configurations, using the SnakeYAML library for parsing and generation.
YamlConfigurationLoader.Builder - Class in org.spongepowered.configurate.yaml
A B C D E F G H I J K L M N O P R S T U V W X Y 
All Classes All Packages