Package ch.njol.skript.expressions

Class ExprDefaultValue<T>

java.lang.Object

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

ch.njol.skript.expressions.ExprDefaultValue<T>

All Implemented Interfaces:

Debuggable, Expression<T>, SyntaxElement

@Name("Default Value")
@Description("A shorthand expression for giving things a default value. If the first thing isn\'t set, the second thing will be returned.")
@Examples("broadcast {score::%player\'s uuid%} otherwise \"%player% has no score!\"")
@Since("2.2-dev36")
public class ExprDefaultValue<T>
extends SimpleExpression<T>

Constructor Summary

Constructors

Constructor	Description
ExprDefaultValue()

Method Summary

Modifier and Type	Method	Description
protected T[]	get(org.bukkit.event.Event e)	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).
<R> Expression<? extends R>	getConvertedExpression(Class<R>... to)	Usually, you want to override SimpleExpression.getConvertedExpr(Class[]).
Class<? extends T>	getReturnType()	Gets the return type of this expression.
Expression<?>	getSource()	Returns the original expression that was parsed, i.e.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.
boolean	isSingle()
String	toString(org.bukkit.event.Event e, boolean debug)

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

acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpr, getSingle, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, simplify, 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, stream

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

getParser

Constructor Details

ExprDefaultValue

public ExprDefaultValue()

Method Details

init

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

Description copied from interface: SyntaxElement

Called just after the constructor.

Parameters:

exprs - 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...)

get

protected T[] get(org.bukkit.event.Event e)

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<T>

Parameters:

e - The event

Returns:

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

getConvertedExpression

public <R> Expression<? extends R> getConvertedExpression(Class<R>... to)

Description copied from class: SimpleExpression

Usually, you want to override SimpleExpression.getConvertedExpr(Class[]). However, it may be useful to override this method if you have an expression with a return type that is unknown until runtime (like variables). Usually, you'll be fine with just the default implementation. This method is final on versions below 2.2-dev36.

Specified by:

getConvertedExpression in interface Expression<T>

Overrides:

getConvertedExpression in class SimpleExpression<T>

Parameters:

to - The desired return type of the returned expression

Returns:

The converted expression

See Also:

Converter, ConvertedExpression

getSource

public Expression<?> 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 interface Expression<T>

Overrides:

getSource in class SimpleExpression<T>

Returns:

The unconverted source expression of this expression or this expression itself if it was never converted.

getReturnType

public Class<? extends T> getReturnType()

Description copied from interface: Expression

Gets the return type of this expression.

Returns:

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

isSingle

public boolean isSingle()

Returns:

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

toString

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

Parameters:

e - The event to get information to. 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