All Classes

Class Description
AbstractConfigurationLoader<NodeType extends ConfigurationNode>
Base class for many stream-based configuration loaders.
AbstractConfigurationLoader.Builder<T extends AbstractConfigurationLoader.Builder<T>>
An abstract builder implementation for AbstractConfigurationLoaders.
AtomicFiles
A utility for creating "atomic" file writers.
AttributedConfigurationNode
A configuration node that can have both comments and attributes attached to it.
CheckedConsumer<V,​E extends Throwable>
A functional interface similar to Consumer, except allowing contained methods to throw exceptions
CheckedFunction<I,​O,​E extends Exception>
A function with one input and one output which may throw a checked exception
CheckedSupplier<V,​E extends Throwable>
A functional interface similar to Supplier, except allowing contained methods to throw exceptions
CommentedConfigurationNode
A configuration node that can have a comment attached to it.
CommentHandler
Interface specifying methods for handling abstract comments
CommentHandlers
Defines a number of default CommentHandlers.
ConfigSerializable
This annotation is used to indicate that the given type is capable of being serialized and deserialized by the configuration object mapper.
ConfigurationLoader<NodeType extends ConfigurationNode>
Represents an object which can load and save ConfigurationNode objects in a specific configuration format.
ConfigurationNode
A node in the configuration tree.
ConfigurationNodeWalker Deprecated.
Use ScopedConfigurationNode#visit(ConfigurationVisitor) instead
ConfigurationNodeWalker.VisitedNode<T extends ConfigurationNode>
Encapsulates a given node visited during a traversal.
ConfigurationOptions
This object is a holder for general configuration options.
ConfigurationReference<N extends ConfigurationNode>
An updating reference to a base configuration node
ConfigurationReference.ErrorPhase
Representing the phase where an error occurred
ConfigurationTransformation
Represents a set of transformations on a configuration.
ConfigurationTransformation.Builder
ConfigurationTransformation.NodePath
Implementation of NodePath used by this class.
ConfigurationTransformation.VersionedBuilder
Builds a versioned ConfigurationTransformation.
ConfigurationVisitor<S,​T,​E extends Exception>
A visitor to traverse node hierarchies in a depth-first order
ConfigurationVisitor.Safe<S,​T>
A subinterface for visitors that do not throw any checked exceptions during their execution
ConfigurationVisitor.Stateless<E extends Exception>
Stateless specialization of visitors, where both the state and terminal type are Void
DefaultObjectMapperFactory
Factory for a basic ObjectMapper.
Disposable
A representation of something that requires resources A Disposable
EnumLookup
Utility class to cache more flexible enum lookup.
FieldValueSeparatorStyle
Enumeration of field value separator styles.
FormatConversion
An example of how to convert a configuration between two formats.
GsonConfigurationLoader
A loader for JSON-formatted configurations, using the GSON library for parsing and generation.
GsonConfigurationLoader.Builder
GuiceObjectMapperFactory
A factory for ObjectMappers that will inherit the injector from wherever it is provided.
HeaderMode
Modes which ConfigurationLoaders can use to manipulate headers when loading/saving.
HoconConfigurationLoader
A loader for HOCON (Hodor)-formatted configurations, using the typesafe config library for parsing and generation.
HoconConfigurationLoader.Builder
InvalidTypeException
Extension of ObjectMappingException for instances where the present type is invalid.
JSONConfigurationLoader
A loader for JSON-formatted configurations, using the jackson library for parsing and generation.
JSONConfigurationLoader.Builder
MapFactories
Default implementations of MapFactory.
MapFactory
A factory which creates ConcurrentMap instances.
MoveStrategy
Strategy to use when moving a node from one path to another
NodePath
Represents the path to a given node.
ObjectMapper<T>
This is the object mapper.
ObjectMapper.FieldData
Holder for field-specific information
ObjectMapperExample
An example of how to use the ObjectMapper for a simple read-only configuration.
ObjectMapperFactory
A factory to produce ObjectMapper instances
ObjectMappingException
Exception thrown on errors encountered while mapping objects
Processor<I,​O>
A combination of an Publisher and Subscriber.
Processor.Iso<V>
A Processor that has the same type for inputs and outputs
Processor.Transactional<I,​O>  
Processor.TransactionalIso<V>  
Publisher<V>
Something that can publish events.
Publisher.Cached<V>
A publisher that caches the last value received
ScalarSerializer<T>
Serialize a value that can be represented as a scalar value within a node.
Setting
Marks a field to be mapped by an ObjectMapper.
SimpleAttributedConfigurationNode
Basic implementation of AttributedConfigurationNode.
SimpleCommentedConfigurationNode
Basic implementation of CommentedConfigurationNode.
SimpleConfigurationNode
Simple implementation of ConfigurationNode.
Subscriber<V>
A listener to events that may be called by an Publisher.
TransactionalSubscriber<V>
A subscriber that is transaction-aware.
TransactionFailedException  
TransformAction
Represents an action to be performed that transforms a node in the configuration tree
Transformations
An example of how to use transformations to migrate a configuration to a newer schema version.
Tutorial  
Types
Contains functions useful for performing configuration type conversions.
TypeSerializer<T>
Represents an object which can serialize and deserialize objects of a given type.
TypeSerializerCollection
A calculated collection of TypeSerializers
TypeSerializers
A number of TypeSerializers provided by configurate.
ValueReference<T>
A pointer to a node within a configuration tree.
ValueReferences  
ValueType Deprecated.
Use ConfigurationNode.isList() and ConfigurationNode.isMap() for the same information
WatchServiceListener
A wrapper around NIO's WatchService that uses the provided event loop to poll for changes, and calls listeners once an event occurs.
WatchServiceListener.Builder
Set the parameters needed to create a WatchServiceListener.
XMLConfigurationLoader
A loader for XML (Extensible Markup Language), using the native javax library for parsing and generation.
XMLConfigurationLoader.Builder
YAMLConfigurationLoader
A loader for YAML-formatted configurations, using the SnakeYAML library for parsing and generation.
YAMLConfigurationLoader.Builder