aboutsummaryrefslogtreecommitdiffstats
path: root/src/jcgp/backend/modules/Module.java
diff options
context:
space:
mode:
authorEduardo Pedroni <ep625@york.ac.uk>2014-04-25 19:38:16 +0100
committerEduardo Pedroni <ep625@york.ac.uk>2014-04-25 19:38:16 +0100
commitb0c0698e5503c2506217117bf144fde31e6f6601 (patch)
tree11a6e20fb565f1e75fb25852e757e4a37e4c313b /src/jcgp/backend/modules/Module.java
parent9ac2848be66c39acdc291dc3b48b91178acc1a05 (diff)
Commented lots of packages.
Diffstat (limited to 'src/jcgp/backend/modules/Module.java')
-rw-r--r--src/jcgp/backend/modules/Module.java14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/jcgp/backend/modules/Module.java b/src/jcgp/backend/modules/Module.java
index a6b4d73..7efbf3a 100644
--- a/src/jcgp/backend/modules/Module.java
+++ b/src/jcgp/backend/modules/Module.java
@@ -2,8 +2,22 @@ package jcgp.backend.modules;
import jcgp.backend.resources.parameters.Parameter;
+/**
+ * This interface defines the expected behaviour of a module. Specifically, a module
+ * is expected to be able to return a list of local parameters. When a user interface
+ * is used, it is expected to display the parameters of each module and allow user
+ * interaction for parameters which are not monitors.
+ *
+ * @see Parameter
+ *
+ * @author Eduardo Pedroni
+ *
+ */
public interface Module {
+ /**
+ * @return a list of generic parameters exposed by the module.
+ */
public abstract Parameter<?>[] getLocalParameters();
}