Package ovh.mythmc.social.api.context

Class SocialParserContext

java.lang.Object

ovh.mythmc.social.api.context.SocialParserContext

All Implemented Interfaces:

SocialContext

Direct Known Subclasses:

SocialProcessorContext

public class SocialParserContext
extends Object
implements SocialContext

Represents the parsing context of a message before it is formatted or dispatched.

A SocialParserContext provides all necessary information required during the parsing phase of a message, including:

• The SocialUser who sent the message
• The ChatChannel the message is associated with
• The raw Component message content
• The ChatChannel.ChannelType of the message
• An optional SocialParserGroup defining parser behavior
• A collection of injected values

See Also:

• SocialContext
• SocialInjectedValue
• SocialParserGroup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SocialParserContext.Builder<T extends SocialParserContext.Builder<?,?>,R>	Base builder implementation for SocialParserContext.
static class	SocialParserContext.SocialParserContextBuilder	Default builder implementation for SocialParserContext.

Method Summary

Modifier and Type	Method	Description
static SocialParserContext.SocialParserContextBuilder	builder(@NotNull SocialUser user, @NotNull Component message)	Creates a new SocialParserContext.SocialParserContextBuilder for the given user and message.
<V> V	getInjectedValue(@NotNull String identifier)	Retrieves an injected value by its identifier.
<V> V	getInjectedValue(@NotNull String identifier, V defaultValue)	Retrieves an injected value by its identifier, returning a default value if none is found.
Optional<SocialParserGroup>	group()	Returns the parser group if present.
List<SocialInjectedValue<?,?>>	injectedValues()	Returns an immutable copy of the injected values.
<T extends SocialInjectedValue<?, ?>> List<T>	injectedValues(@NotNull Class<T> type)	Returns all injected values of the specified type.
void	injectValue(@NotNull SocialInjectedValue<?,?> injectedValue)	Injects a single value into this context.
void	injectValues(@NotNull Iterable<? extends SocialInjectedValue<?,?>> injectedValues)	Injects multiple values into this context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static SocialParserContext.SocialParserContextBuilder builder(@NotNull
 @NotNull SocialUser user,
 @NotNull
 @NotNull Component message)

Creates a new SocialParserContext.SocialParserContextBuilder for the given user and message.

Parameters:

user - the user sending the message

message - the raw message component

Returns:

a new builder instance

group

public Optional<SocialParserGroup> group()

Returns the parser group if present.

Returns:

an Optional containing the SocialParserGroup, or empty if none is set

injectedValues

public List<SocialInjectedValue<?,?>> injectedValues()

Returns an immutable copy of the injected values.

Returns:

an unmodifiable list of injected values

injectedValues

public <T extends SocialInjectedValue<?,
?>>
List<T> injectedValues(@NotNull
 @NotNull Class<T> type)

Returns all injected values of the specified type.

Type Parameters:

T - the injected value subtype

Parameters:

type - the injected value type

Returns:

a list of injected values matching the given type

injectValue

public void injectValue(@NotNull
 @NotNull SocialInjectedValue<?,?> injectedValue)

Injects a single value into this context.

Parameters:

injectedValue - the value to inject

injectValues

public void injectValues(@NotNull
 @NotNull Iterable<? extends SocialInjectedValue<?,?>> injectedValues)

Injects multiple values into this context.

Parameters:

injectedValues - the values to inject

getInjectedValue

@Nullable
public <V> V getInjectedValue(@NotNull
 @NotNull String identifier)

Retrieves an injected value by its identifier.

Type Parameters:

V - the value type

Parameters:

identifier - the unique identifier

Returns:

the injected value, or null if not present

getInjectedValue

@Nullable
public <V> V getInjectedValue(@NotNull
 @NotNull String identifier,
 V defaultValue)

Retrieves an injected value by its identifier, returning a default value if none is found.

Type Parameters:

V - the value type

Parameters:

identifier - the unique identifier

defaultValue - the value to return if no match is found

Returns:

the injected value or defaultValue if not present