better coding practices

Author: sovdeeth

build.gradle

@@ -39,6 +39,12 @@ processResources {
     }
 }
 
+javadoc {
+    source = sourceSets.main.allJava
+    classpath = configurations.compileClasspath
+    options.encoding = 'UTF-8'
+}
+
 task shadowJar(overwrite: true, type: ShadowJar) {
     archiveFileName = 'skript-particle.jar'
 }

gradlew.bat

@@ -17,7 +17,7 @@
 @if "%DEBUG%" == "" @echo off
 @rem ##########################################################################
 @rem
-@rem  Gradle startup script for Windows
+@rem Gradle startup script for Windows
 @rem
 @rem ##########################################################################
 
@@ -80,7 +80,7 @@ if "%ERRORLEVEL%"=="0" goto mainEnd
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
 exit /b 1
 
 :mainEnd

src/main/java/com/sovdee/skriptparticles/elements/expressions/ExprRotation.java

@@ -90,4 +90,4 @@ public String toString(@Nullable Event e, boolean debug) {
         return "rotation around " + axis.toString(e, debug) + " by " + angle.toString(e, debug) + (isRadians ? " radians" : " degrees");
     }
 
-}
+}

src/main/java/com/sovdee/skriptparticles/elements/expressions/ExprShapeCopy.java

@@ -12,7 +12,7 @@
 import ch.njol.util.Kleenean;
 import com.sovdee.skriptparticles.shapes.Shape;
 import org.bukkit.event.Event;
-import org.jetbrains.annotations.NotNull;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
@@ -40,7 +40,7 @@ public boolean init(Expression<?>[] expressions, int i, Kleenean kleenean, Parse
     }
 
     @Override
-    protected Shape[] get(@NotNull Event event) {
+    protected Shape[] get(@NonNull Event event) {
         Shape[] shape = shapeExpr.getArray(event);
 
         if (shape.length == 0)

src/main/java/com/sovdee/skriptparticles/elements/expressions/constructors/ExprArc.java

@@ -118,4 +118,4 @@ public String toString(@Nullable Event event, boolean debug) {
                 (isRadians ? " radians " : " degrees ");
     }
 
-}
+}

src/main/java/com/sovdee/skriptparticles/elements/expressions/constructors/ExprCircle.java

@@ -15,7 +15,7 @@
 import com.sovdee.skriptparticles.shapes.Shape;
 import com.sovdee.skriptparticles.util.MathUtil;
 import org.bukkit.event.Event;
-import org.jetbrains.annotations.NotNull;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.jetbrains.annotations.Nullable;
 
 @Name("Particle Circle or Cylinder")
