Restructured serializing / deserializing

[Mograsim.git] / net.mograsim.logic.ui / src / net / mograsim / logic / ui / model / components / GUIComponent.java

diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
index 472798f..1699da5 100644 (file)
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
@@ -1,14 +1,11 @@
 package net.mograsim.logic.ui.model.components;
 
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.TreeMap;
 import java.util.function.Consumer;
-import java.util.function.Supplier;
 
 import net.haspamelodica.swt.helper.gcs.GeneralGC;
 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
@@ -33,9 +30,9 @@ public abstract class GUIComponent
         */
        private final Map<String, Pin> pinsByName;
        /**
-        * An unmodifiable view of {@link #pinsByName}<code>.</code>{@link Map#values() values()}.
+        * An unmodifiable view of {@link #pinsByName}.
         */
-       protected final Collection<Pin> pinsUnmodifiable;
+       protected final Map<String, Pin> pinsUnmodifiable;
 
        private final List<Consumer<? super GUIComponent>> componentMovedListeners;
        private final List<Consumer<? super Pin>> pinAddedListeners;
@@ -43,8 +40,6 @@ public abstract class GUIComponent
        private final List<Runnable> redrawListeners;
 
        private final Runnable redrawListenerForSubcomponents;
-       // Defines how the GUIComponent is referenced in SubmodelComponentParams
-       protected Supplier<String> identifierDelegate = () -> "class:".concat(getClass().getCanonicalName());
 
        // creation and destruction
 
@@ -53,7 +48,7 @@ public abstract class GUIComponent
                this.model = model;
                this.bounds = new Rectangle(0, 0, 0, 0);
                this.pinsByName = new HashMap<>();
-               this.pinsUnmodifiable = Collections.unmodifiableCollection(pinsByName.values());
+               this.pinsUnmodifiable = Collections.unmodifiableMap(pinsByName);
 
                this.componentMovedListeners = new ArrayList<>();
                this.pinAddedListeners = new ArrayList<>();
@@ -119,7 +114,7 @@ public abstract class GUIComponent
         * 
         * @author Daniel Kirschten
         */
-       public Collection<Pin> getPins()
+       public Map<String, Pin> getPins()
        {
                return pinsUnmodifiable;
        }
@@ -139,6 +134,38 @@ public abstract class GUIComponent
                return pin;
        }
 
+       // high-level access
+
+       /**
+        * Sets the given high-level state to the given value. <br>
+        * A high level state ID consists of parts separated by dots ('.').<br>
+        * The last part (the part after the last dot) is called "atomic high level state ID". The parts before that part are called
+        * "subcomponent ID"s.<br>
+        * If there is no dot in a high level state ID, the whole high level state ID is called atomic.<br>
+        * Note that subcomponent IDs don't have to correspond to actual subcomponents. For example, a RAM component may supply subcomponent IDs
+        * "c0000", "c0001" ... "cFFFF" without actually having a subcomponent for each cell. It also is allowed for an atomic high level state
+        * ID to be delegated to a subcomponent.
+        * 
+        * @author Daniel Kirschten
+        */
+       @SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden
+       public void setHighLevelState(String stateID, Object newState)
+       {
+               throw new IllegalArgumentException("No high level state with ID " + stateID);
+       }
+
+       /**
+        * Gets the current value of the given high-level state. <br>
+        * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
+        * 
+        * @author Daniel Kirschten
+        */
+       @SuppressWarnings("static-method") // this method is intended to be overridden
+       public Object getHighLevelState(String stateID)
+       {
+               throw new IllegalArgumentException("No high level state with ID " + stateID);
+       }
+
        // "graphical" operations
 
        /**
@@ -172,7 +199,7 @@ public abstract class GUIComponent
         * 
         * @author Daniel Kirschten
         */
-       public Rectangle getBounds()
+       public final Rectangle getBounds()
        {
                return new Rectangle(bounds.x, bounds.y, bounds.width, bounds.height);
        }
@@ -236,22 +263,6 @@ public abstract class GUIComponent
         */
        public abstract void render(GeneralGC gc, Rectangle visibleRegion);
 
-       // serializing
-
-       /**
-        * @return an identifier used to reference this GUIComponent inside of {@link SubmodelComponentParams}
-        */
-       public String getIdentifier()
-       {
-               return identifierDelegate.get();
-       }
-
-       @SuppressWarnings("static-method")
-       public Map<String, Object> getInstantiationParameters()
-       {
-               return new TreeMap<>();
-       }
-
        // listeners
 
        /**