Uses of Class
com.winterhavenmc.library.messagebuilder.keys.MacroKey

Packages that use MacroKey

Package	Description
com.winterhavenmc.library.messagebuilder.keys	This package contains the StandardKey interface and implementations
com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname	Provides an adapter and interface for extracting and formatting display names from objects.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration	Provides an adapter for objects that expose a Duration.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration	Provides adapter and interface support for expiration-based macro replacements.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant	Provides adapter support for objects that expose a timestamp via the Instant API.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer	Provides support for extracting killer information from entities or plugin-defined objects.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.location	Provides support for extracting and formatting location-based macro values from objects.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter	Contains support for adapting objects that represent looting permissions or claims.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.name	Provides the Nameable interface and its corresponding adapter used to extract and format name-related fields from objects passed into the message pipeline.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner	Provides support for extracting ownership information from objects and applying it to macro placeholders.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection	Provides support for adapting objects with time-based protection attributes into macro string values.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity	Provides support for macro replacement of quantity-related values.
com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid	Provides support for macro replacement of UUID values from objects.
com.winterhavenmc.library.messagebuilder.pipeline.extractor	Provides mechanisms for extracting macro-compatible string values from objects that have been adapted by the Adapter system.
com.winterhavenmc.library.messagebuilder.pipeline.maps	Provides internal map types used in macro extraction and message formatting.
com.winterhavenmc.library.messagebuilder.pipeline.matcher	Provides utilities for identifying macro placeholders within message strings.
com.winterhavenmc.library.messagebuilder.pipeline.resolvers	Provides a hierarchy of Resolver implementations responsible for converting macro-related input values into string representations for use in templated messages.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.keys

Methods in com.winterhavenmc.library.messagebuilder.keys that return MacroKey

Modifier and Type	Method	Description
MacroKey	MacroKey.getBase()

Methods in com.winterhavenmc.library.messagebuilder.keys that return types with arguments of type MacroKey

Modifier and Type	Method	Description
<E extends Enum<E>> Optional<MacroKey>	MacroKey.append(E subKey)	Create a new key by suffixing a dot-separated subkey to this existing key
Optional<MacroKey>	MacroKey.append(String subKey)	Create a new key by suffixing a dot-separated subkey to this existing key
static <E extends Enum<E>> Optional<MacroKey>	MacroKey.of(E key)	Static factory method for instantiating a record key from an enum constant
static Optional<MacroKey>	MacroKey.of(String key)	Static factory method for instantiating a record key from a string

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.displayname with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	DisplayNameable.extractDisplayName(MacroKey baseKey, AdapterContextContainer ctx)	Extracts a MacroStringMap containing the formatted display name under the DISPLAY_NAME subkey of the given base key.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.duration with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Durationable.extractDuration(MacroKey baseKey, ChronoUnit lowerBound, AdapterContextContainer ctx)	Extracts a MacroStringMap containing a single entry mapping the provided MacroKey (with .DURATION appended) to a localized string representation of this object's duration.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.expiration with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Expirable.extractExpiration(MacroKey baseKey, ChronoUnit lowerBound, FormatStyle formatStyle, AdapterContextContainer ctx)	Extracts macro key-value pairs for this object's expiration, including a formatted duration and a formatted instant string.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.instant with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Instantable.extractInstant(MacroKey baseKey, FormatStyle formatStyle, AdapterContextContainer ctx)	Extracts a formatted timestamp field from this Instantable, based on the given FormatStyle and locale context.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.killer with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Killable.extractKiller(MacroKey baseKey, AdapterContextContainer ctx)	Extracts a macro string map with the killer's name, using the given base key and context.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.location

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.location with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Locatable.extractLocation(MacroKey baseKey, AdapterContextContainer ctx)	Extracts macro key-value pairs representing location data from this object.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.looter with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Lootable.extractLooter(MacroKey baseKey, AdapterContextContainer ctx)	Extracts the looter's name as a macro replacement field.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.name

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.name with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Nameable.extractName(MacroKey baseKey, AdapterContextContainer ctx)	Extracts the name field into a MacroStringMap, using the provided base key to construct a dot-notated macro key (e.g., OBJECT.NAME).

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.owner with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Ownable.extractOwner(MacroKey baseKey, AdapterContextContainer ctx)	Extracts the macro value for the owner's name and adds it to a MacroStringMap, using the {OBJECT.OWNER} key.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.protection with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Protectable.extractProtection(MacroKey baseKey, ChronoUnit lowerBound, FormatStyle formatStyle, AdapterContextContainer ctx)	Extracts protection-related fields from this object into a MacroStringMap.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.quantity with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Quantifiable.extractQuantity(MacroKey baseKey, AdapterContextContainer ctx)	Extracts a MacroStringMap containing the formatted quantity string.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid

