Index
All Classes and Interfaces|All Packages
A
- AdvancedEnumSerializer<E extends Enum<E>> - Class in com.mrivanplays.annotationconfig.core.serialization
-
Enum
serializer, which uses different tricks to serialize enum constants to user-friendly values for configs, and also to read them properly. - AnnotatedConfigResolver - Class in com.mrivanplays.annotationconfig.core.internal
- AnnotationHolder - Class in com.mrivanplays.annotationconfig.core.internal
- AnnotationHolder() - Constructor for class com.mrivanplays.annotationconfig.core.internal.AnnotationHolder
- AnnotationHolder(Field, int) - Constructor for class com.mrivanplays.annotationconfig.core.internal.AnnotationHolder
- AnnotationType - Enum in com.mrivanplays.annotationconfig.core.annotations.type
-
Represents an annotation type, holding utility methods for the held raw annotation type.
- AnnotationValidator<T extends Annotation> - Interface in com.mrivanplays.annotationconfig.core.annotations.custom
-
Represents a validator of a custom annotation.
B
- boxTo(String, Object, Map<String, Object>) - Method in class com.mrivanplays.annotationconfig.core.resolver.key.DottedResolver
-
AnnotationConfig calls this method whenever it needs to populate the specified
Map
values
with the specifiedvalue
and specifiedkey
. - boxTo(String, Object, Map<String, Object>) - Method in interface com.mrivanplays.annotationconfig.core.resolver.key.KeyResolver
-
AnnotationConfig calls this method whenever it needs to populate the specified
Map
values
with the specifiedvalue
and specifiedkey
. - build() - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Builds a new
ConfigResolver
ready for use. - build() - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings.Builder
-
Builds this builder into
LoadSettings
- Builder() - Constructor for class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
- Builder(boolean) - Constructor for class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings.Builder
- Builder(ConfigResolver.Builder) - Constructor for class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Creates a copy of the specified builder
C
- com.mrivanplays.annotationconfig.core - package com.mrivanplays.annotationconfig.core
- com.mrivanplays.annotationconfig.core.annotations - package com.mrivanplays.annotationconfig.core.annotations
- com.mrivanplays.annotationconfig.core.annotations.comment - package com.mrivanplays.annotationconfig.core.annotations.comment
- com.mrivanplays.annotationconfig.core.annotations.custom - package com.mrivanplays.annotationconfig.core.annotations.custom
- com.mrivanplays.annotationconfig.core.annotations.type - package com.mrivanplays.annotationconfig.core.annotations.type
- com.mrivanplays.annotationconfig.core.internal - package com.mrivanplays.annotationconfig.core.internal
- com.mrivanplays.annotationconfig.core.resolver - package com.mrivanplays.annotationconfig.core.resolver
- com.mrivanplays.annotationconfig.core.resolver.key - package com.mrivanplays.annotationconfig.core.resolver.key
- com.mrivanplays.annotationconfig.core.resolver.options - package com.mrivanplays.annotationconfig.core.resolver.options
- com.mrivanplays.annotationconfig.core.resolver.settings - package com.mrivanplays.annotationconfig.core.resolver.settings
- com.mrivanplays.annotationconfig.core.serialization - package com.mrivanplays.annotationconfig.core.serialization
- Comment - Annotation Type in com.mrivanplays.annotationconfig.core.annotations.comment
-
Annotation, telling the config writer to write a comment with the specified value.
- COMMENT - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- Comments - Annotation Type in com.mrivanplays.annotationconfig.core.annotations.comment
-
Annotation, representing the outcome of a repeated
Comment
annotation. - COMMENTS - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- compareTo(AnnotationHolder) - Method in class com.mrivanplays.annotationconfig.core.internal.AnnotationHolder
- CONFIG_OBJECT - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- ConfigObject - Annotation Type in com.mrivanplays.annotationconfig.core.annotations
-
Annotation, representing that the annotated field should be treated as a config object/section.
- ConfigResolver - Interface in com.mrivanplays.annotationconfig.core.resolver
-
Represents a resolver of configurations.
- ConfigResolver.Builder - Class in com.mrivanplays.annotationconfig.core.resolver
-
Represents a builder of a
ConfigResolver
- ConfigResolverImpl - Class in com.mrivanplays.annotationconfig.core.internal
- ConfigResolverImpl(String, ValueWriter, ValueReader, CustomOptions, LoadSettings, KeyResolver, boolean) - Constructor for class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- copy() - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Creates a copy of this builder
- copy() - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings.Builder
-
Creates a copy of the current builder.
- copy() - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings
-
Creates a copy of the current load settings
- CustomAnnotationRegistry - Enum in com.mrivanplays.annotationconfig.core.annotations.custom
-
Represents a registry for custom annotations.
- CustomOptions - Class in com.mrivanplays.annotationconfig.core.resolver.options
-
Represents a class, containing options for reading or writing a file.
D
- DataObject - Class in com.mrivanplays.annotationconfig.core.serialization
-
A class, which stores read from config values or serialized values in a developer friendly way.
- DataObject() - Constructor for class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Constructs a empty data object
- DataObject(Object) - Constructor for class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Constructs a data object, which holds the specified data.
- DataObject(Map<String, Object>) - Constructor for class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Constructs a data object, which holds the specified map data.
- DEFAULT - Static variable in interface com.mrivanplays.annotationconfig.core.resolver.key.KeyResolver
-
Returns the default key resolver used by AnnotationConfig.
- DEFAULT_MATCHES_CONDITION - Static variable in class com.mrivanplays.annotationconfig.core.serialization.AdvancedEnumSerializer
-
The default matches condition
- deserialize(DataObject, Field) - Method in class com.mrivanplays.annotationconfig.core.serialization.AdvancedEnumSerializer
-
AnnotationConfig invokes this call-back method during deserialization when it encounters a field of the specified type.
- deserialize(DataObject, Field) - Method in interface com.mrivanplays.annotationconfig.core.serialization.FieldTypeSerializer
-
AnnotationConfig invokes this call-back method during deserialization when it encounters a field of the specified type.
- DottedResolver - Class in com.mrivanplays.annotationconfig.core.resolver.key
-
Represents a resolver of dotted keys.
- dump(Object, File) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- dump(Object, File) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
- dump(Object, OutputStream) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
- dump(Object, Writer) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- dump(Object, Writer) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
- dump(Object, Map<AnnotationHolder, Set<AnnotationType>>, File, CustomOptions, String, ValueWriter, KeyResolver, boolean) - Static method in class com.mrivanplays.annotationconfig.core.internal.AnnotatedConfigResolver
- dump(Object, Map<AnnotationHolder, Set<AnnotationType>>, Writer, CustomOptions, String, ValueWriter, KeyResolver, boolean) - Static method in class com.mrivanplays.annotationconfig.core.internal.AnnotatedConfigResolver
E
- empty() - Static method in class com.mrivanplays.annotationconfig.core.resolver.options.CustomOptions
-
Creates a new empty
CustomOptions
instance. - empty() - Static method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings
-
Creates new empty load settings.
F
- fail(Throwable) - Static method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns a failure validation response.
- failSilently() - Static method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns a failure validation response, which is going to cancel field set silently.
- FieldTypeSerializer<T> - Interface in com.mrivanplays.annotationconfig.core.serialization
-
Interface representing a custom serializer and deserializer of a field type.
- forEnum(Class<E>) - Static method in class com.mrivanplays.annotationconfig.core.serialization.AdvancedEnumSerializer
-
Creates a new
AdvancedEnumSerializer
for the specifiedenumClass
- forEnumWithCondition(Class<E>, BiPredicate<Integer, List<String>>) - Static method in class com.mrivanplays.annotationconfig.core.serialization.AdvancedEnumSerializer
-
Creates a new
AdvancedEnumSerializer
for the specifiedenumClass
with the specifiedmatchesCondition
. - fromBooleanValue(boolean) - Static method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns validation response given the boolean value.
- fromBooleanValue(boolean, Throwable) - Static method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns validation response given the boolean value.
- fromBooleanValue(boolean, Throwable, Runnable) - Static method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns validation response given the boolean value.
G
- GENERATE_NEW_OPTIONS - Static variable in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSetting
-
A
Boolean
type load setting, representing whether to generate new/non-existing options in a file. - get(LoadSetting<T>) - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings
-
Returns the value held for the specified
LoadSetting
setting
- get(String) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the
DataObject
value held by the specified key. - getAs(String, Class<T>) - Method in class com.mrivanplays.annotationconfig.core.resolver.options.CustomOptions
-
Returns the held
Option
, assigned to the specified key, as the specified type. - getAsBoolean() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Boolean
- getAsByte() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Byte
- getAsChar() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Character
- getAsDouble() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Double
- getAsFloat() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Float
- getAsInt() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Integer
- getAsList() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
- getAsLong() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Long
- getAsMap() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
- getAsObject() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object.
- getAsOr(String, Class<T>, T) - Method in class com.mrivanplays.annotationconfig.core.resolver.options.CustomOptions
- getAsShort() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
Short
- getAsString() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
String
- getConfigResolver() - Static method in class com.mrivanplays.annotationconfig.core.PropertyConfig
-
Returns the
ConfigResolver
instance of PropertyConfig - getDefault() - Static method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings
-
Returns the default load settings.
- getDefaultSerializer() - Method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Returns the default serializer.
- getField() - Method in class com.mrivanplays.annotationconfig.core.internal.AnnotationHolder
- getFieldOrder() - Method in class com.mrivanplays.annotationconfig.core.internal.AnnotationHolder
- getInstance() - Static method in class com.mrivanplays.annotationconfig.core.resolver.key.DottedResolver
-
Returns the instance of the
DottedResolver
- getKey() - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSetting
-
Returns the key of this load setting.
- getList(Class<T>) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns the held value by this data object as a
List
of the specified class type. - getRawType() - Method in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
-
Returns the raw annotation type, held by this
AnnotationType
- getSerializer(Class<?>) - Method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Returns an
Optional
value, which may or may not be filled with aFieldTypeSerializer
, depending on if theserializedType
has been registered or not. - getType() - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSetting
-
Returns the class type of this load setting.
- getValidator(Class<? extends Annotation>) - Method in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
-
Returns the
AnnotationValidator
bound to the specifiedannotationClass
.
H
- has(String) - Method in class com.mrivanplays.annotationconfig.core.resolver.options.CustomOptions
-
Returns whether this custom options instance has an
Option
, assigned to the specified key. - has(String) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns whether the specified key has a value in this data object.
- hasSerializer(Class<?>) - Method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Returns whether the specified type has a serializer registered.
- hasValidator(Class<? extends Annotation>) - Method in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
-
Returns whether the specified
annotation
has a validator.
I
- Ignore - Annotation Type in com.mrivanplays.annotationconfig.core.annotations
-
Annotation, which is marking field(s) to be excluded from dumping in the config and modifying, whenever they don't have any of the other annotations.
- IGNORE - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- INSTANCE - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
- INSTANCE - Enum constant in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
- is(AnnotationType) - Method in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- is(Class<? extends Annotation>) - Method in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
-
Returns if the raw annotation type specified meets this
AnnotationType
- isClass() - Method in class com.mrivanplays.annotationconfig.core.internal.AnnotationHolder
- isEmpty() - Method in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
-
Returns whether the registry contains any validators.
- isReplaceable(String) - Method in class com.mrivanplays.annotationconfig.core.resolver.options.CustomOptions
-
Returns whether the
Option
, contained or not, in this custom options instance, assigned to the specified key, can be replaced. - isSingleValue() - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Returns whether this data object holds a single value and not a map.
K
- Key - Annotation Type in com.mrivanplays.annotationconfig.core.annotations
-
Annotation, representing the config key for the field the annotation is called on.
- KEY - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- KeyResolver - Interface in com.mrivanplays.annotationconfig.core.resolver.key
-
Represents a resolver of config keys, which boxes and unboxes them.
L
- load(Object, File) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- load(Object, File) - Static method in class com.mrivanplays.annotationconfig.core.PropertyConfig
-
Deprecated.
- load(Object, File) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedFile
file
using the defaultLoadSettings
from the builder of this config resolver, orLoadSettings.getDefault()
. - load(Object, File, LoadSettings) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- load(Object, File, LoadSettings) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedFile
file
using theLoadSettings
loadSettings
specified. - load(Object, InputStream) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedInputStream
in
using the defaultLoadSettings
from the builder of this config resolver, orLoadSettings.getDefault()
. - load(Object, InputStream, LoadSettings) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedInputStream
in
using theLoadSettings
loadSettings
specified. - load(Object, Reader) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- load(Object, Reader) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedReader
reader
using the defaultLoadSettings
from the builder of this config resolver, orLoadSettings.getDefault()
. - load(Object, Reader, LoadSettings) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- load(Object, Reader, LoadSettings) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedReader
reader
using theLoadSettings
loadSettings
specified. - loadOrDump(Object, File) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- loadOrDump(Object, File) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedFile
file
, if it exists, if not, dumps the specifiedannotatedConfig
to the specified file, using the defaultLoadSettings
from the builder of this config resolver, orLoadSettings.getDefault()
. - loadOrDump(Object, File, LoadSettings) - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- loadOrDump(Object, File, LoadSettings) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Loads the specified
annotatedConfig
from the specifiedFile
file
, if it exists, if not, dumps the specifiedannotatedConfig
to the specified file, using theLoadSettings
loadSettings
specified. - LoadSetting<T> - Class in com.mrivanplays.annotationconfig.core.resolver.settings
- LoadSettings - Class in com.mrivanplays.annotationconfig.core.resolver.settings
-
Represents load settings.
- LoadSettings.Builder - Class in com.mrivanplays.annotationconfig.core.resolver.settings
-
Represents a builder for
LoadSettings
M
- markReplaceable() - Method in class com.mrivanplays.annotationconfig.core.resolver.options.Option
-
Marks this option instance as replaceable.
- match(Class<? extends Annotation>) - Static method in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
-
Returns an
Optional
value, which may contain theAnnotationType
matched to the specified . - Max - Annotation Type in com.mrivanplays.annotationconfig.core.annotations
-
Annotation, representing the maximal string length or the maximal int/double/byte/float/short/long value.
- MAX - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- maxByte() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Max
- maxDouble() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Max
- maxFloat() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Max
- maxInt() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Max
- maxLong() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Max
- maxShort() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Max
- Min - Annotation Type in com.mrivanplays.annotationconfig.core.annotations
-
Annotation, representing a minimal string length or a minimal int/double/byte/float/short/long value.
- MIN - Enum constant in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- minByte() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Min
- minDouble() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Min
- minFloat() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Min
- minInt() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Min
- minLong() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Min
- minShort() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Min
N
- newBuilder() - Static method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Creates a new
ConfigResolver.Builder
- newBuilder() - Static method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings
-
Creates a new empty
LoadSettings.Builder
- newBuilder(boolean) - Static method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings
-
Creates a new
LoadSettings.Builder
- NULL_READ_HANDLER - Static variable in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSetting
-
A load setting, value of which tells AnnotationConfig how to handle null read values.
- NullReadHandleOption - Enum in com.mrivanplays.annotationconfig.core.resolver.settings
-
Represents a simple 2 option enum, which is telling the resolver how to handle null values, which have been deserialized, but the deserialized value returned null.
O
- of(String, Class<T>) - Static method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSetting
-
Creates a new load setting.
- of(Map<String, Option>) - Static method in class com.mrivanplays.annotationconfig.core.resolver.options.CustomOptions
-
Creates a new
CustomOptions
instance with the specified data. - of(T) - Static method in class com.mrivanplays.annotationconfig.core.resolver.options.Option
-
Creates a new
Option
instance. - onSuccess() - Method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns a
Runnable
to run, which marks this validation response is successful. - Option<T> - Class in com.mrivanplays.annotationconfig.core.resolver.options
-
Represents an option, which is holding a non-null value and information whether it can be replaced or not.
- options() - Method in class com.mrivanplays.annotationconfig.core.internal.ConfigResolverImpl
- options() - Method in interface com.mrivanplays.annotationconfig.core.resolver.ConfigResolver
-
Returns the
CustomOptions
instance.
P
- PropertyConfig - Class in com.mrivanplays.annotationconfig.core
-
Represents configuration, utilising .conf/.properties configuration type.
- PropertyConfig() - Constructor for class com.mrivanplays.annotationconfig.core.PropertyConfig
- put(String, boolean) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Binds the specified value to the specified key
- put(String, Option<T>) - Method in class com.mrivanplays.annotationconfig.core.resolver.options.CustomOptions
-
Assigns the specified
Option
to the specified key. - put(String, Number) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Binds the specified value to the specified key
- put(String, String) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Binds the specified value to the specified key
- putAll(String, DataObject) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Binds the specified
DataObject
to the specified key.
R
- read(Reader) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ValueReader
-
Should read the specified reader to a Map.
- read(Reader, CustomOptions) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ValueReader
-
Should read the specified reader to a Map.
- read(Reader, CustomOptions, LoadSettings) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ValueReader
-
Should read the specified reader to a Map.
- register(Class<T>, AnnotationValidator<T>) - Method in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
- registerSerializer(Class<T>, FieldTypeSerializer<T>) - Method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Registers a new serializer.
- registerSerializer(Class<T>, BiFunction<DataObject, Field, T>, BiFunction<T, Field, DataObject>) - Method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Registers a new serializer.
- remove(String) - Method in class com.mrivanplays.annotationconfig.core.serialization.DataObject
-
Removes the value of the specified key.
- replaceable() - Method in class com.mrivanplays.annotationconfig.core.resolver.options.Option
-
Returns whether this option is replaceable in a
CustomOptions
context. - resolveAnnotations(Object, boolean) - Static method in class com.mrivanplays.annotationconfig.core.internal.AnnotatedConfigResolver
S
- serialize(E, Field) - Method in class com.mrivanplays.annotationconfig.core.serialization.AdvancedEnumSerializer
-
AnnotationConfig invokes this call-back method during serialization when it encounters a field of the specified type.
- serialize(T, Field) - Method in interface com.mrivanplays.annotationconfig.core.serialization.FieldTypeSerializer
-
AnnotationConfig invokes this call-back method during serialization when it encounters a field of the specified type.
- SerializerRegistry - Enum in com.mrivanplays.annotationconfig.core.serialization
-
Represents a registry of all the serializers.
- set(LoadSetting<T>, T) - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings
- SET_NULL - Enum constant in enum com.mrivanplays.annotationconfig.core.resolver.settings.NullReadHandleOption
-
If this constant is set, it tells the resolver that if we get a null value it will bind it to the
Field
, which is representing that value. - setFields(Object, Map<String, Object>, Map<AnnotationHolder, Set<AnnotationType>>, NullReadHandleOption, CustomOptions, KeyResolver, boolean) - Static method in class com.mrivanplays.annotationconfig.core.internal.AnnotatedConfigResolver
- shouldFailSilently() - Method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns whether to fail silently, which marks this validation response is not successful.
- shouldReverseFields(boolean) - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Sets whether to reverse fields when generating options.
- SILENT_FAIL - Static variable in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns a failure validation response, which is going to cancel field set silently.
- success() - Static method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns successful validation response.
- success(Runnable) - Static method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns a successful validation response.
- SUCCESS - Static variable in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns successful validation response.
T
- throwError() - Method in interface com.mrivanplays.annotationconfig.core.annotations.custom.ValidationResponse
-
Returns a
Throwable
to throw, which marks this validation response is not successful. - toString() - Method in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
- toString() - Method in class com.mrivanplays.annotationconfig.core.internal.AnnotationHolder
U
- unbox(String, Map<String, Object>) - Method in class com.mrivanplays.annotationconfig.core.resolver.key.DottedResolver
-
AnnotationConfig calls this method whenever it needs the value of the specified
key
. - unbox(String, Map<String, Object>) - Method in interface com.mrivanplays.annotationconfig.core.resolver.key.KeyResolver
-
AnnotationConfig calls this method whenever it needs the value of the specified
key
. - unregister(Class<? extends Annotation>) - Method in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
-
Removes the bound to the specified
annotation
AnnotationValidator
if there is any. - unregisterSerializer(Class<?>) - Method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Unregisters the serializer of the specified serialized type
- USE_DEFAULT_VALUE - Enum constant in enum com.mrivanplays.annotationconfig.core.resolver.settings.NullReadHandleOption
-
If this constant is set, it tells the resolver that if we get a null value it will skip binding it to the
Field
, which is representing that value, which in tern means that it will return the default value.
V
- validate(T, Object, CustomOptions, Field) - Method in interface com.mrivanplays.annotationconfig.core.annotations.custom.AnnotationValidator
-
AnnotationConfig calls this method whenever it finds the custom annotation this validator is bound to in order to determine whether the inputted
value
is valid for the custom annotation with which the inputtedField
field
was annotated. - ValidationResponse - Interface in com.mrivanplays.annotationconfig.core.annotations.custom
-
Represents a response of a custom annotation value validation.
- value() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.comment.Comment
-
The comment you want to specify.
- value() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.comment.Comments
- value() - Element in annotation type com.mrivanplays.annotationconfig.core.annotations.Key
-
Key value
- value() - Method in class com.mrivanplays.annotationconfig.core.resolver.options.Option
-
Returns the value held by this option.
- valueOf(String) - Static method in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mrivanplays.annotationconfig.core.resolver.settings.NullReadHandleOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Returns the enum constant of this type with the specified name.
- ValueReader - Interface in com.mrivanplays.annotationconfig.core.resolver
- values() - Static method in enum com.mrivanplays.annotationconfig.core.annotations.custom.CustomAnnotationRegistry
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mrivanplays.annotationconfig.core.annotations.type.AnnotationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mrivanplays.annotationconfig.core.resolver.settings.NullReadHandleOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.mrivanplays.annotationconfig.core.serialization.SerializerRegistry
-
Returns an array containing the constants of this enum type, in the order they are declared.
- ValueWriter - Interface in com.mrivanplays.annotationconfig.core.resolver
-
Represents a writer of field values for specific config type.
W
- withCommentPrefix(String) - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Sets the comment prefix for the config type you want to generate configs.
- withKeyResolver(KeyResolver) - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Sets the
KeyResolver
for the config type you want to generate configs. - withLoadSetting(LoadSetting<T>, T) - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
- withOption(String, Option<T>) - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Binds the specified
Option
value to the specifed key. - withSetting(LoadSetting<T>, T) - Method in class com.mrivanplays.annotationconfig.core.resolver.settings.LoadSettings.Builder
- withValueReader(ValueReader) - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Sets the value reader for the config type you want to generate configs.
- withValueWriter(ValueWriter) - Method in class com.mrivanplays.annotationconfig.core.resolver.ConfigResolver.Builder
-
Sets the
ValueWriter
for the config type you want to generate configs. - write(String, Object, PrintWriter, CustomOptions, boolean) - Method in interface com.mrivanplays.annotationconfig.core.resolver.ValueWriter
All Classes and Interfaces|All Packages
PropertyConfig.getConfigResolver()
. it has a much better description of methods. the equivalent of this method there isConfigResolver.loadOrDump(Object, File, LoadSettings)