Package org.skriptlang.skript.lang.properties

Class PropertyBaseExpression<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>>

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<Object>

org.skriptlang.skript.lang.properties.PropertyBaseExpression<Handler>

Type Parameters:

Handler - The type of ExpressionPropertyHandler used by this expression.

All Implemented Interfaces:

Debuggable, Expression<Object>, Loopable<Object>, Simplifiable<Expression<? extends Object>>, SyntaxElement, PropertyBaseSyntax<Handler>, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

Direct Known Subclasses:

PropExprAmount, PropExprCustomName, PropExprName, PropExprNumber, PropExprSize, PropExprValueOf

@Experimental
public abstract class PropertyBaseExpression<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>>
extends SimpleExpression<Object>
implements PropertyBaseSyntax<Handler>

A base class for properties that requires only few overridden methods. Any property using this class must have a handler implementing PropertyHandler.ExpressionPropertyHandler.
This class handles multiple possible property handlers for different input types, as well as change modes and type checking.
convert(Event, ExpressionPropertyHandler, Object) can be overridden to customize how the property value is retrieved.

See Also:

• PropExprName - An example implementation of this class.

Field Summary

Fields

Modifier and Type	Field	Description
protected Expression<?>	expr
protected PropertyMap<Handler>	properties
protected final Property<Handler>	property
protected Class<?>	returnType
protected Class<?>[]	returnTypes
protected boolean	useCIP

Constructor Summary

Constructors

Constructor	Description
PropertyBaseExpression()

Method Summary

Modifier and Type	Method	Description
Class<?> @Nullable []	acceptChange(Changer.ChangeMode mode)	Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.
void	change(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode)	Changes the expression's value by the given amount.
protected <T> @Nullable Object	convert(org.bukkit.event.Event event, Handler handler, T source)	Converts a source object to the property value using the given handler.
protected Object @Nullable []	get(org.bukkit.event.Event event)	This is the internal method to get an expression's values. To get the expression's value from the outside use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).
protected Class<?> @NotNull []	getPropertyReturnTypes(@NotNull PropertyMap<Handler> properties, Function<Handler,Class<?>[]> getReturnType)
Class<?>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
boolean	isSingle()
Class<?>[]	possibleReturnTypes()	For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types.
protected static void	register(Class<? extends PropertyBaseExpression<?>> expressionClass, String property, String types)
String	toString(org.bukkit.event.Event event, boolean debug)

Methods inherited from class ch.njol.skript.lang.util.SimpleExpression

check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, simplify, supportsLoopPeeking, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.njol.skript.lang.Expression

beforeChange, canBeSingle, canReturn, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, stream, streamAll

Methods inherited from interface org.skriptlang.skript.lang.properties.PropertyBaseSyntax

getBadTypesErrorMessage, getProperty, getPropertyName

Methods inherited from interface org.skriptlang.skript.log.runtime.RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

Methods inherited from interface ch.njol.skript.lang.SyntaxElement

getParser

Methods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer

getErrorSource

Field Details

expr

protected Expression<?> expr

properties

protected PropertyMap<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>> properties

returnTypes

protected Class<?>[] returnTypes

returnType

protected Class<?> returnType

property

protected final Property<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>> property

useCIP

protected boolean useCIP

Constructor Details

PropertyBaseExpression

public PropertyBaseExpression()

Method Details

register

protected static void register(Class<? extends PropertyBaseExpression<?>> expressionClass,
 String property,
 String types)

init

public boolean init(Expression<?>[] expressions,
 int matchedPattern,
 Kleenean isDelayed,
 SkriptParser.ParseResult parseResult)

Description copied from interface: SyntaxElement

Called just after the constructor and SyntaxElement.preInit().

Specified by:

init in interface SyntaxElement

Parameters:

expressions - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out, it will still be included in this list holding the default value of the desired type, which usually depends on the event.

matchedPattern - The index of the pattern which matched

isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)

parseResult - Additional information about the match.

Returns:

Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.

See Also:

• ParserInstance.isCurrentEvent(Class...)

getPropertyReturnTypes

protected Class<?> @NotNull [] getPropertyReturnTypes(@NotNull
 @NotNull PropertyMap<Handler> properties,
 Function<Handler,Class<?>[]> getReturnType)

get

protected Object @Nullable [] get(org.bukkit.event.Event event)

Description copied from class: SimpleExpression

This is the internal method to get an expression's values.
To get the expression's value from the outside use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).

Specified by:

get in class SimpleExpression<Object>

Parameters:

event - The event with which this expression is evaluated.

Returns:

An array of values for this event. May not contain nulls.

convert

@Nullable
protected <T> @Nullable Object convert(org.bukkit.event.Event event,
 Handler handler,
 T source)

Converts a source object to the property value using the given handler. Users that override this method may have to cast the handler to have the appropriate generics. It is guaranteed that the handler can handle the source object, but the Java generics system cannot reflect that. See the default implementation for an example of this sort of casting.

Type Parameters:

T - The type of the source object and the type the handler will accept.

Parameters:

event - The event in which the conversion is happening.

handler - The handler to use for conversion.

source - The source object to convert.

Returns:

The converted property value, or null if the conversion failed.

acceptChange

public Class<?> @Nullable [] acceptChange(Changer.ChangeMode mode)

Description copied from interface: Expression

Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

Unlike Changer.acceptChange(ChangeMode) this method may print errors.

Specified by:

acceptChange in interface Expression<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>>

Overrides:

acceptChange in class SimpleExpression<Object>

Parameters:

mode - The mode to check

Returns:

An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

change

public void change(org.bukkit.event.Event event,
 Object @Nullable [] delta,
 Changer.ChangeMode mode)

Description copied from interface: Expression

Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)

Specified by:

change in interface Expression<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>>

Overrides:

change in class SimpleExpression<Object>

Parameters:

event - The event

delta - An array with one or more instances of one or more of the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.

mode - The Changer.ChangeMode of the attempted change

isSingle

public boolean isSingle()

Specified by:

isSingle in interface Expression<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>>

Returns:

true if this expression will ever only return one value at most, false if it can return multiple values.

getReturnType

public Class<?> getReturnType()

Description copied from interface: Expression

Gets the return type of this expression.

Specified by:

getReturnType in interface Expression<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>>

Returns:

A supertype of any objects returned by Expression.getSingle(Event) and the component type of any arrays returned by Expression.getArray(Event)

possibleReturnTypes

public Class<?>[] possibleReturnTypes()

Description copied from interface: Expression

For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types. Use cases include: expressions that depend on the return type of their input.

Specified by:

possibleReturnTypes in interface Expression<Handler extends PropertyHandler.ExpressionPropertyHandler<?,?>>

Returns:

A list of all possible types this might return

toString

public String toString(org.bukkit.event.Event event,
 boolean debug)

Specified by:

toString in interface Debuggable

Parameters:

event - The event to get information from. This is always null if debug == false.

debug - If true this should print more information, if false this should print what is shown to the end user

Returns:

String representation of this object