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, Function<C,T[]> function, ContextValue.State state, ContextValue.Usage usage)
ContextValue(Class<C> context, Type<T> returnType, boolean isSingle, PatternElement pattern, Function<C,T[]> function, ContextValue.State state, ContextValue.Usage usage, Class<? extends C>[] excluded)

Method Summary

Modifier and Type	Method	Description
Class<C>	getContext()
Class<? extends C>[]	getExcluded()	Some subclasses don't want to inherit the context values of their parents.
Function<C,T[]>	getFunction()	Returns the function that will be applied onto the context in order to retrieve the correct value.
PatternElement	getPattern()	Returns the pattern of this context value.
PatternType<T>	getReturnType()
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()

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,
 Function<C,T[]> function,
 ContextValue.State state,
 ContextValue.Usage usage)

ContextValue

public ContextValue(Class<C> context,
 Type<T> returnType,
 boolean isSingle,
 PatternElement pattern,
 Function<C,T[]> function,
 ContextValue.State state,
 ContextValue.Usage usage,
 Class<? extends C>[] excluded)

Method Details

getContext

public Class<C> getContext()

getReturnType

public PatternType<T> getReturnType()

getPattern

public PatternElement getPattern()

Returns the pattern of this context value.

Returns:

the pattern

getFunction

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

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

Returns:

the function

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

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