Class ContextValue<C extends TriggerContext, T>

java.lang.Object

io.github.syst3ms.skriptparser.registration.context.ContextValue<C,T>

public class ContextValue<C extends TriggerContext, T>
extends Object

A class containing info about a context value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ContextValue.State	An enum to indicate the relative position in time between two similar context values.
static enum	ContextValue.Usage	One can use context values in two different ways: context-something - the value is used with the common prefix 'context'; or something - the value is used alone as an expression. The usage determines which of the two variants, or both, are applicable.

Constructor Summary

Constructors

Constructor	Description
ContextValue(Class<C> context, Type<T> returnType, boolean isSingle, PatternElement pattern, @Nullable Function<C,T> singleFunction, @Nullable Function<C,T[]> listFunction, @Nullable BiConsumer<C,T> singleSetterFunction, @Nullable BiConsumer<C,T[]> listSetterFunction, ContextValue.State state, ContextValue.Usage usage, @Nullable String description, Class<? extends C>[] excluded)

Method Summary

Modifier and Type	Method	Description
boolean	canBeSet()
static <C extends TriggerContext, T> ContextValue<C,T>	createList(Class<C> context, Type<T> returnType, PatternElement pattern, Function<C,T[]> listFunction, BiConsumer<C,T[]> listSetterFunction, ContextValue.State state, ContextValue.Usage usage, @Nullable String description, Class<? extends C>[] excluded)
static <C extends TriggerContext, T> ContextValue<C,T>	createSingle(Class<C> context, Type<T> returnType, PatternElement pattern, Function<C,T> singleFunction, BiConsumer<C,T> singleSetterFunction, ContextValue.State state, ContextValue.Usage usage, @Nullable String description, Class<? extends C>[] excluded)
Class<C>	getContext()
@Nullable String	getDescription()	Get the description of this context value.
Class<? extends C>[]	getExcluded()	Some subclasses don't want to inherit the context values of their parents.
Function<C,T[]>	getListFunction()	Returns the function that will be applied onto the context in order to retrieve the correct value.
BiConsumer<C,T[]>	getListSetterFunction()
PatternElement	getPattern()	Returns the pattern of this context value.
PatternType<T>	getReturnType()
Function<C,T>	getSingleFunction()
BiConsumer<C,T>	getSingleSetterFunction()
ContextValue.State	getState()	A contextual expression mostly refers to things that happen because of the event, but, sometimes, an event can have a former and future aspect.
ContextValue.Usage	getUsage()
boolean	isSingle()

Methods inherited from class Object

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

Constructor Details

ContextValue

public ContextValue(Class<C> context,
 Type<T> returnType,
 boolean isSingle,
 PatternElement pattern,
 @Nullable
 @Nullable Function<C,T> singleFunction,
 @Nullable
 @Nullable Function<C,T[]> listFunction,
 @Nullable
 @Nullable BiConsumer<C,T> singleSetterFunction,
 @Nullable
 @Nullable BiConsumer<C,T[]> listSetterFunction,
 ContextValue.State state,
 ContextValue.Usage usage,
 @Nullable
 @Nullable String description,
 Class<? extends C>[] excluded)

Method Details

createSingle

public static <C extends TriggerContext, T>
ContextValue<C,T> createSingle(Class<C> context,
 Type<T> returnType,
 PatternElement pattern,
 Function<C,T> singleFunction,
 BiConsumer<C,T> singleSetterFunction,
 ContextValue.State state,
 ContextValue.Usage usage,
 @Nullable
 @Nullable String description,
 Class<? extends C>[] excluded)

createList

public static <C extends TriggerContext, T>
ContextValue<C,T> createList(Class<C> context,
 Type<T> returnType,
 PatternElement pattern,
 Function<C,T[]> listFunction,
 BiConsumer<C,T[]> listSetterFunction,
 ContextValue.State state,
 ContextValue.Usage usage,
 @Nullable
 @Nullable String description,
 Class<? extends C>[] excluded)

getContext

public Class<C> getContext()

getReturnType

public PatternType<T> getReturnType()

isSingle

public boolean isSingle()

getPattern

public PatternElement getPattern()

Returns the pattern of this context value.

Returns:

the pattern

canBeSet

public boolean canBeSet()

getSingleFunction

public Function<C,T> getSingleFunction()

getSingleSetterFunction

public BiConsumer<C,T> getSingleSetterFunction()

getListFunction

public Function<C,T[]> getListFunction()

Returns the function that will be applied onto the context in order to retrieve the correct value.

Returns:

the function

getListSetterFunction

public BiConsumer<C,T[]> getListSetterFunction()

getState

public ContextValue.State getState()

A contextual expression mostly refers to things that happen because of the event, but, sometimes, an event can have a former and future aspect. The state of the context value describes these aspects.

Returns:

whether this happens in the past, present or future

getUsage

public ContextValue.Usage getUsage()

Returns:

whether this value can be used alone

getDescription

@Nullable
public @Nullable String getDescription()

Get the description of this context value.

Returns:

Description of this context value or null if none is provided

getExcluded

public Class<? extends C>[] getExcluded()

Some subclasses don't want to inherit the context values of their parents. The returned array contains all the subclasses that should be excluded when parsing this context value.

Returns:

the excluded contexts