CardFaceView: make better Serializable (Card-Forge#9405)

Author: Hanmac

forge-core/src/main/java/forge/card/ICardCharacteristics.java

@@ -1,11 +1,11 @@
 package forge.card;
 
 import forge.card.mana.ManaCost;
+import forge.util.IHasName;
 
 import java.util.Set;
 
-public interface ICardCharacteristics {
-    String   getName();
+public interface ICardCharacteristics extends IHasName {
     CardType getType();
     ManaCost getManaCost();
     ColorSet getColor();

forge-game/src/main/java/forge/game/ability/effects/VentureEffect.java

@@ -3,6 +3,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.TreeMap;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
@@ -57,7 +58,7 @@ private Card getDungeonCard(SpellAbility sa, Player player, Map<AbilityKey, Obje
             filter = e -> e.getValue().isEnterableDungeon();
         }
         Map<ICardFace, String> mapping = StaticData.instance().getAllTokens().getRules().entrySet()
-                .stream().filter(filter).collect(Collectors.toMap(e -> e.getValue().getMainPart(), Map.Entry::getKey));
+                .stream().filter(filter).collect(Collectors.toMap(e -> e.getValue().getMainPart(), Map.Entry::getKey, (a,b) -> a, TreeMap::new));
         String message = Localizer.getInstance().getMessage("lblChooseDungeon");
         ICardFace chosen = player.getController().chooseSingleCardFace(sa, Lists.newArrayList(mapping.keySet()), message);
         if (chosen == null) {

forge-game/src/main/java/forge/game/card/CardFaceView.java

@@ -2,41 +2,37 @@
 
 import java.io.Serializable;
 
-public class CardFaceView implements Serializable, Comparable<CardFaceView> {
-    /**
-     *
-     */
-    private static final long serialVersionUID = 1874016432028306386L;
-    private String displayName;
-    private String oracleName;
+import forge.card.ICardFace;
+import forge.util.CardTranslation;
+import forge.util.ITranslatable;
 
-    public CardFaceView(String displayName) {
-        this(displayName, displayName);
-    }
+public record CardFaceView(String name, String displayName) implements Serializable, ITranslatable, Comparable<CardFaceView> {
+    private static final long serialVersionUID = 1874016432028306386L;
 
-    public CardFaceView(String displayFaceName, String oracleFaceName ) {
-        this.displayName = displayFaceName;
-        this.oracleName = oracleFaceName;
+    public CardFaceView(ICardFace face) {
+        this(face.getName(), face.getDisplayName());
     }
 
-    public String getName() { return displayName;}
-
-    public void setName(String name) {
-        this.displayName = name;
+    @Override
+    public String getName() {
+        return this.name;
     }
-
-    public String getOracleName() { return oracleName; }
-
-    public void setOracleName(String name) {
-        this.oracleName = name;
+    @Override
+    public String getTranslatedName() {
+        return CardTranslation.getTranslatedName(this.displayName);
     }
-
+    @Override
     public String toString() {
-        return displayName;
+        return name;
     }
 
     @Override
     public int compareTo(CardFaceView o) {
-        return this.getOracleName().compareTo(o.getOracleName());
+        return this.getName().compareTo(o.getName());
+    }
+
+    @Override
+    public int hashCode() {
+        return this.name.hashCode();
     }
 }

forge-gui-desktop/src/main/java/forge/gui/GuiChoose.java

@@ -25,6 +25,7 @@
 import forge.screens.match.CMatchUI;
 import forge.toolbox.FOptionPane;
 import forge.util.FSerializableFunction;
+import forge.util.IHasName;
 import forge.util.Localizer;
 import forge.view.arcane.ListCardArea;
 
@@ -155,12 +156,7 @@ public static <T> List<T> getChoices(final String message, final int min, final
                         matchUI.setCard((InventoryItem) list.getSelectedValue());
                         return;
                     } else if (sel instanceof ICardFace || sel instanceof CardFaceView) {
-                        String faceName;
-                        if (sel instanceof ICardFace) {
-                            faceName = ((ICardFace) sel).getName();
-                        } else {
-                            faceName = ((CardFaceView) sel).getOracleName();
-                        }
+                        String faceName = ((IHasName)sel).getName();
                         PaperCard paper = FModel.getMagicDb().getCommonCards().getUniqueByName(faceName);
                         if (paper == null) {
                             paper = FModel.getMagicDb().getVariantCards().getUniqueByName(faceName);

forge-gui/src/main/java/forge/player/PlayerControllerHuman.java

@@ -77,6 +77,7 @@
 import java.io.*;
 import java.util.*;
 import java.util.Map.Entry;
+import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
@@ -1865,16 +1866,18 @@ public ICardFace chooseSingleCardFace(final SpellAbility sa, final String messag
                                           final String name) {
         List<CardFaceView> choices = FModel.getMagicDb().getCommonCards().streamAllFaces()
                 .filter(cpp)
-                .map(cardFace -> new CardFaceView(CardTranslation.getTranslatedName(cardFace.getDisplayName()), cardFace.getName()))
+                .map(CardFaceView::new)
                 .sorted()
                 .collect(Collectors.toList());
         CardFaceView cardFaceView = getGui().one(message, choices);
-        return StaticData.instance().getCommonCards().getFaceByName(cardFaceView.getOracleName());
+        return StaticData.instance().getCommonCards().getFaceByName(cardFaceView.getName());
     }
 
     @Override
     public ICardFace chooseSingleCardFace(SpellAbility sa, List<ICardFace> faces, String message) {
-        return getGui().one(message, faces);
+        Map<CardFaceView, ICardFace> mapped = faces.stream().collect(Collectors.toMap(CardFaceView::new, Function.identity(), (a, b) -> a, TreeMap::new));
+        CardFaceView chosen = getGui().one(message, Lists.newArrayList(mapped.keySet()));
+        return mapped.get(chosen);
     }
 
     @Override
@@ -2931,7 +2934,7 @@ private void addCardToZone(ZoneType zone, final boolean repeatLast, final boolea
                 return;
             }
 
-            PaperCard c = carddb.getUniqueByName(f.getOracleName());
+            PaperCard c = carddb.getUniqueByName(f.getName());
             final Card forgeCard = Card.fromPaperCard(c, p);
             forgeCard.setGameTimestamp(getGame().getNextTimestamp());