Package ch.njol.skript.lang

Class SyntaxElementInfo<E extends SyntaxElement>

java.lang.Object

ch.njol.skript.lang.SyntaxElementInfo<E>

Type Parameters:

E - the syntax element this info is for

All Implemented Interfaces:

DefaultSyntaxInfos, SyntaxInfo<E>

Direct Known Subclasses:

ExpressionInfo, StructureInfo

@Deprecated(since="2.14",
            forRemoval=true)
public class SyntaxElementInfo<E extends SyntaxElement>
extends Object
implements SyntaxInfo<E>

Deprecated, for removal: This API element is subject to removal in a future version.

Use SyntaxInfo (SyntaxInfo.builder(Class)) instead. Note that some syntax types have specific SyntaxInfo implementations that they require.

Nested Class Summary

Nested classes/interfaces inherited from interface org.skriptlang.skript.registration.DefaultSyntaxInfos

DefaultSyntaxInfos.Expression<E extends Expression<R>,R>, DefaultSyntaxInfos.Structure<E extends Structure>

Nested classes/interfaces inherited from interface org.skriptlang.skript.registration.SyntaxInfo

SyntaxInfo.Builder<B extends SyntaxInfo.Builder<B,E>,E extends SyntaxElement>

Field Summary

Fields

Modifier and Type	Field	Description
final Class<E>	elementClass	Deprecated, for removal: This API element is subject to removal in a future version.
final String	originClassPath	Deprecated, for removal: This API element is subject to removal in a future version.
final String[]	patterns	Deprecated, for removal: This API element is subject to removal in a future version.

Fields inherited from interface org.skriptlang.skript.registration.SyntaxInfo

COMBINED, PATTERN_MATCHES_EVERYTHING, SIMPLE

Constructor Summary

Constructors

Modifier	Constructor	Description
	SyntaxElementInfo(String[] patterns, Class<E> elementClass, String originClassPath)	Deprecated, for removal: This API element is subject to removal in a future version.
protected	SyntaxElementInfo(SyntaxInfo<E> source)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
static <I extends SyntaxElementInfo<E>, E extends SyntaxElement> I	fromModern(SyntaxInfo<? extends E> info)	Deprecated, for removal: This API element is subject to removal in a future version.
Class<E>	getElementClass()	Deprecated, for removal: This API element is subject to removal in a future version. Get the class that represents this element.
String	getOriginClassPath()	Deprecated, for removal: This API element is subject to removal in a future version. Get the original classpath for this element.
String[]	getPatterns()	Deprecated, for removal: This API element is subject to removal in a future version. Get the patterns of this syntax element.
E	instance()	Deprecated, for removal: This API element is subject to removal in a future version.
Origin	origin()	Deprecated, for removal: This API element is subject to removal in a future version.
@Unmodifiable Collection<String>	patterns()	Deprecated, for removal: This API element is subject to removal in a future version.
Priority	priority()	Deprecated, for removal: This API element is subject to removal in a future version.
SyntaxInfo.Builder<? extends SyntaxInfo.Builder<?,E>,E>	toBuilder()	Deprecated, for removal: This API element is subject to removal in a future version.
Class<E>	type()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

Field Details

elementClass

public final Class<E extends SyntaxElement> elementClass

Deprecated, for removal: This API element is subject to removal in a future version.

patterns

public final String[] patterns

Deprecated, for removal: This API element is subject to removal in a future version.

originClassPath

public final String originClassPath

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Details

SyntaxElementInfo

public SyntaxElementInfo(String[] patterns,
 Class<E> elementClass,
 String originClassPath)
                  throws IllegalArgumentException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IllegalArgumentException

SyntaxElementInfo

@Internal
protected SyntaxElementInfo(SyntaxInfo<E> source)
                     throws IllegalArgumentException

Deprecated, for removal: This API element is subject to removal in a future version.

Throws:

IllegalArgumentException

Method Details

getElementClass

public Class<E> getElementClass()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the class that represents this element.

Returns:

The Class of the element

getPatterns

public String[] getPatterns()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the patterns of this syntax element.

Returns:

Array of Skript patterns for this element

getOriginClassPath

public String getOriginClassPath()

Deprecated, for removal: This API element is subject to removal in a future version.

Get the original classpath for this element.

Returns:

The original ClassPath for this element

fromModern

@Internal
@Contract("_ -> new")
public static <I extends SyntaxElementInfo<E>,
E extends SyntaxElement>
I fromModern(SyntaxInfo<? extends E> info)

Deprecated, for removal: This API element is subject to removal in a future version.

toBuilder

@Internal
public SyntaxInfo.Builder<? extends SyntaxInfo.Builder<?,E>,E> toBuilder()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

toBuilder in interface SyntaxInfo<E extends SyntaxElement>

Returns:

A builder representing this SyntaxInfo.

origin

@Internal
public Origin origin()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

origin in interface SyntaxInfo<E extends SyntaxElement>

Returns:

The origin of this syntax.

type

@Internal
public Class<E> type()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

type in interface SyntaxInfo<E extends SyntaxElement>

Returns:

The class providing the implementation of this syntax.

instance

@Internal
public E instance()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

instance in interface SyntaxInfo<E extends SyntaxElement>

Returns:

A new instance of the class providing the implementation of this syntax.

patterns

@Internal
public @Unmodifiable Collection<String> patterns()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

patterns in interface SyntaxInfo<E extends SyntaxElement>

Returns:

The patterns of this syntax.

priority

@Internal
public Priority priority()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

priority in interface SyntaxInfo<E extends SyntaxElement>

Returns:

The priority of this syntax, which dictates its position for matching during parsing.