Class SkriptRegistration.SyntaxRegistrar<C extends SyntaxElement>

java.lang.Object

io.github.syst3ms.skriptparser.registration.SkriptRegistration.SyntaxRegistrar<C>

All Implemented Interfaces:

SkriptRegistration.Registrar

Direct Known Subclasses:

SkriptRegistration.EffectRegistrar, SkriptRegistration.EventRegistrar, SkriptRegistration.ExpressionRegistrar, SkriptRegistration.SectionRegistrar

Enclosing class:

SkriptRegistration

public abstract class SkriptRegistration.SyntaxRegistrar<C extends SyntaxElement>
extends Object
implements SkriptRegistration.Registrar

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<C>	c
protected final Map<String,Object>	data
protected final Documentation	documentation
protected final List<String>	patterns
protected int	priority

Method Summary

Modifier and Type	Method	Description
SkriptRegistration.SyntaxRegistrar<C>	addData(String identifier, Object data)
SkriptRegistration.SyntaxRegistrar<C>	addPatterns(String... patterns)	Adds patterns to the current syntax
SkriptRegistration.SyntaxRegistrar<C>	description(String... description)
SkriptRegistration.SyntaxRegistrar<C>	examples(String... examples)
SkriptRegistration.SyntaxRegistrar<C>	name(String name)
SkriptRegistration.SyntaxRegistrar<C>	noDoc()
protected List<PatternElement>	parsePatterns()
SkriptRegistration.SyntaxRegistrar<C>	setPriority(int priority)	Sets the priority of the current syntax.
SkriptRegistration.SyntaxRegistrar<C>	since(String since)

Methods inherited from class Object

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

Methods inherited from interface SkriptRegistration.Registrar

register

Field Details

c

protected final Class<C extends SyntaxElement> c

patterns

protected final List<String> patterns

priority

protected int priority

data

protected final Map<String,Object> data

documentation

protected final Documentation documentation

Method Details

addPatterns

public SkriptRegistration.SyntaxRegistrar<C> addPatterns(String... patterns)

Adds patterns to the current syntax

Parameters:

patterns - the patterns to add

Returns:

the registrar

noDoc

public SkriptRegistration.SyntaxRegistrar<C> noDoc()

name

public SkriptRegistration.SyntaxRegistrar<C> name(String name)

description

public SkriptRegistration.SyntaxRegistrar<C> description(String... description)

examples

public SkriptRegistration.SyntaxRegistrar<C> examples(String... examples)

since

public SkriptRegistration.SyntaxRegistrar<C> since(String since)

setPriority

public SkriptRegistration.SyntaxRegistrar<C> setPriority(int priority)

Sets the priority of the current syntax. Default is 5.

Parameters:

priority - the priority

Returns:

the registrar

addData

public SkriptRegistration.SyntaxRegistrar<C> addData(String identifier,
 Object data)

parsePatterns

protected List<PatternElement> parsePatterns()