Methods in com.winterhavenmc.library.messagebuilder.pipeline.adapters.uuid with parameters of type MacroKey

Modifier and Type	Method	Description
default MacroStringMap	Identifiable.extractUid(MacroKey baseKey, AdapterContextContainer ctx)	Extracts a macro string map containing the UUID field.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.extractor

Methods in com.winterhavenmc.library.messagebuilder.pipeline.extractor with parameters of type MacroKey

Modifier and Type	Method	Description
<T> MacroStringMap	Extractor.extract(MacroKey baseKey, Adapter adapter, T adapted)	Extracts a set of macro string values from an adapted object and returns a map of placeholder keys to replacement strings.
<T> MacroStringMap	FieldExtractor.extract(MacroKey baseKey, Adapter adapter, T adapted)	Extracts macro string values from the adapted object using the adapter's corresponding interface, such as Nameable or Locatable.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.maps

Methods in com.winterhavenmc.library.messagebuilder.pipeline.maps that return types with arguments of type MacroKey

Modifier and Type	Method	Description
Iterable<? extends Map.Entry<MacroKey,String>>	MacroStringMap.entrySet()	Returns the set of key-value entries in this map.
Set<MacroKey>	MacroStringMap.keySet()	Returns the set of keys contained in this map.

Methods in com.winterhavenmc.library.messagebuilder.pipeline.maps with parameters of type MacroKey

Modifier and Type	Method	Description
boolean	MacroStringMap.containsKey(MacroKey key)	Returns true if this map contains the specified key.
Optional<Object>	MacroObjectMap.get(MacroKey macroKey)	Retrieves the value associated with the specified MacroKey, if present.
String	MacroStringMap.get(MacroKey key)	Returns the value associated with the given key, or null if not found.
<T> void	MacroObjectMap.put(MacroKey macroKey, T value)	Inserts a key-value pair into the map.
void	MacroStringMap.put(MacroKey macroKey, String value)	Inserts a key-value pair into the map.
<T> void	MacroObjectMap.putIfAbsent(MacroKey macroKey, T value)	Inserts a key-value pair only if the key is not already present in the map.
void	MacroStringMap.putIfAbsent(MacroKey macroKey, String value)	Inserts a key-value pair into the map only if the key is not already present.
MacroStringMap	MacroStringMap.with(MacroKey key, String value)	Adds a key-value pair to this map and returns the map itself.

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.matcher

Methods in com.winterhavenmc.library.messagebuilder.pipeline.matcher that return types with arguments of type MacroKey

Modifier and Type	Method	Description
Stream<MacroKey>	Matcher.match(String input, Pattern pattern)	Extracts macro keys from the given input string using the specified regular expression pattern.
Stream<MacroKey>	PlaceholderMatcher.match(String input, Pattern pattern)

Uses of MacroKey in com.winterhavenmc.library.messagebuilder.pipeline.resolvers

Methods in com.winterhavenmc.library.messagebuilder.pipeline.resolvers with parameters of type MacroKey

Modifier and Type	Method	Description
MacroStringMap	AtomicResolver.resolve(MacroKey macroKey, MacroObjectMap macroObjectMap)	Resolves a single value mapped to the provided MacroKey into a string representation, if the object exists and can be formatted.
MacroStringMap	CompositeResolver.resolve(MacroKey macroKey, MacroObjectMap macroObjectMap)	Resolves a MacroKey by attempting to adapt the associated object from the MacroObjectMap using applicable Adapter instances.
MacroStringMap	FieldResolver.resolve(MacroKey macroKey, MacroObjectMap macroObjectMap)	Resolves a MacroKey using the available macro objects in the given MacroObjectMap, by delegating to each registered resolver in sequence.
MacroStringMap	Resolver.resolve(MacroKey key, MacroObjectMap macroObjectMap)	Resolves a set of string values from the given MacroObjectMap for the provided MacroKey.