All Classes and Interfaces
Class
Description
The abstract shape of a config, before proper resolution
An abstract implementation of
MessageFormatter
that provides a default implementation of AbstractMessageFormatter.preFormat(String, OfflinePlayer)
.A factory for creating
instances
.Generates accessor methods for configuration classes.
A provider for
BukkitAudiences
that uses the Plugin
A condition that can be placed upon an argument of a given type.
Handles resolution of an argument to a value of type
ArgumentContext
.List of hierarchical names
Inspects the AST and sends errors/warnings for invalid setups
A
Supplier
which caches the value it supplies.A ConfigProvider which caches the config to avoid repeated file reads.
If an Annotation should also apply to inner / nested classes
This is similar to
Inherited
but doesn't require a sub/superclass relation,
which better suits the patterns often used in config DTO types.Utility class for casting objects
Utility for deserializing collections using the MittenLib config system.
A command
Classes should extend this instead of
BaseCommand
.A provider for
PaperCommandManager
.A Guice module for registering commands.
A
ParameterizedType
that can take a dynamic number of type arguments.A message that is composed of multiple
LangMessage
s
This allows LangMessage
s to be easily "concatenated", allowing for more complex messages to be createdMarks a type as a DTO type
that will be processed by the annotation processor, if present.
Responsible for setting up access to a config file
Used in generated code to help with the loading of config maps
Guice module for config handling
Marks an expected name for a field in a config file.
A cache for AbstractConfigStructure objects indexed by their class names.
Responsible for turning simple file names into
Path
sGeneral exception thrown when the config annotation processor fails
Annotation processor for generating configuration classes from DTO classes marked with
Config
.Guice module for the configuration annotation processor.
A
Provider
for a config type ConfigProvider
,
optionally specifying a Path
representing the config file.Creates
ConfigProvider
s for Configuration
sImproves a
ConfigProvider
by wrapping it with (possible) extra functionality.Responsible for both reading and mapping data,
delegating to
ObjectLoader
s and ObjectMapper
sWhere a config came from (its declaring class/interface annotated with @
Config
)Denotes a type as the root of a union
Represents a loadable configuration which will deserialize to an object of type
Configuration
Responsible for generating proper class names for configuration classes.
Like
JsonElement
but without a strict dependency on jsonDefault implementation of
AbstractMiniMessageFactory
.A
ConfigProvider
which delegates to another ConfigProvider
, improving it with a ConfigProviderImprover
Generates deserialization code for configuration classes.
Context for deserializing a config, making it easier to pass around
A function that deserializes a config, taking a
DeserializationContext
and returning a Result
of type DeserializationFunction
Thrown when a DTO class references an invalid type
Helper class for working with
Elements
Utility class for enums
Generates equals and hashCode methods for configuration classes.
Utility class for dealing with
Throwable
sA thin wrapper over a
TypeAdapter
that also stores the type it is for.Marks a custom deserializer as a fallback deserializer.
Responsible for generating serial keys based on DTO fields
A specific type of file such as JSON or YAML which can be loaded into a Map-like data structure.
Stores all the known
FileType
classes,
used for registration in the FileTypeModule
A watcher for a file.
Exception thrown when there is an error with file watching operations.
Sets up the
FileWatcherService
Handles file watching operations.
A
ConfigProvider
that watches a file for changes, reloading the config when the file changesA hook for formatting a String.
Utility class for dealing with
Function
sUtility class for working with
Future
s and CompletableFuture
sMarks a class as being generated from a config DTO.
This class should not be treated as a public API, and is subject to change at any time.
Instructs the annotation processor to generate a toString method for a generated config class.
An
ObjectLoader
that uses Gson to parse a JSON stringAn
ObjectMapper
implementation using Gson
.Standard provider for
Gson
instances.This is a truly outrageous hack
Essentially, when a papi expansion returns a hex color, it doesn't get parsed properly by MiniMessage
and instead it just takes it to the nearest legacy color
This class tries to parse the §x§a...
Guice module for registering common
FormattingHook
sLike
SafeFunction
but only for IOException
An
ArgumentContext
that is aware of the issuer of the command and the argument's value.An
ArgumentContext
that is only aware of the issuer of the command, and not the argument's value.Creates a
TypeAdapter
that can serialize elements with just a message to plain
Strings (i.e not complex objects), and vice versaA
FormattingHook
that replaces legacy color codes with their MiniMessage equivalent.Implementations for immutable Maps used in
Maps
Utility functions for creating immutable maps
Unnecessary in Java 9+
A MessageFormatter is responsible for formatting a String into a
Component
,
applying some FormattingHook
s to the String.Manages method names for configuration classes to ensure they don't conflict with existing methods.
An
AbstractMessageFormatter
that uses MiniMessage to create a Component
from a StringAn extension of
LangModule
that adds support for MiniMessage.Stores the name of the consumer of MittenLib (usually the plugin name).
Main Guice Module for MittenLib.
Exception representing multiple failures that occur simultaneously.
A command condition that is referenced by name on the full command rather than an argument.
Defines a naming pattern for a class or field.
Patterns for naming fields in a config.
Transforms strings into different formats based on a
NamingPatterns
A
ConfigProviderImprover
that does nothing.Utility class for working with nullable values without having to use
Optional
.Interface for mapping objects
It should hold that
map(map(t), T.class).getOrThrow().equals(t)
, i.e both map functions are inversesA
FormattingHook
which applies PlaceholderAPI placeholders to the message.Binds PAPI related classes
Utility class for working with
Path
sA
ConfigInitializationStrategy
that copies a resource from a plugin's jar to its data folder if it does not existThrown when a resource could not be found in a plugin
A
ConfigPathResolver
that resolves paths relative to a Plugin
's data folderA representation of a property in a configuration type.
A
ConfigProvider
that reads from a file, using a ConfigReader
A
Result
encapsulates a computation that may fail, throwing an exception.A
BiConsumer
that can throw a checked exception.A
Consumer
that can throw a checked exception.A
Function
that can throw a checked exception.A
BiFunction
that can throw a checked exception.A
Runnable
that can throw a checked exception.A
Supplier
that can throw a checked exception.Implementations for immutable sets used in
Sets
Utility functions for creating immutable sets
A formatting hook that is always applied, and uses a lambda to format the string.
Default implementation of
MessageFormatter
that uses LegacyComponentSerializer
to create Component
s.Marks a
Config
class as being loaded from a file.Generic utilities for converting objects to strings.
A
ConfigProvider
that reads a String to load a configA formatting hook that applies string replacements
A tab completer for a command argument.
Generates toString methods for configuration classes.
Helper class for working with
TypeMirror
sUnit value
Minecraft versions "enum"
Generic interface for a
ConfigProvider
that wraps another ConfigProvider
.