Improve documentation.

[gpl/argeo-slc.git] / org.argeo.slc / src / main / java / org / argeo / slc / core / structure / StructureRegistry.java

diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java b/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java
index f574784d85b118b2095fdf79ec7319f35634b0f2..3ffb2d26ff1caa15139f4794d7deafe312139e6a 100644 (file)
--- a/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java
@@ -2,20 +2,57 @@ package org.argeo.slc.core.structure;
 \r
 import java.util.List;\r
 \r
+/** Registry where the whole structure is stored. */\r
 public interface StructureRegistry {\r
+       /** Read mode: the structure is only read. */\r
        public static String READ = "READ";\r
+       /** All mode: everything is executed regardless of the active paths. */\r
        public static String ALL = "ALL";\r
+       /** Active mode: only teh active paths are executed. */\r
        public static String ACTIVE = "ACTIVE";\r
-       \r
+\r
+       /** Adds an element to the registry. */\r
        public void register(StructureElement element);\r
+\r
+       /**\r
+        * Adds the wrapped element of a <code>SructureAware</code>, and\r
+        * propagates the registration.\r
+        */\r
        public void register(StructureAware structureAware);\r
+\r
+       /** Lists <b>all</b> registered elements. */\r
        public List<StructureElement> listElements();\r
-       \r
+\r
+       /** Gets a element based on its path. */\r
        public StructureElement getElement(StructurePath path);\r
-       \r
+\r
+       /**\r
+        * Set the interpreter mode: read, all or active.\r
+        * \r
+        * @see #READ\r
+        * @see #ALL\r
+        * @see #ACTIVE\r
+        */\r
        public void setMode(String mode);\r
+\r
+       /**\r
+        * Gets the current interpreter mode.\r
+        * \r
+        * @see #READ\r
+        * @see #ALL\r
+        * @see #ACTIVE\r
+        */\r
        public String getMode();\r
-       \r
+\r
+       /**\r
+        * Gets the list of active paths, which will be run if executed in\r
+        * <code>ACTIVE</code> mode.\r
+        */\r
        public List<StructurePath> getActivePaths();\r
+\r
+       /**\r
+        * Sets the list of active path, which will be run if executed in\r
+        * <code>ACTIVE</code> mode.\r
+        */\r
        public void setActivePaths(List<StructurePath> activePaths);\r
 }\r