Deprecate usages of java.awt.Color for removal.

We have quite a lot of deprecations lately, but times change, so things will get deprecated.
This is how life works and deprecations are vital for a healthy API.

Author: Geolykt

src/main/java/de/geolykt/starloader/api/empire/Alliance.java

@@ -1,10 +1,11 @@
 package de.geolykt.starloader.api.empire;
 
-import java.awt.Color;
 import java.util.ArrayList;
 
 import org.jetbrains.annotations.NotNull;
 
+import com.badlogic.gdx.graphics.Color;
+
 import snoddasmannen.galimulator.GalColor;
 
 public interface Alliance extends Dateable {
@@ -31,9 +32,18 @@ public interface Alliance extends Dateable {
      * This method can be preferable over {@link #getColor()} as latter is only present within Galimulator proper
      * while this component is provided by most Java SE implementations starloader will run on.
      *
-     * @return The {@link Color} of the alliance
+     * @return The {@link java.awt.Color} of the alliance
+     * @deprecated java.awt.Color getters and setters are scheduled for purging in a future version
+     */
+    @Deprecated(forRemoval = true, since = "1.5.0")
+    public @NotNull java.awt.Color getAWTColor();
+
+    /**
+     * Obtains the Color of the Alliance used for UI.
+     *
+     * @return The {@link GalColor} of the alliance
      */
-    public @NotNull Color getAWTColor();
+    public @NotNull Color getGDXColor();
 
     /**
      * Obtains the Color of the Alliance used for UI.

src/main/java/de/geolykt/starloader/api/empire/Empire.java

@@ -1,9 +1,9 @@
 package de.geolykt.starloader.api.empire;
 
-import java.awt.Color;
-
 import org.jetbrains.annotations.NotNull;
 
+import com.badlogic.gdx.graphics.Color;
+
 import de.geolykt.starloader.api.Galimulator;
 import de.geolykt.starloader.api.Identifiable;
 
@@ -26,15 +26,27 @@ public default int getAge() {
     }
 
     /**
-     * The galimulator color is used for multiple interfaces as well as to paint the
+     * The empire color is used for multiple interfaces as well as to paint the
      * territory of an empire to a constant color, the color as such should not
      * change without reason to not confuse the user.
      * This method can be preferable over {@link #getColor()} as latter is only present within Galimulator proper
      * while this component is provided by the JVM
      *
-     * @return The AWT {@link Color} assigned to the empire
+     * @return The AWT {@link java.awt.Color} assigned to the empire
+     * @deprecated java.awt.Color getters and setters are scheduled for purging in a future version
+     */
+    @Deprecated(forRemoval = true, since = "1.5.0")
+    public @NotNull java.awt.Color getAWTColor();
+
+    /**
+     * The empire color is used for multiple interfaces as well as to paint the
+     * territory of an empire to a constant color, the color as such should not
+     * change without reason to not confuse the user.
+     *
+     * @return The GDX {@link Color} assigned to the empire
      */
-    public @NotNull Color getAWTColor();
+    @NotNull
+    public Color getGDXColor();
 
     /**
      * The year the empire collapsed, or -1 if the empire did not collapse.
@@ -44,7 +56,7 @@ public default int getAge() {
     public int getCollapseYear();
 
     /**
-     * The galimulator color is used for multiple interfaces as well as to paint the
+     * The empire color is used for multiple interfaces as well as to paint the
      * territory of an empire to a constant color, the color as such should not
      * change without reason to not confuse the user.
      *

src/main/java/de/geolykt/starloader/api/gui/FlagComponent.java

@@ -19,8 +19,10 @@ public interface FlagComponent {
      * of this class. However this is cached once per instance of the underlying Galimulator-specific color object.
      *
      * @return The color that should be used to render the {@link FlagSymbol}. Converted to the AWT Color object.
+     * @deprecated java.awt.Color getters and setters are scheduled for purging in a future version
      */
     @NotNull
+    @Deprecated(forRemoval = true, since = "1.5.0")
     public java.awt.Color getAWTColor();
 
     /**

src/main/java/de/geolykt/starloader/api/gui/graph/LineChart.java

@@ -132,13 +132,11 @@ protected float getLineThickness() {
         return 2.0F;
     }
 
-    protected @NotNull Color getColor(Object o) {
+    protected @NotNull Color getColor(@NotNull Object o) {
         if (o instanceof Empire) {
-            java.awt.Color awtColor = ((Empire) o).getAWTColor();
-            return new Color(awtColor.getRed() / 255.0F, awtColor.getGreen() / 255.0F, awtColor.getBlue() / 255.0F, awtColor.getAlpha() / 255.0F);
+            return ((Empire) o).getGDXColor();
         } else if (o instanceof Alliance) {
-            java.awt.Color awtColor = ((Alliance) o).getAWTColor();
-            return new Color(awtColor.getRed() / 255.0F, awtColor.getGreen() / 255.0F, awtColor.getBlue() / 255.0F, awtColor.getAlpha() / 255.0F);
+            return ((Alliance) o).getGDXColor();
         } else {
             Color c = new Color(o.hashCode());
             c.a = 1.0F;

src/main/java/de/geolykt/starloader/api/gui/screen/ScreenBuilder.java

@@ -113,7 +113,10 @@ public void addComponentProvider(@NotNull ComponentProvider provider) {
      * All RGBA channels will be used and the default value is an Orange-ish color.
      *
      * @param awtColor The color to use as an Java AWT Color. It will get transformed into Galimulator's internal Color type later on.
+     *
+     * @deprecated java.awt.Color getters and setters are scheduled for purging in a future version
      */
+    @Deprecated(forRemoval = true, since = "1.5.0")
     public abstract void setHeaderColor(@NotNull Color awtColor);
 
     /**

src/main/java/de/geolykt/starloader/apimixins/AllianceMixins.java

@@ -16,7 +16,6 @@
 import de.geolykt.starloader.api.event.EventManager;
 import de.geolykt.starloader.api.event.alliance.AllianceJoinEvent;
 import de.geolykt.starloader.api.event.alliance.AllianceLeaveEvent;
-import de.geolykt.starloader.impl.AWTColorAccesor;
 
 import snoddasmannen.galimulator.GalColor;
 
@@ -73,8 +72,9 @@ public boolean c(snoddasmannen.galimulator.Empire var1) { // hasMember
     }
 
     @Override
+    @Deprecated(forRemoval = true, since = "1.5.0")
     public @NotNull Color getAWTColor() {
-        return ((AWTColorAccesor) getColor()).asAWTColor();
+        return ((de.geolykt.starloader.impl.AWTColorAccesor) getColor()).asAWTColor();
     }
 
     @Override
@@ -93,6 +93,12 @@ public int getFoundationYear() {
         return nameIdentifier;
     }
 
+    @SuppressWarnings("null")
+    @Override
+    public com.badlogic.gdx.graphics.@NotNull Color getGDXColor() {
+        return c().getGDXColor();
+    }
+
     @SuppressWarnings({ "unchecked", "null" })
     @Override
     @NotNull

src/main/java/de/geolykt/starloader/apimixins/EmpireAnnalsMixins.java

@@ -9,7 +9,6 @@
 import de.geolykt.starloader.api.Galimulator;
 import de.geolykt.starloader.api.empire.ActiveEmpire;
 import de.geolykt.starloader.api.empire.Empire;
-import de.geolykt.starloader.impl.AWTColorAccesor;
 
 import snoddasmannen.galimulator.GalColor;
 
@@ -35,8 +34,9 @@ public class EmpireAnnalsMixins implements Empire {
     public String nameIdentifier;
 
     @Override
+    @Deprecated(forRemoval = true, since = "1.5.0")
     public @NotNull Color getAWTColor() {
-        return ((AWTColorAccesor) getColor()).asAWTColor();
+        return ((de.geolykt.starloader.impl.AWTColorAccesor) getColor()).asAWTColor();
     }
 
     @Override
@@ -61,6 +61,12 @@ public int getFoundationYear() {
         return birthYear;
     }
 
+    @SuppressWarnings("null")
+    @Override
+    public com.badlogic.gdx.graphics.@NotNull Color getGDXColor() {
+        return getColor().getGDXColor();
+    }
+
     @Override
     public int getStarCount() {
         if (deathYear != -1) {

src/main/java/de/geolykt/starloader/apimixins/EmpireMixins.java

@@ -52,7 +52,6 @@
 import de.geolykt.starloader.api.registry.Registry;
 import de.geolykt.starloader.api.registry.RegistryKeyed;
 import de.geolykt.starloader.api.registry.RegistryKeys;
-import de.geolykt.starloader.impl.AWTColorAccesor;
 
 import snoddasmannen.galimulator.EmpireAchievement.EmpireAchievementType;
 import snoddasmannen.galimulator.EmpireSpecial;
@@ -408,8 +407,9 @@ public Alliance getAlliance() {
     }
 
     @Override
+    @Deprecated(forRemoval = true, since = "1.5.0")
     public @NotNull Color getAWTColor() {
-        return ((AWTColorAccesor) getColor()).asAWTColor();
+        return ((de.geolykt.starloader.impl.AWTColorAccesor) getColor()).asAWTColor();
     }
 
     @Override
@@ -476,6 +476,12 @@ public int getFoundationYear() {
         return birthMilliYear;
     }
 
+    @SuppressWarnings("null")
+    @Override
+    public com.badlogic.gdx.graphics.@NotNull Color getGDXColor() {
+        return getColor().getGDXColor();
+    }
+
     @SuppressWarnings("null")
     @Override
     public @NotNull Random getInternalRandom() {

src/main/java/de/geolykt/starloader/apimixins/FlagItemMixins.java

@@ -8,7 +8,6 @@
 
 import de.geolykt.starloader.api.gui.FlagComponent;
 import de.geolykt.starloader.api.gui.FlagSymbol;
-import de.geolykt.starloader.impl.AWTColorAccesor;
 
 import snoddasmannen.galimulator.FlagItem;
 import snoddasmannen.galimulator.FlagItem.BuiltinSymbols;
@@ -46,8 +45,9 @@ public class FlagItemMixins implements FlagComponent {
 
     @Override
     @NotNull
+    @Deprecated(forRemoval = true, since = "1.5.0")
     public Color getAWTColor() {
-        return ((AWTColorAccesor) color).asAWTColor();
+        return ((de.geolykt.starloader.impl.AWTColorAccesor) color).asAWTColor();
     }
 
     @SuppressWarnings("null")

src/main/java/de/geolykt/starloader/apimixins/GalColorMixins.java

@@ -6,12 +6,16 @@
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.Shadow;
 
-import de.geolykt.starloader.impl.AWTColorAccesor;
-
 import snoddasmannen.galimulator.GalColor;
 
+/**
+ * Mixin that implements the AWTColorAccessor on to the GalColor class.
+ *
+ * @deprecated The AWTColorAccess class is deprecated for removal and there is no other reason for this class to exist.
+ */
+@Deprecated(forRemoval = true, since = "1.5.0")
 @Mixin(GalColor.class)
-public class GalColorMixins implements AWTColorAccesor {
+public class GalColorMixins implements de.geolykt.starloader.impl.AWTColorAccesor {
 
     @Shadow
     public float a;