Class ConvertedExpression<F,T>
- All Implemented Interfaces:
Debuggable
,Expression<T>
,SyntaxElement
- Direct Known Subclasses:
ConvertedLiteral
SimpleExpression.getConvertedExpr(Class...)
because this
class
- automatically lets the source expression handle everything apart from the get() methods
- will never convert itself to another type, but rather request a new converted expression from the source expression.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionConvertedExpression
(Expression<? extends F> source, Class<T> to, Collection<ConverterInfo<? super F, ? extends T>> infos, boolean performFromCheck) ConvertedExpression
(Expression<? extends F> source, Class<T> to, ConverterInfo<? super F, ? extends T> info) -
Method Summary
Modifier and TypeMethodDescriptionClass<?> @Nullable []
Tests whether this expression supports the given mode, and if yes what type it expects thedelta
to be.Object @Nullable []
beforeChange
(Expression<?> changed, Object @Nullable [] delta) This method is called before this expression is set to another one.void
change
(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode) Changes the expression's value by the given amount.boolean
Checks this expression against the given checker.boolean
Checks this expression against the given checker.T[]
getAll
(org.bukkit.event.Event event) Gets all possible return values of this expression, i.e.boolean
getAnd()
Returns true if this expression returns all possible values, false if it only returns some of them.T[]
getArray
(org.bukkit.event.Event event) Get all the values of this expression.<R> @Nullable Expression
<? extends R> getConvertedExpression
(Class<R>... to) Tries to convert this expression to the given type.Gets the return type of this expression.getSingle
(org.bukkit.event.Event event) Get the single value of this expression.Expression
<?> Returns the original expression that was parsed, i.e.int
getTime()
final boolean
init
(Expression<?>[] vars, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult matcher) Called just after the constructor.boolean
Returns whether this value represents the default value of its type for the event, i.e.boolean
Checks whether the given 'loop-...' expression should match this loop, e.g.boolean
isSingle()
iterator
(org.bukkit.event.Event event) Returns the same asExpression.getArray(Event)
but as an iterator.static <F,
T> @Nullable ConvertedExpression <F, T> newInstance
(Expression<F> from, Class<T>... to) boolean
setTime
(int time) Sets the time of this expression, i.e.Expression
<? extends T> simplify()
Simplifies the expression, e.g.toString()
Should returntoString
(null, false)toString
(@Nullable org.bukkit.event.Event event, boolean debug) 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
canBeSingle, canReturn, getAcceptedChangeModes, getOptionalSingle, possibleReturnTypes, stream
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser
-
Field Details
-
source
-
to
-
-
Constructor Details
-
ConvertedExpression
public ConvertedExpression(Expression<? extends F> source, Class<T> to, ConverterInfo<? super F, ? extends T> info) -
ConvertedExpression
public ConvertedExpression(Expression<? extends F> source, Class<T> to, Collection<ConverterInfo<? super F, ? extends T>> infos, boolean performFromCheck) - Parameters:
source
- The expression to use for obtaining valuesto
- The type we are converting toinfos
- A collection of converters to attemptperformFromCheck
- Whether a safety check should be performed to ensure that objects being converted are valid for the converter being attempted
-
-
Method Details
-
newInstance
@SafeVarargs @Nullable public static <F,T> @Nullable ConvertedExpression<F,T> newInstance(Expression<F> from, Class<T>... to) -
init
public final boolean init(Expression<?>[] vars, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult matcher) Description copied from interface:SyntaxElement
Called just after the constructor.- Specified by:
init
in interfaceSyntaxElement
- Parameters:
vars
- 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 matchedisDelayed
- Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)matcher
- 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:
-
toString
- Specified by:
toString
in interfaceDebuggable
- 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
-
toString
Description copied from interface:Debuggable
Should returntoString
(null, false)- Specified by:
toString
in interfaceDebuggable
- Overrides:
toString
in classObject
-
getReturnType
Description copied from interface:Expression
Gets the return type of this expression.- Specified by:
getReturnType
in interfaceExpression<F>
- Returns:
- A supertype of any objects returned by
Expression.getSingle(Event)
and the component type of any arrays returned byExpression.getArray(Event)
-
isSingle
public boolean isSingle()- Specified by:
isSingle
in interfaceExpression<F>
- Returns:
- true if this expression will ever only return one value at most, false if it can return multiple values.
-
getConvertedExpression
Description copied from interface:Expression
Tries to convert this expression to the given type. This method can print an error prior to returning null to specify the cause.Please note that expressions whose
returnType
is not Object will not be parsed at all for a certain class if there's no converter from the expression's returnType to the desired class. Thus this method should only be overridden if this expression's returnType is Object.The returned expression should delegate this method to the original expression's method to prevent excessive converted expression chains (see also
ConvertedExpression
).- Specified by:
getConvertedExpression
in interfaceExpression<F>
- Parameters:
to
- The desired return type of the returned expression- Returns:
- Expression with the desired return type or null if the expression can't be converted to the given type. Returns the expression itself if it already returns the desired type.
- See Also:
-
acceptChange
Description copied from interface:Expression
Tests whether this expression supports the given mode, and if yes what type it expects thedelta
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) inExpression.change(Event, Object[], ChangeMode)
with super.change(...).Unlike
Changer.acceptChange(ChangeMode)
this method may print errors.- Specified by:
acceptChange
in interfaceExpression<F>
- Parameters:
mode
- The mode to check- Returns:
- An array of types that
Expression.change(Event, Object[], ChangeMode)
accepts as itsdelta
parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. ForChanger.ChangeMode.DELETE
andChanger.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 desireddelta
type as returned byExpression.acceptChange(ChangeMode)
- Specified by:
change
in interfaceExpression<F>
- Parameters:
event
- The eventdelta
- An array with one or more instances of one or more of the classes returned byExpression.acceptChange(ChangeMode)
for the given change mode (null forChanger.ChangeMode.DELETE
andChanger.ChangeMode.RESET
). This can be a Object[], thus casting is not allowed.mode
- TheChanger.ChangeMode
of the attempted change
-
getSingle
Description copied from interface:Expression
Get the single value of this expression.This method may only return null if it always returns null for the given event, i.e. it is equivalent to getting a random element out of
Expression.getAll(Event)
or null iff that array is empty.Do not use this in conditions, use
Expression.check(Event, Checker, boolean)
instead.- Specified by:
getSingle
in interfaceExpression<F>
- Parameters:
event
- The event- Returns:
- The value or null if this expression doesn't have any value for the event
-
getArray
Description copied from interface:Expression
Get all the values of this expression. The returned array is empty if this expression doesn't have any values for the given event.The returned array must not contain any null values.
Do not use this in conditions, use
Expression.check(Event, Checker, boolean)
instead.- Specified by:
getArray
in interfaceExpression<F>
- Parameters:
event
- The event- Returns:
- An array of values of this expression which must neither be null nor contain nulls, and which must not be an internal array.
-
getAll
Description copied from interface:Expression
Gets all possible return values of this expression, i.e. it returns the same asExpression.getArray(Event)
ifExpression.getAnd()
is true, otherwise all possible values forExpression.getSingle(Event)
.- Specified by:
getAll
in interfaceExpression<F>
- Parameters:
event
- The event- Returns:
- An array of all possible values of this expression for the given event which must neither be null nor contain nulls, and which must not be an internal array.
-
check
Description copied from interface:Expression
Checks this expression against the given checker. This is the normal version of this method and the one which must be used for simple checks, or as the innermost check of nested checks.Usual implementation (may differ, e.g. may return false for nonexistent values independent of negated):
return negated ^
Expression.check(Event, Checker)
;- Specified by:
check
in interfaceExpression<F>
- Parameters:
event
- The event to be used for evaluationchecker
- The checker that determines whether this expression matchesnegated
- The checking condition's negated state. This is used to invert the output of the checker if set to true (i.e. negated ^ checker.check(...))- Returns:
- Whether this expression matches or doesn't match the given checker depending on the condition's negated state.
- See Also:
-
check
Description copied from interface:Expression
Checks this expression against the given checker. This method must only be used around other checks, useExpression.check(Event, Checker, boolean)
for a simple check or the innermost check of a nested check.- Specified by:
check
in interfaceExpression<F>
- Parameters:
event
- The event to be used for evaluationchecker
- A checker that determines whether this expression matches- Returns:
- Whether this expression matches the given checker
- See Also:
-
getAnd
public boolean getAnd()Description copied from interface:Expression
Returns true if this expression returns all possible values, false if it only returns some of them.This method significantly influences
Expression.check(Event, Checker)
,Expression.check(Event, Checker, boolean)
andCondIsSet
and thus breaks conditions that use this expression if it returns a wrong value.This method must return true if this is a
single
expression. // TODO make this method irrelevant for single expressions- Specified by:
getAnd
in interfaceExpression<F>
- Returns:
- Whether this expression returns all values at once or only part of them.
-
setTime
public boolean setTime(int time) Description copied from interface:Expression
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of
ErrorQuality.SEMANTIC_ERROR
to be printed (NB:Skript.error(String)
always creates semantic errors).- Specified by:
setTime
in interfaceExpression<F>
- Parameters:
time
- -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.- Returns:
- Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
ParserInstance.isCurrentEvent(Class)
). - See Also:
-
getTime
public int getTime()- Specified by:
getTime
in interfaceExpression<F>
- Returns:
- The value passed to
Expression.setTime(int)
or 0 if it was never changed. - See Also:
-
isDefault
public boolean isDefault()Description copied from interface:Expression
Returns whether this value represents the default value of its type for the event, i.e. it can be replaced with a call to event.getXyz() if one knows the event invalid input: '&' value type.This method might be removed in the future as it's better to check whether value == event.getXyz() for every value an expression returns.
- Specified by:
isDefault
in interfaceExpression<F>
- Returns:
- Whether this is the return types' default expression
-
isLoopOf
Description copied from interface:Expression
Checks whether the given 'loop-...' expression should match this loop, e.g. loop-block matches any loops that loop through blocks and loop-argument matches an argument loop.You should usually just return false as e.g. loop-block will automatically match the expression if its returnType is Block or a subtype of it.
- Specified by:
isLoopOf
in interfaceExpression<F>
- Parameters:
input
- The entered input string (the blank in loop-___)- Returns:
- Whether this loop matches the given string
-
iterator
Description copied from interface:Expression
Returns the same asExpression.getArray(Event)
but as an iterator. This method should be overriden by expressions intended to be looped to increase performance.- Specified by:
iterator
in interfaceExpression<F>
- Parameters:
event
- The event to be used for evaluation- Returns:
- An iterator to iterate over all values of this expression which may be empty and/or null, but must not return null elements.
-
getSource
Description copied from interface:Expression
Returns the original expression that was parsed, i.e. without any conversions done.This method is undefined for simplified expressions.
- Specified by:
getSource
in interfaceExpression<F>
- Returns:
- The unconverted source expression of this expression or this expression itself if it was never converted.
-
simplify
Description copied from interface:Expression
Simplifies the expression, e.g. if it only contains literals the expression may be simplified to a literal, and wrapped expressions are unwrapped.After this method was used the toString methods are likely not useful anymore.
This method is not yet used but will be used to improve efficiency in the future.
- Specified by:
simplify
in interfaceExpression<F>
- Returns:
- A reference to a simpler version of this expression. Can change this expression directly and return itself if applicable, i.e. no references to the expression before this method call should be kept!
-
beforeChange
Description copied from interface:Expression
This method is called before this expression is set to another one. The return value is what will be used for change. You can use modified version of initial delta array or create a new one altogetherDefault implementation will convert slots to items when they're set to variables, as specified in Skript documentation.
- Specified by:
beforeChange
in interfaceExpression<F>
- Parameters:
changed
- What is about to be set.delta
- Initial delta array.- Returns:
- Delta array to use for change.
-