refactor(framework): make ScoreDefinition immutable

Author: xeruf

plugin/src/server/sc/plugin2020/GamePlugin.java

@@ -18,15 +18,11 @@ public class GamePlugin implements IGamePlugin {
   public static final String PLUGIN_AUTHOR = "";
   public static final String PLUGIN_UUID = "swc_2020_hive";
 
-  public static final ScoreDefinition SCORE_DEFINITION;
-
-  static {
-    SCORE_DEFINITION = new ScoreDefinition();
-    SCORE_DEFINITION.add("Gewinner");
-    // NOTE: Always write the XML representation of unicode characters, not the character directly, as it confuses the
-    // parsers which consume the server messages!
-    SCORE_DEFINITION.add(new ScoreFragment("\u2205 freie Felder", ScoreAggregation.AVERAGE));
-  }
+  // NOTE: Always write the XML representation of unicode characters, not the character directly, as it confuses the
+  // parsers which consume the server messages!
+  public static final ScoreDefinition SCORE_DEFINITION = new ScoreDefinition(new ScoreFragment[]{
+          new ScoreFragment("Gewinner"),
+          new ScoreFragment("\u2205 freie Felder", ScoreAggregation.AVERAGE)});
 
   @Override
   public IGameInstance createGame() {

server/src/sc/server/gaming/GameRoomManager.java

@@ -284,7 +284,7 @@ public void addResultToScore(GameResult result, String name1, String name2) thro
     final List<PlayerScore> playerScores = result.getScores();
     firstScore.setNumberOfTests(firstScore.getNumberOfTests() + 1);
     secondScore.setNumberOfTests(secondScore.getNumberOfTests() + 1);
-    for (int i = 0; i < scoreDefinition.size(); i++) {
+    for (int i = 0; i < scoreDefinition.getSize(); i++) {
       ScoreFragment fragment = scoreDefinition.get(i);
       ScoreValue firstValue = firstScore.getScoreValues().get(i);
       ScoreValue secondValue = secondScore.getScoreValues().get(i);

server/test/sc/server/plugins/TestPlugin.java

@@ -11,16 +11,7 @@
 public class TestPlugin implements IGamePlugin {
   public static final String TEST_PLUGIN_UUID = "012345-norris";
 
-  public static final ScoreDefinition SCORE_DEFINITION;
-
-  static {
-    SCORE_DEFINITION = new ScoreDefinition();
-    SCORE_DEFINITION.add("winner");
-  }
-
-  public TestPlugin() {
-
-  }
+  public static final ScoreDefinition SCORE_DEFINITION = new ScoreDefinition("winner");
 
   @Override
   public IGameInstance createGame() {
@@ -37,8 +28,6 @@ public void initialize(IGamePluginHost host) {
 
   @Override
   public void unload() {
-    // TODO Auto-generated method stub
-
   }
 
   @Override

socha-sdk/src/framework/sc/shared/Score.java

@@ -43,11 +43,7 @@ public int getNumberOfTests() {
   }
 
   public ScoreDefinition getScoreDefinition() {
-    ScoreDefinition scoreDefinition = new ScoreDefinition();
-    for (ScoreValue scoreValue : this) {
-      scoreDefinition.add(scoreValue.getFragment());
-    }
-    return scoreDefinition;
+    return new ScoreDefinition((ScoreFragment[]) scoreValues.stream().map(ScoreValue::getFragment).toArray());
   }
 
   public List<ScoreValue> getScoreValues() {

socha-sdk/src/framework/sc/shared/ScoreDefinition.kt

@@ -2,29 +2,35 @@ package sc.shared
 
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamImplicit
+import com.thoughtworks.xstream.annotations.XStreamOmitField
 
 @XStreamAlias(value = "scoreDefinition")
 class ScoreDefinition(
         @XStreamImplicit(itemFieldName = "fragment")
-        private val fragments: MutableList<ScoreFragment> = ArrayList()
-): List<ScoreFragment> by fragments {
+        private val fragments: Array<ScoreFragment>
+): Iterable<ScoreFragment>, RandomAccess {
 
-    fun add(string: String) =
-            add(ScoreFragment(string))
+    constructor(vararg fragments: String): this(fragments.map { ScoreFragment(it) }.toTypedArray())
 
-    fun add(fragment: ScoreFragment) =
-            fragments.add(fragment)
+    @XStreamOmitField
+    val size = fragments.size
 
     val isValid: Boolean
         get() = size > 0
 
+    operator fun get(index: Int) =
+            fragments[index]
+    
+    override fun iterator() =
+            fragments.iterator()
+    
     override fun toString() =
             "ScoreDefinition[${fragments.joinToString()}]"
 
     override fun equals(other: Any?): Boolean =
-            other is ScoreDefinition && fragments == other.fragments
+            other is ScoreDefinition && fragments.contentEquals(other.fragments)
 
     override fun hashCode() =
-            fragments.hashCode()
+            fragments.contentHashCode()
 
 }

socha-sdk/src/test/sc/shared/GameResultTest.kt

@@ -10,7 +10,7 @@ class GameResultTest: StringSpec({
         val xstream = XStream().apply {
             setMode(XStream.NO_REFERENCES)
         }
-        val definition = ScoreDefinition().apply { add("winner") }
+        val definition = ScoreDefinition("winner")
         val scores: List<PlayerScore> = listOf(
                 PlayerScore(ScoreCause.REGULAR, "test", 1),
                 PlayerScore(ScoreCause.LEFT, "second test", 0)