All Classes and Interfaces
Class
Description
The abstract shape of a config, before proper resolution
An atomic config structure, i.e.
An intersection config structure, i.e.
A union config structure, i.e.
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 PluginA condition that can be placed upon an argument of a given type.
Handles resolution of an argument to a value of type
T.List of hierarchical names
Abstract view of configuration options for some
AbstractConfigStructure.Configuration options for a config type.
Configuration options for a config property
Inspects the AST and sends errors/warnings for invalid setups
Specifically marks a property in a configuration type as being bound to its type in Guice.
A
Supplier which caches the value it supplies.A ConfigProvider that caches the config to avoid repeated file reads.
If an Annotation should also apply to inner / nested classes.
Utility class for casting objects
Input about a click event in a
SpigotGUI.Utility for deserializing collections using the MittenLib config system.
A command Classes should extend this instead of
BaseCommand.A command is an object which performs some side effect and produces a message upon completion.
Marker for environments that a Command can run in, letting it access environment-specific data.
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
LangMessages This allows LangMessages 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.
Guice module for binding configurations.
Guice module for configuration infrastructure.
Responsible for setting up access to a config file.
Used in generated code to help with the loading of config maps
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
PathsGeneral 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.
Creates
ConfigProviders for ConfigurationsImproves a
ConfigProvider by wrapping it with (possible) extra functionality.Responsible for both reading and mapping data, delegating to
ObjectLoaders and ObjectMappersWhere a config came from (its declaring class/interface annotated with @
Config)Denotes a type as the root of a union
Represents a loadable configuration from a file which will (de)serialize to/from an object of
type
T.Responsible for generating proper class names for configuration classes.
Responsible for both mapping and writing data, delegating to
SerializationFunctions and
ObjectWriters.Information about a custom deserializer.
Defines a custom serializer for a specific type.
Marks a class as a custom serializer for the specified target type.
Information about a custom serializer.
Like
JsonElement but without a strict dependency on jsonUtility class for transforming between
DataTree and POJO representations.Factory for creating a
TypeAdapter for DataTree objects.Default implementation of
AbstractMiniMessageFactory.A
ConfigProvider which delegates to another ConfigProvider, improving it with a
ConfigProviderImproverGenerates 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 TThrown when a DTO class references an invalid type
Helper class for working with
ElementsDefines the parsing scheme for an enum value, i.e.
Strategies to parse an enum from a string value.
Utility class for enums
Generates equals and hashCode methods for configuration classes.
Utility class for dealing with
ThrowablesA 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
ConfigProvider that reads and writes from a file, using a ConfigReaderA 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 FileTypeModuleA watcher for a file.
Exception thrown when there is an error with file watching operations.
Sets up the
FileWatcherServiceHandles 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
FunctionsUtility class for working with
Futures and CompletableFuturesMarks 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.
Utility class for shared code generation logic.
An
ObjectLoader that uses Gson to parse a JSON stringAn
ObjectMapper implementation using Gson.An
ObjectWriter implementation that writes DataTree instances to JSON using a
provided Gson instance.Standard provider for
Gson instances.Base interface for GUI applications, based on the Elm Architecture (Model-View-Update / TEA).
Manages GUI sessions and their lifecycles.
Guice module for the GUI framework.
Represents an active GUI session with state management and event handling.
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
FormattingHooksA button in a Spigot GUI Inventory.
Like
SafeFunction but only for IOExceptionAn
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.A
ConfigPathResolver that resolves config paths from the jar resources.Creates a
TypeAdapter that can serialize elements with just a message to plain Strings
(i.e not complex objects), and vice versaA basic service for sending language messages to command senders.
A
FormattingHook that replaces legacy color codes with their MiniMessage equivalent.Creates a new empty
Multibinder for Bukkit Listeners and binds ListenerRegistration as an eager singleton.Implementations for immutable Maps used in
MapsUtility functions for creating immutable maps Unnecessary in Java 9+
Different strategies for generating match methods for records or unions.
Specifies how match methods should be generated for a union.
A MessageFormatter is responsible for formatting a String into a
Component, applying some
FormattingHooks to the String.Manages method names for configuration classes to ensure they don't conflict with existing
methods.
Factory interface for creating GUI components.
An
AbstractMessageFormatter that uses MiniMessage to create a Component from a
StringAn extension of
LangModule that adds support for MiniMessage.Base class for modules that load configurations.
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
NamingPatternsMarks a type as a newtype (single-value wrapper).
Generates deserialization code for non-generic types (including primitive types, boxed
primitives, strings, enums, config-annotated classes, custom-deserialized classes, and
objectMapper fallbacks).
A
ConfigInitializationStrategy that does nothing.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 inversesInverse to
ObjectLoaderA
FormattingHook which applies PlaceholderAPI placeholders to the message.Binds PAPI related classes
Utility class for working with
PathsA
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
Overrides some elements of
ConfigInfrastructureModule to provide more plugin-specific
implementations.A
ConfigPathResolver that resolves paths relative to a Plugin's data folderA representation of a property in a configuration type.
A function isomorphic to
Function, but with the expectation that it is
pure.A record with a single constructor
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.A
ConfigProvider that supports saving to the same source it reads from.An
ObjectLoader which tries each known FileType in order, until one succeeds.Generates serialization code for configuration classes.
Context for serializing a config
A function that serializes a config object to a
DataTreeImplementations for immutable sets used in
SetsUtility 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 Components.Marks a
Config class as being loaded from a file.A command that can be executed in a Spigot GUI context.
The context for a Spigot command execution.
Handles Spigot inventory events and connects them to the GUI framework.
Base class for Spigot GUIs.
Spigot implementation of the GUIManager.
A view of a Spigot GUI - not a real inventory, but a description of one.
Spigot implementation of GUIFactory for creating GUI components.
Generic utilities for converting objects to strings.
A
ConfigProvider that reads from a String.A formatting hook that applies string replacements
A tab completer for a command argument.
Generates toString methods for configuration classes.
Helper class for working with
TypeMirrorsUnit value
Marks a configuration property to use ObjectMapper for serialization.
Information about a constraint placed upon a config property.
Minecraft versions "enum"
Generic interface for a
ConfigProvider that wraps another ConfigProvider.Responsible for writing DataTree objects to YAML format.