Index
All Classes|All Packages
A
- AbstractConfigurationLoader<NodeType extends ConfigurationNode> - Class in ninja.leaping.configurate.loader
-
Base class for many stream-based configuration loaders.
- AbstractConfigurationLoader(AbstractConfigurationLoader.Builder<?>, CommentHandler[]) - Constructor for class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- AbstractConfigurationLoader.Builder<T extends AbstractConfigurationLoader.Builder<T>> - Class in ninja.leaping.configurate.loader
-
An abstract builder implementation for
AbstractConfigurationLoader
s. - accept(V) - Method in interface ninja.leaping.configurate.util.CheckedConsumer
- acceptsType(Class<?>) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Gets whether objects of the provided type are accepted as values for nodes with this as their options object.
- act(Consumer<? super ConfigurationNode>) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- act(Consumer<? super ConfigurationNode>) - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- act(Consumer<? super ConfigurationNode>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Execute an action on this node.
- addAction(Object[], TransformAction) - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.Builder
-
Adds an action to the transformation.
- addAttribute(String, String) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Adds an attribute to this node.
- addAttribute(String, String) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- addVersion(int, ConfigurationTransformation) - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.VersionedBuilder
-
Adds a transformation to this builder for the given version.
- appendListNode() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- appendListNode() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- appendListNode() - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- appendListNode() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- appendListNode() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets a new child node created as the next entry in the list.
- apply(ConfigurationNode) - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation
-
Apply this transformation to a given node
- apply(I) - Method in interface ninja.leaping.configurate.util.CheckedFunction
-
Perform the action.
- asBoolean(Object) - Static method in class ninja.leaping.configurate.Types
-
Attempts to convert
value
to aBoolean
. - asDouble(Object) - Static method in class ninja.leaping.configurate.Types
-
Attempts to convert
value
to aDouble
. - asFloat(Object) - Static method in class ninja.leaping.configurate.Types
-
Attempts to convert
value
to aFloat
. - asInt(Object) - Static method in class ninja.leaping.configurate.Types
-
Attempts to convert
value
to aInteger
. - asLong(Object) - Static method in class ninja.leaping.configurate.Types
-
Attempts to convert
value
to aLong
. - asString(Object) - Static method in class ninja.leaping.configurate.Types
-
Attempts to convert
value
to aString
. - AtomicFiles - Class in ninja.leaping.configurate.loader
-
A utility for creating "atomic" file writers.
- attachChildIfAbsent(SimpleConfigurationNode) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- attachIfNecessary() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- AttributedConfigurationNode - Interface in ninja.leaping.configurate.attributed
-
A configuration node that can have both comments and attributes attached to it.
B
- beginTransaction(V) - Method in interface ninja.leaping.configurate.reactive.TransactionalSubscriber
-
Receive a new value, and validate it.
- beginVisit(ConfigurationNode) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
-
Called at the beginning of the visit with a state object created.
- beginVisit(ConfigurationNode, Void) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
- beginVisit(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called at the beginning of the visit with a state object created.
- beginVisit(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- bind(T) - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Return a view on this mapper that is bound to a single object instance
- bindToNew() - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Returns a view on this mapper that is bound to a newly created object instance
- BoundInstance(T) - Constructor for class ninja.leaping.configurate.objectmapping.ObjectMapper.BoundInstance
- BREADTH_FIRST - Static variable in class ninja.leaping.configurate.util.ConfigurationNodeWalker
-
Deprecated.A
ConfigurationNodeWalker
that implements a breadth-first traversal over the configuration. - build() - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader.Builder
- build() - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader.Builder
- build() - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader.Builder
- build() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Builds the loader.
- build() - Method in class ninja.leaping.configurate.reference.WatchServiceListener.Builder
-
Create a new listener, using default values for any unset parameters.
- build() - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.Builder
-
Builds the transformation.
- build() - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.VersionedBuilder
-
Builds the transformation.
- build() - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
- build() - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader.Builder
- builder() - Static method in class ninja.leaping.configurate.gson.GsonConfigurationLoader
-
Creates a new
GsonConfigurationLoader
builder. - builder() - Static method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader
-
Creates a new
HoconConfigurationLoader
builder. - builder() - Static method in class ninja.leaping.configurate.json.JSONConfigurationLoader
-
Creates a new
JSONConfigurationLoader
builder. - builder() - Static method in class ninja.leaping.configurate.reference.WatchServiceListener
-
Create a new builder for a WatchServiceListener to create a customized listener
- builder() - Static method in class ninja.leaping.configurate.transformation.ConfigurationTransformation
-
Create a new builder to create a basic configuration transformation.
- builder() - Static method in class ninja.leaping.configurate.xml.XMLConfigurationLoader
-
Creates a new
XMLConfigurationLoader
builder. - builder() - Static method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader
-
Creates a new
YAMLConfigurationLoader
builder. - Builder() - Constructor for class ninja.leaping.configurate.gson.GsonConfigurationLoader.Builder
- Builder() - Constructor for class ninja.leaping.configurate.hocon.HoconConfigurationLoader.Builder
- Builder() - Constructor for class ninja.leaping.configurate.json.JSONConfigurationLoader.Builder
- Builder() - Constructor for class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
- Builder() - Constructor for class ninja.leaping.configurate.transformation.ConfigurationTransformation.Builder
- Builder() - Constructor for class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
- Builder() - Constructor for class ninja.leaping.configurate.yaml.YAMLConfigurationLoader.Builder
C
- cache() - Method in interface ninja.leaping.configurate.reactive.Publisher
-
Return a publisher that will track its most recent value.
- cache(V) - Method in interface ninja.leaping.configurate.reactive.Publisher
-
A cached publisher with an initial value
- canCreateInstances() - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Returns whether this object mapper can create new object instances.
- canHaveChildren() - Method in enum ninja.leaping.configurate.ValueType
-
Deprecated.Gets if the type can hold child values.
- canLoad() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- canLoad() - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Gets if this loader is capable of loading configurations.
- canSave() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- canSave() - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Gets if this loader is capable of saving configurations.
- chain(ConfigurationTransformation...) - Static method in class ninja.leaping.configurate.transformation.ConfigurationTransformation
-
Creates a chain of
ConfigurationTransformation
s. - CheckedConsumer<V,E extends Throwable> - Interface in ninja.leaping.configurate.util
-
A functional interface similar to Consumer, except allowing contained methods to throw exceptions
- CheckedFunction<I,O,E extends Exception> - Interface in ninja.leaping.configurate.util
-
A function with one input and one output which may throw a checked exception
- CheckedSupplier<V,E extends Throwable> - Interface in ninja.leaping.configurate.util
-
A functional interface similar to Supplier, except allowing contained methods to throw exceptions
- clear() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- close() - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
- close() - Method in class ninja.leaping.configurate.reference.WatchServiceListener
- closeIfUnsubscribed() - Method in interface ninja.leaping.configurate.reactive.Processor
-
Close this processor if there are no remaining subscriptions.
- collectFields(Map<String, ObjectMapper.FieldData>, TypeToken<? super T>) - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
- collectFields(Map<String, ObjectMapper.FieldData>, Class<? super T>) - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Deprecated.
- comment() - Method in annotation type ninja.leaping.configurate.objectmapping.Setting
-
The default comment associated with this configuration node This will be applied to any comment-capable configuration loader
- CommentedConfigurationNode - Interface in ninja.leaping.configurate.commented
-
A configuration node that can have a comment attached to it.
- CommentHandler - Interface in ninja.leaping.configurate.loader
-
Interface specifying methods for handling abstract comments
- CommentHandlers - Enum in ninja.leaping.configurate.loader
-
Defines a number of default
CommentHandler
s. - commit() - Method in interface ninja.leaping.configurate.reactive.TransactionalSubscriber
-
Expose a transaction's result
- ConfigSerializable - Annotation Type in ninja.leaping.configurate.objectmapping.serialize
-
This annotation is used to indicate that the given type is capable of being serialized and deserialized by the configuration object mapper.
- CONFIGURATE_LINE_SEPARATOR - Static variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
-
The escape sequence used by Configurate to separate comment lines
- ConfigurationLoader<NodeType extends ConfigurationNode> - Interface in ninja.leaping.configurate.loader
-
Represents an object which can load and save
ConfigurationNode
objects in a specific configuration format. - ConfigurationNode - Interface in ninja.leaping.configurate
-
A node in the configuration tree.
- ConfigurationNodeWalker - Class in ninja.leaping.configurate.util
-
Deprecated.Use ScopedConfigurationNode#visit(ConfigurationVisitor) instead
- ConfigurationNodeWalker() - Constructor for class ninja.leaping.configurate.util.ConfigurationNodeWalker
-
Deprecated.
- ConfigurationNodeWalker.VisitedNode<T extends ConfigurationNode> - Interface in ninja.leaping.configurate.util
-
Deprecated.Encapsulates a given
node
visited during a traversal. - ConfigurationOptions - Class in ninja.leaping.configurate
-
This object is a holder for general configuration options.
- ConfigurationReference<N extends ConfigurationNode> - Interface in ninja.leaping.configurate.reference
-
An updating reference to a base configuration node
- ConfigurationReference.ErrorPhase - Enum in ninja.leaping.configurate.reference
-
Representing the phase where an error occurred
- ConfigurationTransformation - Class in ninja.leaping.configurate.transformation
-
Represents a set of transformations on a configuration.
- ConfigurationTransformation() - Constructor for class ninja.leaping.configurate.transformation.ConfigurationTransformation
- ConfigurationTransformation.Builder - Class in ninja.leaping.configurate.transformation
-
Builds a basic
ConfigurationTransformation
. - ConfigurationTransformation.NodePath - Class in ninja.leaping.configurate.transformation
-
Implementation of
NodePath
used by this class. - ConfigurationTransformation.VersionedBuilder - Class in ninja.leaping.configurate.transformation
-
Builds a versioned
ConfigurationTransformation
. - ConfigurationVisitor<S,T,E extends Exception> - Interface in ninja.leaping.configurate
-
A visitor to traverse node hierarchies in a depth-first order
- ConfigurationVisitor.Safe<S,T> - Interface in ninja.leaping.configurate
-
A subinterface for visitors that do not throw any checked exceptions during their execution
- ConfigurationVisitor.Stateless<E extends Exception> - Interface in ninja.leaping.configurate
-
Stateless specialization of visitors, where both the state and terminal type are Void
- constructObject() - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Create a new instance of an object of the appropriate type.
- copy() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- copy() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- copy() - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- copy() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- copy() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Creates a deep copy of this node.
- copy() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- copy(SimpleConfigurationNode) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- copy(SimpleConfigurationNode) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- copy(SimpleConfigurationNode) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- create() - Static method in class ninja.leaping.configurate.examples.Transformations
-
Create a new builder for versioned configurations.
- create() - Static method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
- create() - Static method in interface ninja.leaping.configurate.reactive.Processor
-
Create a
Processor
instance that simply broadcasts submitted values to its subscribers. - create() - Static method in class ninja.leaping.configurate.reference.WatchServiceListener
-
Create a new
WatchServiceListener
using a new cached thread pool executor and the default filesystem. - create() - Method in interface ninja.leaping.configurate.util.MapFactory
-
Create a new map instance for the given types
- create(Executor) - Static method in interface ninja.leaping.configurate.reactive.Processor
-
Create a
Processor
instance that simply broadcasts submitted values to its subscribers - createAtomicBufferedWriter(Path, Charset) - Static method in class ninja.leaping.configurate.loader.AtomicFiles
-
Creates and returns an "atomic" writer for the given path.
- createAtomicWriterFactory(Path, Charset) - Static method in class ninja.leaping.configurate.loader.AtomicFiles
-
Creates and returns an "atomic" writer factory for the given path.
- createEmptyNode() - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Return an empty node of the most appropriate type for this loader, using the default options.
- createEmptyNode(ConfigurationOptions) - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader
- createEmptyNode(ConfigurationOptions) - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader
- createEmptyNode(ConfigurationOptions) - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader
- createEmptyNode(ConfigurationOptions) - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Return an empty node of the most appropriate type for this loader
- createEmptyNode(ConfigurationOptions) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader
- createEmptyNode(ConfigurationOptions) - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader
- createFixed(ConfigurationLoader<? extends N>) - Static method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Create a new configuration reference that will only update when loaded
- createNode(Object) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- createNode(Object) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- createNode(Object) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- createTransactional() - Static method in interface ninja.leaping.configurate.reactive.Processor
-
Create a processor instance that is aware of transactions
- createTransactional(Executor) - Static method in interface ninja.leaping.configurate.reactive.Processor
- createWatching(Function<Path, ConfigurationLoader<? extends T>>, Path, WatchServiceListener) - Static method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Create a new configuration reference that will automatically update when triggered by the provided
WatchServiceListener
- CRLF_MATCH - Static variable in class ninja.leaping.configurate.hocon.HoconConfigurationLoader
-
The pattern used to match newlines.
D
- DefaultObjectMapperFactory - Class in ninja.leaping.configurate.objectmapping
-
Factory for a basic
ObjectMapper
. - DefaultObjectMapperFactory() - Constructor for class ninja.leaping.configurate.objectmapping.DefaultObjectMapperFactory
- defaultOptions - Variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
- defaultParseOptions() - Static method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader
-
Gets the default
ConfigParseOptions
used by configurate. - defaultRenderOptions() - Static method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader
-
Gets the default
ConfigRenderOptions
used by configurate. - defaults() - Static method in class ninja.leaping.configurate.ConfigurationOptions
-
Get the default set of options.
- defaults() - Static method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
-
Gets the default
TypeSerializer
s. - DEPTH_FIRST_POST_ORDER - Static variable in class ninja.leaping.configurate.util.ConfigurationNodeWalker
-
Deprecated.A
ConfigurationNodeWalker
that implements a depth-first post-order traversal over the configuration. - DEPTH_FIRST_PRE_ORDER - Static variable in class ninja.leaping.configurate.util.ConfigurationNodeWalker
-
Deprecated.A
ConfigurationNodeWalker
that implements a depth-first pre-order traversal over the configuration. - deserialize(TypeToken<?>, ConfigurationNode) - Method in interface ninja.leaping.configurate.objectmapping.serialize.TypeSerializer
-
Deserialize an object (of the correct type) from the given configuration node.
- deserialize(TypeToken<?>, Object) - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
-
Given an object of unknown type, attempt to convert it into the given type.
- deserialize(TypeToken<?>, ConfigurationNode) - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
- deserialize(Object) - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
-
Attempt to deserialize the provided object using an unspecialized type.
- deserializeFrom(Object, ConfigurationNode) - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper.FieldData
- Disposable - Interface in ninja.leaping.configurate.reactive
-
A representation of something that requires resources A Disposable
- dispose() - Method in interface ninja.leaping.configurate.reactive.Disposable
-
Clean up and remove any references to resources used by this object.
- DOUBLE_SLASH - ninja.leaping.configurate.loader.CommentHandlers
-
CommentHandler
for comments prefixed by a//
escape.
E
- endVisit() - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
-
Called after every node has been visited, to allow for cleanup and validation
- endVisit(Void) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
- endVisit(S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called after every node has been visited, to allow for cleanup and validation
- endVisit(S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- enterListNode(ConfigurationNode) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
-
Called after
ConfigurationVisitor.enterNode(ConfigurationNode, Object)
for list nodes - enterListNode(ConfigurationNode, Void) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
- enterListNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called after
ConfigurationVisitor.enterNode(ConfigurationNode, Object)
for list nodes - enterListNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- enterMappingNode(ConfigurationNode) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
-
Called after
ConfigurationVisitor.enterNode(ConfigurationNode, Object)
for mapping nodes - enterMappingNode(ConfigurationNode, Void) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
- enterMappingNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called after
ConfigurationVisitor.enterNode(ConfigurationNode, Object)
for mapping nodes - enterMappingNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- enterNode(ConfigurationNode) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
-
Called once per node, for every node
- enterNode(ConfigurationNode, Void) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
- enterNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called once per node, for every node
- enterNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- enterScalarNode(ConfigurationNode) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
-
Called after
ConfigurationVisitor.enterNode(ConfigurationNode, Object)
for scalar nodes - enterScalarNode(ConfigurationNode, Void) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
- enterScalarNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called after
ConfigurationVisitor.enterNode(ConfigurationNode, Object)
for scalar nodes - enterScalarNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- EnumLookup - Class in ninja.leaping.configurate.util
-
Utility class to cache more flexible enum lookup.
- equals(Object) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- equals(Object) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- equals(Object) - Method in class ninja.leaping.configurate.ConfigurationOptions
- equals(Object) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- errors() - Method in interface ninja.leaping.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 ninja.leaping.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 ninja.leaping.configurate.reactive.Publisher
-
Execute an action returning a single value on the provided
Executor
, and pass the result to any subscribers. - exitListNode(ConfigurationNode) - Method in interface ninja.leaping.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 ninja.leaping.configurate.ConfigurationVisitor.Stateless
- exitListNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called for a list node after the node and any of its children have been visited
- exitListNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- exitMappingNode(ConfigurationNode) - Method in interface ninja.leaping.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 ninja.leaping.configurate.ConfigurationVisitor.Stateless
- exitMappingNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called for a list node after the node and any of its children have been visited
- exitMappingNode(ConfigurationNode, S) - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- extractComment(BufferedReader, CommentHandler...) - Static method in enum ninja.leaping.configurate.loader.CommentHandlers
-
Uses provided comment handlers to extract a comment from the reader.
- extractHeader(BufferedReader) - Method in interface ninja.leaping.configurate.loader.CommentHandler
-
Defines the handlers behaviour for reading comments.
- extractHeader(BufferedReader) - Method in enum ninja.leaping.configurate.loader.CommentHandlers
F
- FieldData(Field, String) - Constructor for class ninja.leaping.configurate.objectmapping.ObjectMapper.FieldData
- FieldData(Field, String, TypeToken<?>) - Constructor for class ninja.leaping.configurate.objectmapping.ObjectMapper.FieldData
- FieldValueSeparatorStyle - Enum in ninja.leaping.configurate.json
-
Enumeration of field value separator styles.
- forClass(Class<T>) - Static method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Create a new object mapper that can work with objects of the given class using the
DefaultObjectMapperFactory
. - FormatConversion - Class in ninja.leaping.configurate.examples
-
An example of how to convert a configuration between two formats.
- FormatConversion() - Constructor for class ninja.leaping.configurate.examples.FormatConversion
- forObject(T) - Static method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Creates a new object mapper bound to the given object.
- forObject(TypeToken<T>, T) - Static method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Creates a new object mapper bound to the given object.
- forType(TypeToken<T>) - Static method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Create a new object mapper that can work with objects of the given type using the
DefaultObjectMapperFactory
. - fromConsumer(Consumer<V>) - Static method in interface ninja.leaping.configurate.util.CheckedConsumer
-
Create an instance from an ordinary consumer
- fromFunction(Function<I, O>) - Static method in interface ninja.leaping.configurate.util.CheckedFunction
-
Convert a JDK
Function
into its checked variant - fromSupplier(Supplier<V>) - Static method in interface ninja.leaping.configurate.util.CheckedSupplier
-
Create an instance from an ordinary supplier
G
- get() - Method in interface ninja.leaping.configurate.reactive.Publisher.Cached
- get() - Method in interface ninja.leaping.configurate.reference.ValueReference
-
Get the current value at this node
- get() - Method in interface ninja.leaping.configurate.util.CheckedSupplier
- get(int) - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.NodePath
- get(int) - Method in interface ninja.leaping.configurate.transformation.NodePath
-
Gets a specific element from the path array
- get(TypeToken<T>) - Method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
- get(Object...) - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Get the node at the given path, using the root node
- getAppendedNode() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Deprecated.
- getAppendedNode() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
-
Deprecated.
- getAppendedNode() - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
-
Deprecated.
- getAppendedNode() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
-
Deprecated.
- getAppendedNode() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Deprecated.Use
ConfigurationNode.appendListNode()
instead - getAppendedNode() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
-
Deprecated.
- getArray() - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.NodePath
- getArray() - Method in interface ninja.leaping.configurate.transformation.NodePath
-
Returns a copy of the original path array
- getAttribute(String) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Gets the value of an attribute, or null if this node doesn't have the given attribute.
- getAttribute(String) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- getAttributes() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Gets the attributes this node has.
- getAttributes() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- getBoolean() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getBoolean(boolean) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getChild(Object, boolean) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
-
Gets a child node, relative to this.
- getChildrenList() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- getChildrenList() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- getChildrenList() - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- getChildrenList() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- getChildrenList() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the "list children" attached to this node, if it has any.
- getChildrenList() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getChildrenMap() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- getChildrenMap() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- getChildrenMap() - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- getChildrenMap() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- getChildrenMap() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the "map children" attached to this node, if it has any.
- getChildrenMap() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getComment() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- getComment() - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
-
Gets the current value for the comment.
- getComment() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- getDefaultCommentHandler() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
-
Gets the primary
CommentHandler
used by this loader. - getDefaultOptions() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Gets the default configuration options to be used by the resultant loader.
- getDefaultOptions() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- getDefaultOptions() - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Gets the default
ConfigurationOptions
used by the loader. - getDefaultSerializers() - Static method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializers
-
Deprecated.
- getDefaultTagName() - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Gets the default tag name to be used by the resultant loader.
- getDouble() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getDouble(double) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getExecutor() - Method in interface ninja.leaping.configurate.reactive.Publisher
-
Get the executor that will be used to handle published
- getFactory() - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader.Builder
-
Gets the
JsonFactory
used to configure the implementation. - getFieldValueSeparatorStyle() - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader.Builder
-
Gets the field value separator style to be used by the resultant loader.
- getFloat() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getFloat(float) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getFlowSyle() - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader.Builder
-
Gets the flow style to be used by the resultant loader.
- getHeader() - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Gets the header specified in these options.
- getHeaderMode() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Gets the header mode to be used by the resultant loader.
- getIndent() - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader.Builder
-
Gets the level of indentation to be used by the resultant loader.
- getIndent() - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader.Builder
-
Gets the level of indentation to be used by the resultant loader.
- getIndent() - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Gets the level of indentation to be used by the resultant loader.
- getIndent() - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader.Builder
-
Gets the level of indentation to be used by the resultant loader.
- getInstance() - Static method in class ninja.leaping.configurate.objectmapping.DefaultObjectMapperFactory
- getInstance() - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper.BoundInstance
-
Return the instance this mapper is bound to.
- getInt() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getInt(int) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getKey() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the "key" of this node.
- getKey() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getList(TypeToken<T>) - Method in interface ninja.leaping.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<T>, Supplier<List<T>>) - Method in interface ninja.leaping.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<T>, Supplier<List<T>>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getList(TypeToken<T>, List<T>) - Method in interface ninja.leaping.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<T>, List<T>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getList(Function<Object, T>) - Method in interface ninja.leaping.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(Function<Object, T>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getList(Function<Object, T>, Supplier<List<T>>) - Method in interface ninja.leaping.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(Function<Object, T>, Supplier<List<T>>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getList(Function<Object, T>, List<T>) - Method in interface ninja.leaping.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(Function<Object, T>, List<T>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getLoader() - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Get the loader this reference uses to load and save its node
- getLong() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getLong(long) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getMapFactory() - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Gets the
MapFactory
specified in these options. - getMappedType() - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Deprecated.Use
ObjectMapper.getType()
to be aware of parameterized types - getMapper(TypeToken<T>) - Method in class ninja.leaping.configurate.objectmapping.DefaultObjectMapperFactory
- getMapper(TypeToken<T>) - Method in class ninja.leaping.configurate.objectmapping.GuiceObjectMapperFactory
- getMapper(TypeToken<T>) - Method in interface ninja.leaping.configurate.objectmapping.ObjectMapperFactory
-
Creates an
ObjectMapper
for the given type. - getMapper(Class<T>) - Method in class ninja.leaping.configurate.objectmapping.DefaultObjectMapperFactory
- getMapper(Class<T>) - Method in class ninja.leaping.configurate.objectmapping.GuiceObjectMapperFactory
- getMapper(Class<T>) - Method in interface ninja.leaping.configurate.objectmapping.ObjectMapperFactory
-
Creates an
ObjectMapper
for the given type. - getMoveStrategy() - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.Builder
-
Gets the move strategy to be used by the resultant transformation.
- getNode() - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Get the base node this reference refers to.
- getNode() - Method in interface ninja.leaping.configurate.reference.ValueReference
-
Get the node this value reference points to.
- getNode() - Method in interface ninja.leaping.configurate.util.ConfigurationNodeWalker.VisitedNode
-
Deprecated.Gets the node that was visited.
- getNode(Iterable<?>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the node at the given (relative) path, possibly traversing multiple levels of nodes.
- getNode(Iterable<?>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getNode(Object...) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- getNode(Object...) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- getNode(Object...) - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- getNode(Object...) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- getNode(Object...) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the node at the given (relative) path, possibly traversing multiple levels of nodes.
- getNode(Object...) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getObjectMapperFactory() - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Gets the
ObjectMapperFactory
specified in these options. - getOptions() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the options that currently apply to this node
- getOptions() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getParent() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- getParent() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- getParent() - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- getParent() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- getParent() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the parent of this node.
- getParent() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getParseOptions() - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader.Builder
-
Gets the
ConfigRenderOptions
to be used by the resultant loader. - getPath() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the full path of
keys
from the root node to this node. - getPath() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getPath() - Method in interface ninja.leaping.configurate.util.ConfigurationNodeWalker.VisitedNode
-
Deprecated.Gets the path of the node that was visited.
- getRenderOptions() - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader.Builder
-
Gets the
ConfigRenderOptions
to be used by the resultant loader. - getSchema() - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Gets the
Schema
to be used by the resultant loader. - getSerializers() - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Gets the
TypeSerializerCollection
specified in these options. - getSink() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Gets the sink to be used by the resultant loader.
- getSource() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Gets the source to be used by the resultant loader.
- getString() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getString(String) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the value typed using the appropriate type conversion from
Types
- getTagName() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Gets the tag name of this node.
- getTagName() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- getType() - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
- getValue() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Get the current value associated with this node.
- getValue() - Method in enum ninja.leaping.configurate.json.FieldValueSeparatorStyle
- getValue(TypeToken<T>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Get the current value associated with this node.
- getValue(TypeToken<T>, Supplier<T>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Get the current value associated with this node.
- getValue(TypeToken<T>, Supplier<T>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getValue(TypeToken<T>, T) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Get the current value associated with this node.
- getValue(TypeToken<T>, T) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getValue(Function<Object, T>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the appropriately transformed typed version of this node's value from the provided transformation function.
- getValue(Function<Object, T>, Supplier<T>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the appropriately transformed typed version of this node's value from the provided transformation function.
- getValue(Function<Object, T>, Supplier<T>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getValue(Function<Object, T>, T) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets the appropriately transformed typed version of this node's value from the provided transformation function.
- getValue(Function<Object, T>, T) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getValue(Supplier<Object>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Get the current value associated with this node.
- getValue(Supplier<Object>) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getValue(Object) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Get the current value associated with this node.
- getValue(Object) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- getValueType() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Deprecated.Use
ConfigurationNode.isList()
andConfigurationNode.isMap()
for the same information - getValueType() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- GsonConfigurationLoader - Class in ninja.leaping.configurate.gson
-
A loader for JSON-formatted configurations, using the GSON library for parsing and generation.
- GsonConfigurationLoader.Builder - Class in ninja.leaping.configurate.gson
-
Builds a
GsonConfigurationLoader
. - GuiceObjectMapperFactory - Class in ninja.leaping.configurate.objectmapping
-
A factory for
ObjectMapper
s that will inherit the injector from wherever it is provided. - GuiceObjectMapperFactory(Injector) - Constructor for class ninja.leaping.configurate.objectmapping.GuiceObjectMapperFactory
H
- hasAttributes() - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Gets if this node has any attributes.
- hasAttributes() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- HASH - ninja.leaping.configurate.loader.CommentHandlers
-
CommentHandler
for comments prefixed by the#
character. - hashCode() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- hashCode() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- hashCode() - Method in class ninja.leaping.configurate.ConfigurationOptions
- hashCode() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- hasListChildren() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Deprecated.Use
ConfigurationNode.isList()
instead - hasMapChildren() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Deprecated.Use
ConfigurationNode.isMap()
instead - hasSubscribers() - Method in interface ninja.leaping.configurate.reactive.Publisher
-
Return whether or not this Publisher has any subscribers.
- headerMode - Variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
- HeaderMode - Enum in ninja.leaping.configurate.loader
-
Modes which
ConfigurationLoader
s can use to manipulate headers when loading/saving. - HoconConfigurationLoader - Class in ninja.leaping.configurate.hocon
-
A loader for HOCON (Hodor)-formatted configurations, using the typesafe config library for parsing and generation.
- HoconConfigurationLoader.Builder - Class in ninja.leaping.configurate.hocon
-
Builds a
HoconConfigurationLoader
.
I
- initialTransform() - Static method in class ninja.leaping.configurate.examples.Transformations
-
A transformation.
- inject(O) - Method in interface ninja.leaping.configurate.reactive.Processor
-
Submit an element of the observed type, bypassing any mapping this Processor may do.
- inject(V) - Method in interface ninja.leaping.configurate.reactive.Processor.Iso
- insertionOrdered() - Static method in class ninja.leaping.configurate.util.MapFactories
-
Returns a
MapFactory
which creates maps which are sorted by insertion order. - InvalidTypeException - Exception in ninja.leaping.configurate.objectmapping
-
Extension of
ObjectMappingException
for instances where the presenttype
is invalid. - InvalidTypeException(TypeToken<?>) - Constructor for exception ninja.leaping.configurate.objectmapping.InvalidTypeException
- isEmpty() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- isEmpty() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Return true when this node has a null or empty value.
- isEmpty() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- isLegacy() - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Deprecated.Backwards compatibility measure, to be removed in 4.0
- isLenient() - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader.Builder
-
Gets if the resultant loader should parse leniently.
- isList() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets if this node has "list children".
- isMap() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets if this node has "map children".
- isVirtual() - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Gets if this node is virtual.
- isVirtual() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- iterator() - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.NodePath
- iterator() - Method in interface ninja.leaping.configurate.transformation.NodePath
-
Returns an iterator over the path.
J
- JSONConfigurationLoader - Class in ninja.leaping.configurate.json
-
A loader for JSON-formatted configurations, using the jackson library for parsing and generation.
- JSONConfigurationLoader.Builder - Class in ninja.leaping.configurate.json
-
Builds a
JSONConfigurationLoader
.
L
- LINE_SPLITTER - Static variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
-
A
Splitter
for splitting comment lines - LIST - ninja.leaping.configurate.ValueType
-
Deprecated.Represents a node that consists of a number of child values, in a specific order, each mapped by an index value.
- listenToConfiguration(Function<Path, ConfigurationLoader<? extends N>>, Path) - Method in class ninja.leaping.configurate.reference.WatchServiceListener
- listenToDirectory(Path, Subscriber<WatchEvent<?>>) - Method in class ninja.leaping.configurate.reference.WatchServiceListener
-
Listen to a directory.
- listenToFile(Path, Subscriber<WatchEvent<?>>) - Method in class ninja.leaping.configurate.reference.WatchServiceListener
-
Listen for changes to a specific file or directory.
- load() - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Attempts to load a
ConfigurationNode
using this loader, from the defined source. - load() - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Reload a configuration using the provided loader.
- load(ConfigurationOptions) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- load(ConfigurationOptions) - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Attempts to load a
ConfigurationNode
using this loader, from the defined source. - load(ConfigurationOptions) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader
- LOADING - ninja.leaping.configurate.reference.ConfigurationReference.ErrorPhase
- loadInternal(AttributedConfigurationNode, BufferedReader) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader
-
Deprecated.
- loadInternal(CommentedConfigurationNode, BufferedReader) - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader
- loadInternal(ConfigurationNode, BufferedReader) - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader
- loadInternal(ConfigurationNode, BufferedReader) - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader
- loadInternal(ConfigurationNode, BufferedReader) - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader
- loadInternal(NodeType, BufferedReader) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- loadToReference() - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Attempts to load data from the defined source into a
ConfigurationReference
. - lookupEnum(Class<T>, String) - Static method in class ninja.leaping.configurate.util.EnumLookup
M
- main(String[]) - Static method in class ninja.leaping.configurate.examples.FormatConversion
- main(String[]) - Static method in class ninja.leaping.configurate.examples.ObjectMapperExample
- main(String[]) - Static method in class ninja.leaping.configurate.examples.Transformations
- main(String[]) - Static method in class ninja.leaping.configurate.examples.Tutorial
- main(String[]) - Static method in class ninja.leaping.configurate.examples.ValueReferences
- map(CheckedFunction<? super O, ? extends R, TransactionFailedException>) - Method in interface ninja.leaping.configurate.reactive.Processor
- map(CheckedFunction<? super V, ? extends R, TransactionFailedException>) - Method in interface ninja.leaping.configurate.reactive.Publisher
- MAP - ninja.leaping.configurate.ValueType
-
Deprecated.Represents a node that consists of a number of child values, each mapped by a unique key.
- MapFactories - Class in ninja.leaping.configurate.util
-
Default implementations of
MapFactory
. - MapFactory - Interface in ninja.leaping.configurate.util
-
A factory which creates
ConcurrentMap
instances. - MERGE - ninja.leaping.configurate.transformation.MoveStrategy
-
Moves nodes using
ConfigurationNode.mergeValuesFrom(ConfigurationNode)
. - mergeValuesFrom(ConfigurationNode) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- mergeValuesFrom(ConfigurationNode) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- mergeValuesFrom(ConfigurationNode) - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- mergeValuesFrom(ConfigurationNode) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- mergeValuesFrom(ConfigurationNode) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Set all the values from the given node that are not present in this node to their values in the provided node.
- mergeValuesFrom(ConfigurationNode) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- move(ConfigurationNode, ConfigurationNode) - Method in enum ninja.leaping.configurate.transformation.MoveStrategy
-
Moves
source
totarget
. - MoveStrategy - Enum in ninja.leaping.configurate.transformation
-
Strategy to use when moving a node from one path to another
N
- newChild() - Method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
- newCollection() - Static method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializers
-
Deprecated.
- newState() - Method in interface ninja.leaping.configurate.ConfigurationVisitor
-
Called to provide a state object if a visit is initiated without one already existing
- newState() - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Safe
- newState() - Method in interface ninja.leaping.configurate.ConfigurationVisitor.Stateless
- ninja.leaping.configurate - package ninja.leaping.configurate
-
The main package for Configurate.
- ninja.leaping.configurate.attributed - package ninja.leaping.configurate.attributed
- ninja.leaping.configurate.commented - package ninja.leaping.configurate.commented
- ninja.leaping.configurate.examples - package ninja.leaping.configurate.examples
-
Configurate usage examples.
- ninja.leaping.configurate.gson - package ninja.leaping.configurate.gson
-
Configuration loader for the JSON format, plus supports.
- ninja.leaping.configurate.hocon - package ninja.leaping.configurate.hocon
-
Configuration loader for the HOCON library, plus supports
- ninja.leaping.configurate.json - package ninja.leaping.configurate.json
- ninja.leaping.configurate.loader - package ninja.leaping.configurate.loader
-
Base infrastructure for configuration loaders
- ninja.leaping.configurate.objectmapping - package ninja.leaping.configurate.objectmapping
-
Object mapper to handle converting between raw nodes and POJOs
- ninja.leaping.configurate.objectmapping.serialize - package ninja.leaping.configurate.objectmapping.serialize
-
Type serializer mechanisms and the standard type serializers shipped with Configurate
- ninja.leaping.configurate.reactive - package ninja.leaping.configurate.reactive
-
This package contains a rudimentary implementation of a reactive programming API.
- ninja.leaping.configurate.reference - package ninja.leaping.configurate.reference
-
File watcher and infrastructure to support dynamically updating configurations
- ninja.leaping.configurate.transformation - package ninja.leaping.configurate.transformation
-
Configuration tree transformations
- ninja.leaping.configurate.util - package ninja.leaping.configurate.util
-
Utilities for implementation
- ninja.leaping.configurate.xml - package ninja.leaping.configurate.xml
-
Configuration loader for the XML format, plus supports
- ninja.leaping.configurate.yaml - package ninja.leaping.configurate.yaml
-
Configuration loader for the YAML 1.1 format, plus supports
- NO_SPACE - ninja.leaping.configurate.json.FieldValueSeparatorStyle
-
Style which uses no spaces.
- NodePath - Interface in ninja.leaping.configurate.transformation
-
Represents the path to a given node.
- NONE - ninja.leaping.configurate.loader.HeaderMode
-
Ignore any header present in input, and do not output any header
- NULL - ninja.leaping.configurate.ValueType
-
Deprecated.Represents a node that has no defined value.
- NUMBER_DEF - Static variable in interface ninja.leaping.configurate.ConfigurationNode
O
- ObjectMapper<T> - Class in ninja.leaping.configurate.objectmapping
-
This is the object mapper.
- ObjectMapper(TypeToken<T>) - Constructor for class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Create a new object mapper of a given type
- ObjectMapper(Class<T>) - Constructor for class ninja.leaping.configurate.objectmapping.ObjectMapper
-
Deprecated.Use
ObjectMapper(TypeToken)
instead to support parameterized types - ObjectMapper.BoundInstance - Class in ninja.leaping.configurate.objectmapping
-
Represents an object mapper bound to a certain instance of the object
- ObjectMapper.FieldData - Class in ninja.leaping.configurate.objectmapping
-
Holder for field-specific information
- ObjectMapperExample - Class in ninja.leaping.configurate.examples
-
An example of how to use the ObjectMapper for a simple read-only configuration.
- ObjectMapperExample() - Constructor for class ninja.leaping.configurate.examples.ObjectMapperExample
- ObjectMapperFactory - Interface in ninja.leaping.configurate.objectmapping
-
A factory to produce
ObjectMapper
instances - ObjectMappingException - Exception in ninja.leaping.configurate.objectmapping
-
Exception thrown on errors encountered while mapping objects
- ObjectMappingException() - Constructor for exception ninja.leaping.configurate.objectmapping.ObjectMappingException
- ObjectMappingException(String) - Constructor for exception ninja.leaping.configurate.objectmapping.ObjectMappingException
- ObjectMappingException(String, Throwable) - Constructor for exception ninja.leaping.configurate.objectmapping.ObjectMappingException
- ObjectMappingException(String, Throwable, boolean, boolean) - Constructor for exception ninja.leaping.configurate.objectmapping.ObjectMappingException
- ObjectMappingException(Throwable) - Constructor for exception ninja.leaping.configurate.objectmapping.ObjectMappingException
- onClose() - Method in interface ninja.leaping.configurate.reactive.Subscriber
-
When the
Publisher
this is subscribed to closes without error, this method will be called. - onError(Throwable) - Method in interface ninja.leaping.configurate.reactive.Subscriber
-
When an error occurs while subscribing to an
Publisher
, or is thrown during the execution ofSubscriber.submit(Object)
that is not otherwise handled, this method will be called with the error. - OVERWRITE - ninja.leaping.configurate.transformation.MoveStrategy
-
Moves nodes using
ConfigurationNode.setValue(Object)
.
P
- populate(ConfigurationNode) - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper.BoundInstance
-
Populate the annotated fields in a pre-created object
- PRESERVE - ninja.leaping.configurate.loader.HeaderMode
-
Use the header loaded from an existing file, replacing any header set in the options
- preservesHeader() - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Deprecated.In favour of
AbstractConfigurationLoader.Builder.getHeaderMode()
- PRESET - ninja.leaping.configurate.loader.HeaderMode
-
Ignore any header present in input, and output a header if one has been set in options
- printData() - Method in class ninja.leaping.configurate.examples.ValueReferences
- Processor<I,O> - Interface in ninja.leaping.configurate.reactive
-
A combination of an
Publisher
andSubscriber
. - Processor.Iso<V> - Interface in ninja.leaping.configurate.reactive
-
A Processor that has the same type for inputs and outputs
- Processor.Transactional<I,O> - Interface in ninja.leaping.configurate.reactive
- Processor.TransactionalIso<V> - Interface in ninja.leaping.configurate.reactive
- Publisher<V> - Interface in ninja.leaping.configurate.reactive
-
Something that can publish events.
- Publisher.Cached<V> - Interface in ninja.leaping.configurate.reactive
-
A publisher that caches the last value received
R
- referenceTo(TypeToken<T>, Object...) - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Create a reference to the node at the provided path.
- referenceTo(TypeToken<T>, Object[], T) - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Create a reference to the node at the provided path.
- referenceTo(Class<T>, Object...) - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Create a reference to the node at the provided path.
- referenceTo(Class<T>, Object[], T) - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Create a reference to the node at the provided path.
- register(TypeToken<T>, TypeSerializer<? super T>) - Method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
-
Register a type serializer for a given type.
- register(Predicate<TypeToken<T>>, TypeSerializer<? super T>) - Method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
-
Register a type serializer matching against a given predicate.
- register(ScalarSerializer<T>) - Method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
-
Register a scalar serializer under its appropriate type.
- registerPredicate(Predicate<TypeToken<T>>, TypeSerializer<? super T>) - Method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
-
Deprecated.
- registerType(TypeToken<T>, TypeSerializer<? super T>) - Method in class ninja.leaping.configurate.objectmapping.serialize.TypeSerializerCollection
-
Deprecated.Use #register(TypeToken, TypeSerializer) instead
- removeAttribute(String) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Removes an attribute from this node.
- removeAttribute(String) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- removeChild(Object) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Removes a direct child of this node
- removeChild(Object) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- repl() - Method in class ninja.leaping.configurate.examples.ValueReferences
- rollback() - Method in interface ninja.leaping.configurate.reactive.TransactionalSubscriber
-
Called when a transaction has failed, to revert any prepared changes
- root() - Static method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Create a new node with no parent and the tag name
root
- root() - Static method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
-
Deprecated.Use
AttributedConfigurationNode.root()
instead - root() - Static method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- root() - Static method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
-
Deprecated.Use
CommentedConfigurationNode.root()
instead - root() - Static method in interface ninja.leaping.configurate.ConfigurationNode
- root() - Static method in class ninja.leaping.configurate.SimpleConfigurationNode
-
Deprecated.Use
ConfigurationNode.root()
instead - root(String) - Static method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Create a new node with no parent and a specified tag name.
- root(String) - Static method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
-
Deprecated.Use
AttributedConfigurationNode.root(String)
instead - root(String, ConfigurationOptions) - Static method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Create a new node with no parent, a specified tag name, and specific options.
- root(String, ConfigurationOptions) - Static method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
-
Deprecated.
- root(String, ConfigurationOptions, Consumer<? super AttributedConfigurationNode>) - Static method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Create a new node with no parent, a specified tag name, and specific options, and perform an action with it in scope
- root(String, Consumer<? super AttributedConfigurationNode>) - Static method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Create a new node with no parent and a specified tag name, and perform an action with it in scope
- root(Consumer<? super CommentedConfigurationNode>) - Static method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- root(ConfigurationOptions) - Static method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- root(ConfigurationOptions) - Static method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
-
Deprecated.
- root(ConfigurationOptions) - Static method in interface ninja.leaping.configurate.ConfigurationNode
- root(ConfigurationOptions) - Static method in class ninja.leaping.configurate.SimpleConfigurationNode
-
Deprecated.Use
ConfigurationNode.root(ConfigurationOptions)
instead - root(ConfigurationOptions, Consumer<? super CommentedConfigurationNode>) - Static method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- root(ConfigurationOptions, Consumer<ConfigurationNode>) - Static method in interface ninja.leaping.configurate.ConfigurationNode
- root(Consumer<? super AttributedConfigurationNode>) - Static method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Create a new node with no parent and the tag name
root
, and perform an action with it in scope - root(Consumer<ConfigurationNode>) - Static method in interface ninja.leaping.configurate.ConfigurationNode
S
- save() - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Save this configuration using the provided loader.
- save(ConfigurationNode) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- save(ConfigurationNode) - Method in interface ninja.leaping.configurate.loader.ConfigurationLoader
-
Attempts to save a
ConfigurationNode
using this loader, to the defined sink. - save(N) - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Update the configuration node pointed to by this reference, and save it using the reference's loader
- saveAsync() - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Save this configuration using the provided loader.
- saveInternal(ConfigurationNode, Writer) - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader
- saveInternal(ConfigurationNode, Writer) - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader
- saveInternal(ConfigurationNode, Writer) - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader
- saveInternal(ConfigurationNode, Writer) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- saveInternal(ConfigurationNode, Writer) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader
- saveInternal(ConfigurationNode, Writer) - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader
- SAVING - ninja.leaping.configurate.reference.ConfigurationReference.ErrorPhase
- SCALAR - ninja.leaping.configurate.ValueType
-
Deprecated.Represents a node that consists of a "single" scalar value
- ScalarSerializer<T> - Class in ninja.leaping.configurate.objectmapping.serialize
-
Serialize a value that can be represented as a scalar value within a node.
- ScalarSerializer(TypeToken<T>) - Constructor for class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
- ScalarSerializer(Class<T>) - Constructor for class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
- serialize(TypeToken<?>, T, ConfigurationNode) - Method in interface ninja.leaping.configurate.objectmapping.serialize.TypeSerializer
-
Serialize an object to the given configuration node.
- serialize(TypeToken<?>, T, ConfigurationNode) - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
- serialize(ConfigurationNode) - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper.BoundInstance
-
Serialize the data contained in annotated fields to the configuration node.
- serialize(T, Predicate<Class<?>>) - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
- serializeTo(Object, ConfigurationNode) - Method in class ninja.leaping.configurate.objectmapping.ObjectMapper.FieldData
- serializeToString(T) - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
-
Serialize the item to a
String
, in a representation that can be interpreted by this serializer again - serialVersionUID - Static variable in exception ninja.leaping.configurate.objectmapping.InvalidTypeException
- serialVersionUID - Static variable in exception ninja.leaping.configurate.objectmapping.ObjectMappingException
- set(T) - Method in interface ninja.leaping.configurate.reference.ValueReference
-
Set the new value of this node.
- set(Object[], Object) - Method in interface ninja.leaping.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 ninja.leaping.configurate.reference.ConfigurationReference
-
Set the value of the node at
path
to the given value, using the appropriateTypeSerializer
to serialize the data if it's not directly supported by the provided configuration. - setAcceptedTypes(Set<Class<?>>) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Deprecated.Use
ConfigurationOptions.withNativeTypes(Set)
instead - setAndSave(T) - Method in interface ninja.leaping.configurate.reference.ValueReference
-
Set the new value of this node and save the underlying configuration
- setAndSaveAsync(T) - Method in interface ninja.leaping.configurate.reference.ValueReference
-
Set the new value of this node and save the underlying configuration asynchronously on the executor of the owning
ConfigurationReference
- setAttributes(Map<String, String>) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Sets the attributes of this node.
- setAttributes(Map<String, String>) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- setComment(String) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- setComment(String) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- setComment(String) - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
-
Sets the comment for this configuration node.
- setComment(String) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- setCommentIfAbsent(String) - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
-
Set a comment on this node if it does not presently have a comment.
- setCommentIfAbsent(String) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- setDefaultOptions(UnaryOperator<ConfigurationOptions>) - Method in class ninja.leaping.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 applicable changes.
- setDefaultOptions(ConfigurationOptions) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Sets the default configuration options to be used by the resultant loader.
- setDefaultTagName(String) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Sets the default tag name the resultant loader should use.
- setFallbackHandler(Subscriber<O>) - Method in interface ninja.leaping.configurate.reactive.Processor
-
Provide a
Subscriber
that will handle events submitted to this processor, but only if no other subscription is active. - setFieldValueSeparatorStyle(FieldValueSeparatorStyle) - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader.Builder
-
Sets the field value separator style the resultant loader should use.
- setFile(File) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Sets the sink and source of the resultant loader to the given file.
- setFileSystem(FileSystem) - Method in class ninja.leaping.configurate.reference.WatchServiceListener.Builder
-
Set the filesystem expected to be used for paths.
- setFlowStyle(DumperOptions.FlowStyle) - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader.Builder
-
Sets the flow style the resultant loader should use.
- setHeader(String) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with the specified header set, and all other settings copied from this instance. - setHeaderMode(HeaderMode) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Sets the header mode of the resultant loader.
- setIncludeXmlDeclaration(boolean) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Sets if the resultant loader should include the XML declaration header when saving.
- setIndent(int) - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader.Builder
-
Sets the level of indentation the resultant loader should use.
- setIndent(int) - Method in class ninja.leaping.configurate.json.JSONConfigurationLoader.Builder
-
Sets the level of indentation the resultant loader should use.
- setIndent(int) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Sets the level of indentation the resultant loader should use.
- setIndent(int) - Method in class ninja.leaping.configurate.yaml.YAMLConfigurationLoader.Builder
-
Sets the level of indentation the resultant loader should use.
- setLenient(boolean) - Method in class ninja.leaping.configurate.gson.GsonConfigurationLoader.Builder
-
Sets if the resultant loader should parse leniently.
- setMapFactory(MapFactory) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Deprecated.USe
ConfigurationOptions.withMapFactory(MapFactory)
instead - setMoveStrategy(MoveStrategy) - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.Builder
-
Sets the mode strategy to be used by the resultant transformation.
- setObjectMapperFactory(ObjectMapperFactory) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Deprecated.
- setParseOptions(ConfigParseOptions) - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader.Builder
-
Sets the
ConfigParseOptions
the resultant loader should use. - setPath(Path) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Sets the sink and source of the resultant loader to the given path.
- setPreservesHeader(boolean) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Deprecated.
- setRenderOptions(ConfigRenderOptions) - Method in class ninja.leaping.configurate.hocon.HoconConfigurationLoader.Builder
-
Sets the
ConfigRenderOptions
the resultant loader should use. - setSchema(Schema) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Sets the
Schema
the resultant loader should use. - setSerializers(TypeSerializerCollection) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Deprecated.
- setShouldCopyDefaults(boolean) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Deprecated.
- setSink(Callable<BufferedWriter>) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Sets the sink of the resultant loader.
- setSource(Callable<BufferedReader>) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Sets the source of the resultant loader.
- setTagName(String) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
-
Sets the tag name of this node.
- setTagName(String) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- setTaskExecutor(Executor) - Method in class ninja.leaping.configurate.reference.WatchServiceListener.Builder
-
Set the executor that will be used to execute tasks queued based on received events.
- setThreadFactory(ThreadFactory) - Method in class ninja.leaping.configurate.reference.WatchServiceListener.Builder
-
Set the thread factory that will be used to create the polling thread for this watch service
- Setting - Annotation Type in ninja.leaping.configurate.objectmapping
-
Marks a field to be mapped by an
ObjectMapper
. - setURL(URL) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
-
Sets the source of the resultant loader to the given URL.
- setValue(TypeToken<T>, T) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Set this node's value to the given value.
- setValue(Object) - Method in interface ninja.leaping.configurate.attributed.AttributedConfigurationNode
- setValue(Object) - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- setValue(Object) - Method in interface ninja.leaping.configurate.commented.CommentedConfigurationNode
- setValue(Object) - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- setValue(Object) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Set this node's value to the given value.
- setValue(Object) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- setVersionKey(Object...) - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.VersionedBuilder
-
Sets the path of the version key within the configuration.
- setWriteExplicitType(boolean) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Sets if the resultant loader should write the explicit type of each node when saving nodes.
- shouldCopyDefaults() - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Gets whether or not default parameters provided to
ConfigurationNode
getter methods should be set to the node when used. - shouldIncludeXmlDeclaration() - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Gets if the resultant loader should include the XML declaration header when saving.
- shouldWriteExplicitType() - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader.Builder
-
Gets if explicit type attributes should be written by the resultant loader.
- SimpleAttributedConfigurationNode - Class in ninja.leaping.configurate.attributed
-
Basic implementation of
AttributedConfigurationNode
. - SimpleAttributedConfigurationNode(String, Object, SimpleConfigurationNode, ConfigurationOptions) - Constructor for class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- SimpleAttributedConfigurationNode(String, SimpleConfigurationNode, SimpleConfigurationNode) - Constructor for class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- SimpleCommentedConfigurationNode - Class in ninja.leaping.configurate.commented
-
Basic implementation of
CommentedConfigurationNode
. - SimpleCommentedConfigurationNode(Object, SimpleConfigurationNode, ConfigurationOptions) - Constructor for class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- SimpleCommentedConfigurationNode(SimpleConfigurationNode, SimpleConfigurationNode) - Constructor for class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- SimpleConfigurationNode - Class in ninja.leaping.configurate
-
Simple implementation of
ConfigurationNode
. - SimpleConfigurationNode(Object, SimpleConfigurationNode, ConfigurationOptions) - Constructor for class ninja.leaping.configurate.SimpleConfigurationNode
- SimpleConfigurationNode(SimpleConfigurationNode, SimpleConfigurationNode) - Constructor for class ninja.leaping.configurate.SimpleConfigurationNode
- sink - Variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
- sink - Variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
-
The writer sink for this loader.
- size() - Method in class ninja.leaping.configurate.transformation.ConfigurationTransformation.NodePath
- size() - Method in interface ninja.leaping.configurate.transformation.NodePath
-
Gets the length of the path
- SLASH_BLOCK - ninja.leaping.configurate.loader.CommentHandlers
-
CommentHandler
for comments delineated using/* *\
. - sorted(Comparator<Object>) - Static method in class ninja.leaping.configurate.util.MapFactories
-
Returns a
MapFactory
which creates maps which are sorted using the given comparator. - sortedNatural() - Static method in class ninja.leaping.configurate.util.MapFactories
-
Returns a
MapFactory
which creates maps which are naturally sorted. - source - Variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader.Builder
- source - Variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
-
The reader source for this loader.
- SPACE_AFTER - ninja.leaping.configurate.json.FieldValueSeparatorStyle
-
Style which uses a space after the
:
character. - SPACE_BOTH_SIDES - ninja.leaping.configurate.json.FieldValueSeparatorStyle
-
Style which uses spaces either side of the
:
character. - strictAsBoolean(Object) - Static method in class ninja.leaping.configurate.Types
-
Returns
value
if it is aBoolean
. - strictAsDouble(Object) - Static method in class ninja.leaping.configurate.Types
-
Returns
value
if it is aDouble
. - strictAsFloat(Object) - Static method in class ninja.leaping.configurate.Types
-
Returns
value
if it is aFloat
. - strictAsInt(Object) - Static method in class ninja.leaping.configurate.Types
-
Returns
value
if it is aInteger
. - strictAsLong(Object) - Static method in class ninja.leaping.configurate.Types
-
Returns
value
if it is aLong
. - strictAsString(Object) - Static method in class ninja.leaping.configurate.Types
-
Returns
value
if it is aString
. - submit(V) - Method in interface ninja.leaping.configurate.reactive.Publisher.Cached
- submit(V) - Method in interface ninja.leaping.configurate.reactive.Subscriber
-
Called to submit a new item
- submit(V) - Method in interface ninja.leaping.configurate.reactive.TransactionalSubscriber
- subscribe(Subscriber<? super V>) - Method in interface ninja.leaping.configurate.reactive.Publisher
-
Subscribe to updates from this Publisher.
- Subscriber<V> - Interface in ninja.leaping.configurate.reactive
-
A listener to events that may be called by an
Publisher
. - SYSTEM_LINE_SEPARATOR - Static variable in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
-
The line separator used by the system
T
- toComment(Collection<String>) - Method in interface ninja.leaping.configurate.loader.CommentHandler
-
Converts the given lines into a comment
- toComment(Collection<String>) - Method in enum ninja.leaping.configurate.loader.CommentHandlers
- toString() - Method in class ninja.leaping.configurate.attributed.SimpleAttributedConfigurationNode
- toString() - Method in class ninja.leaping.configurate.commented.SimpleCommentedConfigurationNode
- toString() - Method in class ninja.leaping.configurate.ConfigurationOptions
- toString() - Method in class ninja.leaping.configurate.objectmapping.DefaultObjectMapperFactory
- toString() - Method in class ninja.leaping.configurate.objectmapping.GuiceObjectMapperFactory
- toString() - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- TransactionalSubscriber<V> - Interface in ninja.leaping.configurate.reactive
-
A subscriber that is transaction-aware.
- TransactionFailedException - Exception in ninja.leaping.configurate.reactive
- TransactionFailedException() - Constructor for exception ninja.leaping.configurate.reactive.TransactionFailedException
- TransactionFailedException(Throwable) - Constructor for exception ninja.leaping.configurate.reactive.TransactionFailedException
- TransformAction - Interface in ninja.leaping.configurate.transformation
-
Represents an action to be performed that transforms a node in the configuration tree
- Transformations - Class in ninja.leaping.configurate.examples
-
An example of how to use transformations to migrate a configuration to a newer schema version.
- Transformations() - Constructor for class ninja.leaping.configurate.examples.Transformations
- tryDeserialize(Object) - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
-
Attempt to deserialize the provided object, but rather than throwing an exception when a parse error occurs, return null instead.
- Tutorial - Class in ninja.leaping.configurate.examples
- Tutorial() - Constructor for class ninja.leaping.configurate.examples.Tutorial
- type() - Method in class ninja.leaping.configurate.objectmapping.serialize.ScalarSerializer
-
Get the general type token applicable for this serializer.
- Types - Class in ninja.leaping.configurate
-
Contains functions useful for performing configuration type conversions.
- TypeSerializer<T> - Interface in ninja.leaping.configurate.objectmapping.serialize
-
Represents an object which can serialize and deserialize objects of a given type.
- TypeSerializerCollection - Class in ninja.leaping.configurate.objectmapping.serialize
-
A calculated collection of
TypeSerializer
s - TypeSerializers - Class in ninja.leaping.configurate.objectmapping.serialize
-
A number of
TypeSerializer
s provided by configurate. - TypeSerializers() - Constructor for class ninja.leaping.configurate.objectmapping.serialize.TypeSerializers
U
- UNKNOWN - ninja.leaping.configurate.reference.ConfigurationReference.ErrorPhase
- unordered() - Static method in class ninja.leaping.configurate.util.MapFactories
-
Returns a
MapFactory
which creates maps without an order. - update(Function<T, ? extends T>) - Method in interface ninja.leaping.configurate.reference.ValueReference
-
Update this value and the underlying node, without saving.
- updateAsync(Function<N, ? extends N>) - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Update this configuration using the provided function, returning a
Publisher
which will complete with the result of the operation. - updateAsync(Function<T, ? extends T>) - Method in interface ninja.leaping.configurate.reference.ValueReference
-
Update, performing the action and save on the executor of the owning
ConfigurationReference
. - updateNode(N) - Static method in class ninja.leaping.configurate.examples.Transformations
-
Apply the transformations to a node
- updates() - Method in interface ninja.leaping.configurate.reference.ConfigurationReference
-
Access the
Publisher
that will broadcast update events, providing the newly created node.
V
- value() - Method in annotation type ninja.leaping.configurate.objectmapping.Setting
-
The path this setting is located at
- VALUE - ninja.leaping.configurate.reference.ConfigurationReference.ErrorPhase
- valueOf(String) - Static method in enum ninja.leaping.configurate.json.FieldValueSeparatorStyle
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ninja.leaping.configurate.loader.CommentHandlers
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ninja.leaping.configurate.loader.HeaderMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ninja.leaping.configurate.reference.ConfigurationReference.ErrorPhase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ninja.leaping.configurate.transformation.MoveStrategy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum ninja.leaping.configurate.ValueType
-
Deprecated.Returns the enum constant of this type with the specified name.
- ValueReference<T> - Interface in ninja.leaping.configurate.reference
-
A pointer to a node within a configuration tree.
- ValueReferences - Class in ninja.leaping.configurate.examples
- ValueReferences(Path) - Constructor for class ninja.leaping.configurate.examples.ValueReferences
- values() - Static method in enum ninja.leaping.configurate.json.FieldValueSeparatorStyle
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum ninja.leaping.configurate.loader.CommentHandlers
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum ninja.leaping.configurate.loader.HeaderMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum ninja.leaping.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 ninja.leaping.configurate.transformation.MoveStrategy
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum ninja.leaping.configurate.ValueType
-
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
- ValueType - Enum in ninja.leaping.configurate
-
Deprecated.Use
ConfigurationNode.isList()
andConfigurationNode.isMap()
for the same information - versionedBuilder() - Static method in class ninja.leaping.configurate.transformation.ConfigurationTransformation
-
This creates a builder for versioned transformations.
- VersionedBuilder() - Constructor for class ninja.leaping.configurate.transformation.ConfigurationTransformation.VersionedBuilder
- visit(ConfigurationVisitor.Safe<S, T>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Visit this node hierarchy as described in
ConfigurationVisitor
This overload will remove the need for exception handling for visitors that do not have any checked exceptions. - visit(ConfigurationVisitor.Safe<S, T>, S) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Visit this node hierarchy as described in
ConfigurationVisitor
This overload will remove the need for exception handling for visitors that do not have any checked exceptions. - visit(ConfigurationVisitor.Safe<S, T>, S) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- visit(ConfigurationVisitor<S, T, E>) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Visit this node hierarchy as described in
ConfigurationVisitor
- visit(ConfigurationVisitor<S, T, E>, S) - Method in interface ninja.leaping.configurate.ConfigurationNode
-
Visit this node hierarchy as described in
ConfigurationVisitor
- visit(ConfigurationVisitor<S, T, E>, S) - Method in class ninja.leaping.configurate.SimpleConfigurationNode
- visitPath(ConfigurationTransformation.NodePath, ConfigurationNode) - Method in interface ninja.leaping.configurate.transformation.TransformAction
-
Called at a certain path, with the node at that path.
W
- walk(T) - Method in class ninja.leaping.configurate.util.ConfigurationNodeWalker
-
Deprecated.Returns an iterator which will iterate over all nodes in the configuration, in the order defined by the walker.
- walk(T, BiConsumer<? super NodePath, ? super T>) - Method in class ninja.leaping.configurate.util.ConfigurationNodeWalker
-
Deprecated.Walks the configuration, and calls the
consumer
for each path and node visited, in the order defined by the walker. - walkWithPath(T) - Method in class ninja.leaping.configurate.util.ConfigurationNodeWalker
-
Deprecated.Returns an iterator which will iterate over all paths and nodes in the configuration, in the order defined by the walker.
- WatchServiceListener - Class in ninja.leaping.configurate.reference
-
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 - Class in ninja.leaping.configurate.reference
-
Set the parameters needed to create a
WatchServiceListener
. - WILDCARD_OBJECT - Static variable in class ninja.leaping.configurate.transformation.ConfigurationTransformation
-
A special object that represents a wildcard in a path provided to a configuration transformer
- withHeader(String) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with the specified header set, and all other settings copied from this instance. - withMapFactory(MapFactory) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with the specifiedMapFactory
set, and all other settings copied from this instance. - withNativeTypes(Set<Class<?>>) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with the specified native types set, and all other settings copied from this instance. - withObjectMapperFactory(ObjectMapperFactory) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with the specifiedObjectMapperFactory
set, and all other settings copied from this instance. - withSerializers(Consumer<TypeSerializerCollection>) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with a newTypeSerializerCollection
created as a child of this options' current collection. - withSerializers(TypeSerializerCollection) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with the specifiedTypeSerializerCollection
set, and all other settings copied from this instance. - withShouldCopyDefaults(boolean) - Method in class ninja.leaping.configurate.ConfigurationOptions
-
Creates a new
ConfigurationOptions
instance, with the specified 'copy defaults' setting set, and all other settings copied from this instance. - writeHeaderInternal(Writer) - Method in class ninja.leaping.configurate.loader.AbstractConfigurationLoader
- writeHeaderInternal(Writer) - Method in class ninja.leaping.configurate.xml.XMLConfigurationLoader
X
- XML_STYLE - ninja.leaping.configurate.loader.CommentHandlers
-
CommentHandler
for comments delineated using<!-- -->
. - XMLConfigurationLoader - Class in ninja.leaping.configurate.xml
-
A loader for XML (Extensible Markup Language), using the native javax library for parsing and generation.
- XMLConfigurationLoader.Builder - Class in ninja.leaping.configurate.xml
-
Builds a
XMLConfigurationLoader
.
Y
- YAMLConfigurationLoader - Class in ninja.leaping.configurate.yaml
-
A loader for YAML-formatted configurations, using the SnakeYAML library for parsing and generation.
- YAMLConfigurationLoader.Builder - Class in ninja.leaping.configurate.yaml
-
Builds a
YAMLConfigurationLoader
.
Z
- zeroToOne() - Static method in class ninja.leaping.configurate.examples.Transformations
All Classes|All Packages
ObjectMapper.collectFields(Map, TypeToken)
instead