@@ -42,7 +42,7 @@ public class ExprCircle extends SimpleExpression<Circle> {
     private boolean isCylinder;
 
     @Override
-    public boolean init(Expression<?>[] exprs, int matchedPattern, @NotNull Kleenean isDelayed, @NotNull ParseResult parseResult) {
+    public boolean init(Expression<?>[] exprs, int matchedPattern, @NonNull Kleenean isDelayed, @NonNull ParseResult parseResult) {
         isCylinder = matchedPattern == 1;
 
         radius = (Expression<Number>) exprs[0];
@@ -73,7 +73,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, @NotNull Kleenean
 
     @Override
     @Nullable
-    protected Circle[] get(@NotNull Event event) {
+    protected Circle[] get(@NonNull Event event) {
         Number radius = this.radius.getSingle(event);
         Number height = this.height != null ? this.height.getSingle(event) : 0;
         if (radius == null || height == null)
@@ -93,13 +93,13 @@ public boolean isSingle() {
     }
 
     @Override
-    @NotNull
+    @NonNull
     public Class<? extends Circle> getReturnType() {
         return Circle.class;
     }
 
     @Override
-    @NotNull
+    @NonNull
     public String toString(@Nullable Event event, boolean debug) {
         return (isCylinder ? "circle of radius " + radius.toString(event, debug) :
                 "cylinder of radius " + radius.toString(event, debug) + " and height " + (height != null ? height.toString(event, debug) : "0"));

src/main/java/com/sovdee/skriptparticles/elements/expressions/constructors/ExprEllipsoid.java

@@ -57,7 +57,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
         }
 
         if (yRadius instanceof Literal<Number> literal && literal.getSingle().doubleValue() <= 0) {
-            Skript.error("The y radius of the ellipsoid must be greater than  0. (y radius: " +
+            Skript.error("The y radius of the ellipsoid must be greater than 0. (y radius: " +
                     literal.getSingle().doubleValue() + ")");
             return false;
         }

src/main/java/com/sovdee/skriptparticles/elements/expressions/properties/ExprShapeLocations.java

@@ -13,7 +13,7 @@
 import com.sovdee.skriptparticles.shapes.Shape;
 import org.bukkit.Location;
 import org.bukkit.event.Event;
-import org.jetbrains.annotations.NotNull;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
@@ -50,7 +50,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 
     @Override
     @Nullable
-    protected Location[] get(@NotNull Event event) {
+    protected Location[] get(@NonNull Event event) {
         Shape[] shapes = shapeExpr.getAll(event);
         if (shapes.length == 0) return null;
 
@@ -71,12 +71,12 @@ public boolean isSingle() {
     }
 
     @Override
-    public @NotNull Class<? extends Location> getReturnType() {
+    public @NonNull Class<? extends Location> getReturnType() {
         return Location.class;
     }
 
     @Override
-    public @NotNull String toString(@Nullable Event event, boolean debug) {
+    public @NonNull String toString(@Nullable Event event, boolean debug) {
         return "Locations of shapes";
     }
 

src/main/java/com/sovdee/skriptparticles/elements/expressions/properties/ExprShapeParticleDensity.java

@@ -44,17 +44,17 @@ public class ExprShapeParticleDensity extends SimplePropertyExpression<Shape, Nu
         PropertyExpression.register(ExprShapeParticleDensity.class, Number.class, "particle (:density|:count)", "shapes");
     }
 
-    private boolean flag;
+    private boolean isDensity;
 
     @Override
     public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) {
-        flag = parseResult.hasTag("density");
+        isDensity = parseResult.hasTag("density");
         return super.init(exprs, matchedPattern, isDelayed, parseResult);
     }
 
     @Override
     public @Nullable Number convert(Shape shape) {
-        if (flag)
+        if (isDensity)
             return 1 / shape.getParticleDensity();
         else
             return shape.getParticleCount();
@@ -82,7 +82,7 @@ public void change(Event event, @Nullable Object[] delta, ChangeMode mode) {
                 change = -change;
             case ADD:
                 for (Shape shape : shapes) {
-                    if (flag) {
+                    if (isDensity) {
                         // clamp to 0.001 and 1000, enough to kill the client but not enough to cause an actual error
                         shape.setParticleDensity(MathUtil.clamp(1 / (1 / shape.getParticleDensity() + change), 0.001, 1000));
                     } else
@@ -93,9 +93,9 @@ public void change(Event event, @Nullable Object[] delta, ChangeMode mode) {
             case DELETE:
             case RESET:
             case SET:
-                change = flag ? MathUtil.clamp(change, 0.001, 1000) : Math.max(1, (int) change);
+                change = isDensity ? MathUtil.clamp(change, 0.001, 1000) : Math.max(1, (int) change);
                 for (Shape shape : shapes) {
-                    if (flag) {
+                    if (isDensity) {
                         shape.setParticleDensity(change);
                     } else {
                         shape.setParticleCount((int) change);
@@ -115,7 +115,7 @@ public Class<? extends Number> getReturnType() {
 
     @Override
     protected String getPropertyName() {
-        return "particle " + (flag ? "density" : "count");
+        return "particle " + (isDensity ? "density" : "count");
     }
 
 }

src/main/java/com/sovdee/skriptparticles/elements/sections/EffSecDrawShape.java

@@ -28,7 +28,7 @@
 import org.bukkit.event.HandlerList;
 import org.bukkit.scheduler.BukkitRunnable;
 import org.bukkit.util.Consumer;
-import org.jetbrains.annotations.NotNull;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
@@ -228,7 +228,7 @@ private void executeSync(Event event, Collection<DynamicLocation> locations, Con
                     shapeCopy = shape.clone();
                     shapeCopy.draw(location, consumer, recipients);
                 } else {
-                    shape.draw(location, null, null, recipients);
+                    shape.draw(location, recipients);
                 }
             }
         }
@@ -239,13 +239,13 @@ private void executeAsync(Collection<DynamicLocation> locations, Collection<Shap
         for (DynamicLocation dynamicLocation : locations) {
             location = dynamicLocation.getLocation();
             for (Shape shape : shapes) {
-                shape.draw(location, null, null, recipients);
+                shape.draw(location, recipients);
             }
         }
     }
 
     @Override
-    @NotNull
+    @NonNull
     public String toString(@Nullable Event event, boolean b) {
         return "draw shape " + shapes.toString(event, b) + " at " + locations.toString(event, b) + " for " + (players == null ? "all players" : players.toString(event, b));
     }
@@ -262,7 +262,7 @@ public Shape getShape() {
         }
 
         @Override
-        @NotNull
+        @NonNull
         public HandlerList getHandlers() {
             throw new IllegalStateException();
         }