Package org.skriptlang.skript.registration

Interface SyntaxRegistry

All Superinterfaces:

Iterable<SyntaxInfo<?>>, Registry<SyntaxInfo<?>>, ViewProvider<SyntaxRegistry>

@Experimental
public interface SyntaxRegistry
extends ViewProvider<SyntaxRegistry>, Registry<SyntaxInfo<?>>

A syntax registry is a central container for all SyntaxInfos.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SyntaxRegistry.ChildKey<I extends P,P extends SyntaxInfo<?>>	Like a SyntaxRegistry.Key, but it has a parent which causes elements to be registered to itself and its parent.
static interface	SyntaxRegistry.Key<I extends SyntaxInfo<?>>	Represents a syntax element type.

Field Summary

Fields

Modifier and Type	Field	Description
static final SyntaxRegistry.Key<SyntaxInfo<? extends Condition>>	CONDITION	A key representing the built-in Condition syntax element.
static final SyntaxRegistry.Key<SyntaxInfo<? extends Effect>>	EFFECT	A key representing the built-in Effect syntax element.
static final SyntaxRegistry.Key<DefaultSyntaxInfos.Expression<?,?>>	EXPRESSION	A key representing the built-in Expression syntax element.
static final SyntaxRegistry.Key<SyntaxInfo<? extends Section>>	SECTION	A key representing the built-in Section syntax element.
static final SyntaxRegistry.Key<SyntaxInfo<? extends Statement>>	STATEMENT	A key representing all Statement syntax elements.
static final SyntaxRegistry.Key<DefaultSyntaxInfos.Structure<?>>	STRUCTURE	A key representing the built-in Structure syntax element.

Method Summary

Modifier and Type	Method	Description
@Unmodifiable Collection<SyntaxInfo<?>>	elements()	There are no guarantees on the ordering of the returned collection.
static SyntaxRegistry	empty()	Constructs a default implementation of a syntax registry.
<I extends SyntaxInfo<?>> void	register(SyntaxRegistry.Key<I> key, I info)	Registers a new syntax under a provided key.
<I extends SyntaxInfo<?>> @Unmodifiable Collection<I>	syntaxes(SyntaxRegistry.Key<I> key)	A method to obtain all syntaxes registered under a certain key.
default SyntaxRegistry	unmodifiableView()	Constructs an unmodifiable view of this syntax registry.
void	unregister(SyntaxInfo<?> info)	Unregisters all registrations of a syntax, regardless of the SyntaxRegistry.Key.
<I extends SyntaxInfo<?>> void	unregister(SyntaxRegistry.Key<I> key, I info)	Unregisters a syntax registered under a provided key.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.skriptlang.skript.util.Registry

iterator

Field Details

STRUCTURE

static final SyntaxRegistry.Key<DefaultSyntaxInfos.Structure<?>> STRUCTURE

A key representing the built-in Structure syntax element.

SECTION

static final SyntaxRegistry.Key<SyntaxInfo<? extends Section>> SECTION

A key representing the built-in Section syntax element.

STATEMENT

static final SyntaxRegistry.Key<SyntaxInfo<? extends Statement>> STATEMENT

A key representing all Statement syntax elements. By default, this includes EFFECT and CONDITION.

EFFECT

static final SyntaxRegistry.Key<SyntaxInfo<? extends Effect>> EFFECT

A key representing the built-in Effect syntax element.

CONDITION

static final SyntaxRegistry.Key<SyntaxInfo<? extends Condition>> CONDITION

A key representing the built-in Condition syntax element.

EXPRESSION

static final SyntaxRegistry.Key<DefaultSyntaxInfos.Expression<?,?>> EXPRESSION

A key representing the built-in Expression syntax element.

Method Details

empty

@Contract("-> new")
static SyntaxRegistry empty()

Constructs a default implementation of a syntax registry. This implementation is practically a wrapper around Map<Key<?>, SyntaxRegistry<?>>.

Returns:

A syntax registry containing no elements.

syntaxes

<I extends SyntaxInfo<?>>
@Unmodifiable Collection<I> syntaxes(SyntaxRegistry.Key<I> key)

A method to obtain all syntaxes registered under a certain key.

Type Parameters:

I - The syntax type.

Parameters:

key - The key to obtain syntaxes from.

Returns:

An unmodifiable snapshot of all syntaxes registered under key.

register

<I extends SyntaxInfo<?>> void register(SyntaxRegistry.Key<I> key,
 I info)

Registers a new syntax under a provided key.

Type Parameters:

I - The syntax type.

Parameters:

key - The key to register info under.

info - The syntax info to register.

unregister

void unregister(SyntaxInfo<?> info)

Unregisters all registrations of a syntax, regardless of the SyntaxRegistry.Key.

Parameters:

info - The syntax info to unregister.

See Also:

• unregister(Key, SyntaxInfo)

unregister

<I extends SyntaxInfo<?>> void unregister(SyntaxRegistry.Key<I> key,
 I info)

Unregisters a syntax registered under a provided key.

Type Parameters:

I - The syntax type.

Parameters:

key - The key the info is registered under.

info - The syntax info to unregister.

See Also:

• unregister(SyntaxInfo)

unmodifiableView

@Contract("-> new")
default SyntaxRegistry unmodifiableView()

Constructs an unmodifiable view of this syntax registry. That is, the returned registry will not allow registrations.

Specified by:

unmodifiableView in interface ViewProvider<SyntaxRegistry>

Returns:

An unmodifiable view of this syntax registry.

elements

@Unmodifiable Collection<SyntaxInfo<?>> elements()

There are no guarantees on the ordering of the returned collection.

Specified by:

elements in interface Registry<SyntaxInfo<?>>

Returns:

An unmodifiable snapshot of all syntaxes registered.