Stabilize Registration API (SkriptLang#8316)

Author: APickledWalrus

src/main/java/ch/njol/skript/Skript.java

@@ -6,21 +6,22 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.bukkit.Bukkit;
-import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.jetbrains.annotations.Nullable;
 
 import ch.njol.skript.util.Utils;
 import ch.njol.skript.util.Version;
-import org.jetbrains.annotations.ApiStatus;
 import org.skriptlang.skript.localization.Localizer;
 import org.skriptlang.skript.registration.SyntaxRegistry;
 import org.skriptlang.skript.util.Registry;
 
 /**
  * Utility class for Skript addons. Use {@link Skript#registerAddon(JavaPlugin)} to create a SkriptAddon instance for your plugin.
+ * @deprecated Use {@link org.skriptlang.skript.addon.SkriptAddon} instead.
+ * Register using {@link org.skriptlang.skript.Skript#registerAddon(Class, String)}.
+ * Obtain a Skript instance with {@link Skript#instance()}.
  */
+@Deprecated(since = "INSERT VERSION", forRemoval = true)
 public final class SkriptAddon implements org.skriptlang.skript.addon.SkriptAddon {
 
 	public final JavaPlugin plugin;
@@ -114,61 +115,51 @@ public File getFile() {
 	// Modern SkriptAddon Compatibility
 	//
 
-	@ApiStatus.Experimental
 	static SkriptAddon fromModern(org.skriptlang.skript.addon.SkriptAddon addon) {
 		return new SkriptAddon(JavaPlugin.getProvidingPlugin(addon.source()), addon);
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public Class<?> source() {
 		return addon.source();
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public String name() {
 		return addon.name();
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public <R extends Registry<?>> void storeRegistry(Class<R> registryClass, R registry) {
 		addon.storeRegistry(registryClass, registry);
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public void removeRegistry(Class<? extends Registry<?>> registryClass) {
 		addon.removeRegistry(registryClass);
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public boolean hasRegistry(Class<? extends Registry<?>> registryClass) {
 		return addon.hasRegistry(registryClass);
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public <R extends Registry<?>> R registry(Class<R> registryClass) {
 		return addon.registry(registryClass);
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public <R extends Registry<?>> R registry(Class<R> registryClass, Supplier<R> putIfAbsent) {
 		return addon.registry(registryClass, putIfAbsent);
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public SyntaxRegistry syntaxRegistry() {
 		return addon.syntaxRegistry();
 	}
 
 	@Override
-	@ApiStatus.Experimental
 	public Localizer localizer() {
 		return addon.localizer();
 	}

src/main/java/ch/njol/skript/SkriptAddon.java

@@ -29,7 +29,9 @@
 import org.bukkit.command.CommandSender;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.PluginDescriptionFile;
+import org.bukkit.plugin.java.JavaPlugin;
 import org.jetbrains.annotations.Nullable;
+import org.skriptlang.skript.addon.SkriptAddon;
 import org.skriptlang.skript.lang.script.Script;
 
 import java.io.File;
@@ -356,10 +358,11 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
 					info(sender, "info.version", Skript.getVersion());
 				}
 
-				Collection<SkriptAddon> addons = Skript.getAddons();
+				Collection<SkriptAddon> addons = Skript.instance().addons();
 				info(sender, "info.addons", addons.isEmpty() ? "None" : "");
 				for (SkriptAddon addon : addons) {
-					PluginDescriptionFile desc = addon.plugin.getDescription();
+					JavaPlugin plugin = JavaPlugin.getProvidingPlugin(addon.source());
+					PluginDescriptionFile desc = plugin.getDescription();
 					String web = desc.getWebsite();
 					Skript.info(sender, " - " + desc.getFullName() + (web != null ? " (" + web + ")" : ""));
 				}

src/main/java/ch/njol/skript/SkriptCommand.java

@@ -7,11 +7,9 @@
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.util.Kleenean;
 import org.bukkit.event.Event;
-import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.skriptlang.skript.registration.SyntaxInfo;
-import org.skriptlang.skript.registration.SyntaxRegistry;
 import org.skriptlang.skript.util.Priority;
 
 import java.util.function.Predicate;
@@ -46,7 +44,6 @@ public abstract class PropertyCondition<T> extends Condition implements Predicat
 	 * They will be registered before {@link SyntaxInfo#PATTERN_MATCHES_EVERYTHING} expressions
 	 *  but after {@link SyntaxInfo#COMBINED} expressions.
 	 */
-	@ApiStatus.Experimental
 	public static final Priority DEFAULT_PRIORITY = Priority.before(SyntaxInfo.PATTERN_MATCHES_EVERYTHING);
 
 	/**
@@ -78,43 +75,6 @@ public enum PropertyType {
 		WILL
 	}
 
-	/**
-	 * @param registry The SyntaxRegistry to register with.
-	 * @param condition The class to register
-	 * @param property The property name, for example <i>fly</i> in <i>players can fly</i>
-	 * @param type Must be plural, for example <i>players</i> in <i>players can fly</i>
-	 * @param <E> The Condition type.
-	 * @return The registered {@link SyntaxInfo}.
-	 * @deprecated Use {@link #infoBuilder(Class, PropertyType, String, String)} to build a {@link SyntaxInfo}
-	 *  and then register it using {@code registry} ({@link SyntaxRegistry#register(SyntaxRegistry.Key, SyntaxInfo)}).
-	 */
-	@ApiStatus.Experimental
-	@Deprecated(since = "2.12", forRemoval = true)
-	public static <E extends Condition> SyntaxInfo<E> register(SyntaxRegistry registry, Class<E> condition, String property, String type) {
-		return register(registry, condition, PropertyType.BE, property, type);
-	}
-
-	/**
-	 * @param registry The SyntaxRegistry to register with.
-	 * @param condition The class to register
-	 * @param propertyType The property type, see {@link PropertyType}
-	 * @param property The property name, for example <i>fly</i> in <i>players can fly</i>
-	 * @param type Must be plural, for example <i>players</i> in <i>players can fly</i>
-	 * @param <E> The Condition type.
-	 * @return The registered {@link SyntaxInfo}.
-	 * @deprecated Use {@link #infoBuilder(Class, PropertyType, String, String)} to build a {@link SyntaxInfo}
-	 *  and then register it using {@code registry} ({@link SyntaxRegistry#register(SyntaxRegistry.Key, SyntaxInfo)}).
-	 */
-	@ApiStatus.Experimental
-	@Deprecated(since = "2.12", forRemoval = true)
-	public static <E extends Condition> SyntaxInfo<E> register(SyntaxRegistry registry, Class<E> condition, PropertyType propertyType, String property, String type) {
-		if (type.contains("%"))
-			throw new SkriptAPIException("The type argument must not contain any '%'s");
-		SyntaxInfo<E> info = infoBuilder(condition, propertyType, property, type).build();
-		registry.register(SyntaxRegistry.CONDITION, info);
-		return info;
-	}
-
 	/**
 	 * Creates a builder for a {@link SyntaxInfo} representing a {@link PropertyCondition}.
 	 * Patterns will be appended based on the {@code propertyType} (see {@link #getPatterns(PropertyType, String, String)}).
@@ -127,7 +87,6 @@ public static <E extends Condition> SyntaxInfo<E> register(SyntaxRegistry regist
 	 * @param <E> The Condition type.
 	 * @return A {@link SyntaxInfo} representing the property conditon.
 	 */
-	@ApiStatus.Experimental
 	public static <E extends Condition> SyntaxInfo.Builder<? extends SyntaxInfo.Builder<?, E>, E> infoBuilder(
 			Class<E> condition, PropertyType propertyType, String property, String type) {
 		if (type.contains("%"))
@@ -143,7 +102,10 @@ public static <E extends Condition> SyntaxInfo.Builder<? extends SyntaxInfo.Buil
 	 * @param condition the class to register
 	 * @param property the property name, for example <i>fly</i> in <i>players can fly</i>
 	 * @param type must be plural, for example <i>players</i> in <i>players can fly</i>
+	 * @deprecated Register the standard way using {@link #infoBuilder(Class, PropertyType, String, String)}
+	 *  to create a {@link SyntaxInfo}.
 	 */
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
 	public static void register(Class<? extends Condition> condition, String property, String type) {
 		register(condition, PropertyType.BE, property, type);
 	}
@@ -155,7 +117,10 @@ public static void register(Class<? extends Condition> condition, String propert
 	 * @param propertyType the property type, see {@link PropertyType}
 	 * @param property the property name, for example <i>fly</i> in <i>players can fly</i>
 	 * @param type must be plural, for example <i>players</i> in <i>players can fly</i>
+	 * @deprecated Register the standard way using {@link #infoBuilder(Class, PropertyType, String, String)}
+	 *  to create a {@link SyntaxInfo}.
 	 */
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
 	public static void register(Class<? extends Condition> condition, PropertyType propertyType, String property, String type) {
 		Skript.registerCondition(condition, ConditionType.PROPERTY,
 				getPatterns(propertyType, property, type));
@@ -167,7 +132,7 @@ public static void register(Class<? extends Condition> condition, PropertyType p
 	 * @param propertyType the property type, see {@link PropertyType}
 	 * @param property the property name, for example <i>fly</i> in <i>players can fly</i>
 	 * @param type must be plural, for example <i>players</i> in <i>players can fly</i>
-	 * @return patterns formmated for {@link Skript#registerCondition(Class, String...)}
+	 * @return Patterns formatted for syntax registration.
 	 */
 	public static String[] getPatterns(PropertyType propertyType, String property, String type) {
 		if (type.contains("%"))

src/main/java/ch/njol/skript/conditions/base/PropertyCondition.java

@@ -25,7 +25,6 @@
 import org.jetbrains.annotations.Nullable;
 import org.skriptlang.skript.lang.experiment.Experiment;
 import org.skriptlang.skript.addon.SkriptAddon;
-import org.skriptlang.skript.bukkit.registration.BukkitRegistryKeys;
 import org.skriptlang.skript.bukkit.registration.BukkitSyntaxInfos;
 import org.skriptlang.skript.lang.properties.Property;
 import org.skriptlang.skript.lang.properties.PropertyRegistry;
@@ -659,7 +658,7 @@ public void generate(@NotNull Path path) throws IOException {
 		jsonDocs.add("conditions", generateSyntaxElementArray(source.syntaxRegistry().syntaxes(SyntaxRegistry.CONDITION)));
 		jsonDocs.add("effects", generateSyntaxElementArray(source.syntaxRegistry().syntaxes(SyntaxRegistry.EFFECT)));
 		jsonDocs.add("expressions", generateSyntaxElementArray(source.syntaxRegistry().syntaxes(SyntaxRegistry.EXPRESSION)));
-		jsonDocs.add("events", generateStructureElementArray(source.syntaxRegistry().syntaxes(BukkitRegistryKeys.EVENT)));
+		jsonDocs.add("events", generateStructureElementArray(source.syntaxRegistry().syntaxes(BukkitSyntaxInfos.Event.KEY)));
 		jsonDocs.add("structures", generateStructureElementArray(source.syntaxRegistry().syntaxes(SyntaxRegistry.STRUCTURE)));
 		jsonDocs.add("sections", generateSyntaxElementArray(source.syntaxRegistry().syntaxes(SyntaxRegistry.SECTION)));
 		jsonDocs.add("types", generateClassInfoArray(Classes.getClassInfos().iterator()));

src/main/java/ch/njol/skript/doc/JSONGenerator.java

@@ -61,58 +61,8 @@ public class EventValueExpression<T> extends SimpleExpression<T> implements Defa
 	 * They will be registered before {@link SyntaxInfo#COMBINED} expressions
 	 *  but after {@link SyntaxInfo#SIMPLE} expressions.
 	 */
-	@ApiStatus.Experimental
 	public static final Priority DEFAULT_PRIORITY = Priority.before(SyntaxInfo.COMBINED);
 
-	/**
-	 * Registers an event value expression with the provided pattern.
-	 * The syntax info will be forced to use the {@link #DEFAULT_PRIORITY} priority.
-	 * This also adds '[the]' to the start of the pattern.
-	 *
-	 * @param registry The SyntaxRegistry to register with.
-	 * @param expressionClass The EventValueExpression class being registered.
-	 * @param returnType The class representing the expression's return type.
-	 * @param pattern The pattern to match for creating this expression.
-	 * @param <T> The return type.
-	 * @param <E> The Expression type.
-	 * @return The registered {@link SyntaxInfo}.
-	 * @deprecated Use {@link #infoBuilder(Class, Class, String...)} to build a {@link SyntaxInfo}
-	 *  and then register it using {@code registry} ({@link SyntaxRegistry#register(SyntaxRegistry.Key, SyntaxInfo)}).
-	 */
-	@ApiStatus.Experimental
-	@Deprecated(since = "2.12", forRemoval = true)
-	public static <E extends EventValueExpression<T>, T> SyntaxInfo.Expression<E, T> register(SyntaxRegistry registry, Class<E> expressionClass, Class<T> returnType, String pattern) {
-		return register(registry, expressionClass, returnType, new String[]{pattern});
-	}
-
-	/**
-	 * Registers an event value expression with the provided patterns.
-	 * The syntax info will be forced to use the {@link #DEFAULT_PRIORITY} priority.
-	 * This also adds '[the]' to the start of the patterns.
-	 *
-	 * @param registry The SyntaxRegistry to register with.
-	 * @param expressionClass The EventValueExpression class being registered.
-	 * @param returnType The class representing the expression's return type.
-	 * @param patterns The patterns to match for creating this expression.
-	 * @param <T> The return type.
-	 * @param <E> The Expression type.
-	 * @return The registered {@link SyntaxInfo}.
-	 * @deprecated Use {@link #infoBuilder(Class, Class, String...)} to build a {@link SyntaxInfo}
-	 *  and then register it using {@code registry} ({@link SyntaxRegistry#register(SyntaxRegistry.Key, SyntaxInfo)}).
-	 */
-	@ApiStatus.Experimental
-	@Deprecated(since = "2.12", forRemoval = true)
-	public static <E extends EventValueExpression<T>, T> DefaultSyntaxInfos.Expression<E, T> register(
-		SyntaxRegistry registry,
-		Class<E> expressionClass,
-		Class<T> returnType,
-		String ... patterns
-	) {
-		SyntaxInfo.Expression<E, T> info = infoBuilder(expressionClass, returnType, patterns).build();
-		registry.register(SyntaxRegistry.EXPRESSION, info);
-		return info;
-	}
-
 	/**
 	 * Creates a builder for a {@link SyntaxInfo} representing a {@link EventValueExpression} with the provided patterns.
 	 * The info will use {@link #DEFAULT_PRIORITY} as its {@link SyntaxInfo#priority()}.
@@ -124,7 +74,6 @@ public static <E extends EventValueExpression<T>, T> DefaultSyntaxInfos.Expressi
 	 * @param <E> The Expression type.
 	 * @return The registered {@link SyntaxInfo}.
 	 */
-	@ApiStatus.Experimental
 	public static <E extends EventValueExpression<T>, T> SyntaxInfo.Expression.Builder<? extends SyntaxInfo.Expression.Builder<?, E, T>, E, T> infoBuilder(
 			Class<E> expressionClass, Class<T> returnType, String... patterns) {
 		for (int i = 0; i < patterns.length; i++) {
@@ -142,7 +91,10 @@ public static <E extends EventValueExpression<T>, T> SyntaxInfo.Expression.Build
 	 * @param expression The class that represents this EventValueExpression.
 	 * @param type The return type of the expression.
 	 * @param pattern The pattern for this syntax.
+	 * @deprecated Register the standard way using {@link #infoBuilder(Class, Class, String...)}
+	 *  to create a {@link SyntaxInfo}.
 	 */
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
 	public static <T> void register(Class<? extends EventValueExpression<T>> expression, Class<T> type, String pattern) {
 		Skript.registerExpression(expression, type, ExpressionType.EVENT, "[the] " + pattern);
 	}
@@ -154,7 +106,10 @@ public static <T> void register(Class<? extends EventValueExpression<T>> express
 	 * @param expression The class that represents this EventValueExpression.
 	 * @param type The return type of the expression.
 	 * @param patterns The patterns for this syntax.
+	 * @deprecated Register the standard way using {@link #infoBuilder(Class, Class, String...)}
+	 *  to create a {@link SyntaxInfo}.
 	 */
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
 	public static <T> void register(Class<? extends EventValueExpression<T>> expression, Class<T> type, String ... patterns) {
 		for (int i = 0; i < patterns.length; i++) {
 			if (!StringUtils.startsWithIgnoreCase(patterns[i], "[the] "))

src/main/java/ch/njol/skript/expressions/base/EventValueExpression.java

@@ -7,7 +7,6 @@
 import ch.njol.skript.lang.util.SimpleExpression;
 import ch.njol.util.Kleenean;
 import org.bukkit.event.Event;
-import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.skriptlang.skript.lang.condition.Conditional;
@@ -20,41 +19,45 @@
 
 /**
  * A condition which must be fulfilled for the trigger to continue. If the condition is in a section the behaviour depends on the section.
- *
- * @see Skript#registerCondition(Class, String...)
  */
 public abstract class Condition extends Statement implements Conditional<Event>, SyntaxRuntimeErrorProducer, Simplifiable<Condition> {
 
+	/**
+	 * @deprecated This has been replaced by {@link Priority}.
+	 * See the documentation of each element to determine their replacements.
+	 */
+	@Deprecated(since = "INSERT VERSION", forRemoval = true)
 	public enum ConditionType {
+
 		/**
 		 * Conditions that contain other expressions, e.g. "%properties% is/are within %expressions%"
 		 * 
 		 * @see #PROPERTY
+		 * @deprecated Use {@link SyntaxInfo#COMBINED}.
 		 */
 		COMBINED(SyntaxInfo.COMBINED),
 
 		/**
 		 * Property conditions, e.g. "%properties% is/are data value[s]"
+		 * @deprecated Use {@link PropertyCondition#DEFAULT_PRIORITY}.
 		 */
 		PROPERTY(PropertyCondition.DEFAULT_PRIORITY),
 
 		/**
 		 * Conditions whose pattern matches (almost) everything or should be last checked.
+		 * @deprecated Use {@link SyntaxInfo#PATTERN_MATCHES_EVERYTHING}.
 		 */
 		PATTERN_MATCHES_EVERYTHING(SyntaxInfo.PATTERN_MATCHES_EVERYTHING);
 
-		@ApiStatus.Experimental
 		private final Priority priority;
 
-		@ApiStatus.Experimental
 		ConditionType(Priority priority) {
 			this.priority = priority;
 		}
 
 		/**
 		 * @return The Priority equivalent of this ConditionType.
 		 */
-		@ApiStatus.Experimental
 		public Priority priority() {
 			return this.priority;
 		}

src/main/java/ch/njol/skript/lang/Condition.java

@@ -6,7 +6,9 @@
 
 /**
  * Represents an expression's information, for use when creating new instances of expressions.
+ * @deprecated Use {@link SyntaxInfo.Expression} ({@link SyntaxInfo.Expression#builder(Class, Class)}) instead.
  */
+@Deprecated(since = "INSERT VERSION", forRemoval = true)
 public class ExpressionInfo<E extends Expression<T>, T> extends SyntaxElementInfo<E> {
 
 	public @Nullable ExpressionType expressionType;