CodeSnippetSupplier now supports high level state handlers

[Mograsim.git] / net.mograsim.logic.ui / src / net / mograsim / logic / ui / serializing / snippets / HighLevelStateHandler.java

diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/serializing/snippets/HighLevelStateHandler.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/serializing/snippets/HighLevelStateHandler.java
new file mode 100644 (file)
index 0000000..596582a
--- /dev/null
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/serializing/snippets/HighLevelStateHandler.java
@@ -0,0 +1,34 @@
+package net.mograsim.logic.ui.serializing.snippets;
+
+import net.mograsim.logic.ui.model.components.GUIComponent;
+
+public interface HighLevelStateHandler
+{
+       /**
+        * 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 to delegate an atomic high
+        * level state ID to a subcomponent.
+        * 
+        * @see #getHighLevelState(String)
+        * @see GUIComponent#setHighLevelState(String, Object)
+        * 
+        * @author Daniel Kirschten
+        */
+       public void setHighLevelState(String stateID, Object newState);
+
+       /**
+        * Gets the current value of the given high-level state. <br>
+        * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
+        * 
+        * @see #setHighLevelState(String, Object)
+        * @see GUIComponent#getHighLevelState(String)
+        * 
+        * @author Daniel Kirschten
+        */
+       public Object getHighLevelState(String stateID);
+}
\ No newline at end of file