Documentation

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / pz2utils4jsf / config / ConfigurationReader.java

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/config/ConfigurationReader.java b/src/main/java/com/indexdata/pz2utils4jsf/config/ConfigurationReader.java
index 528e8bd..ea94af5 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/config/ConfigurationReader.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/config/ConfigurationReader.java
@@ -5,9 +5,27 @@ import java.util.List;
 \r
 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
 \r
+/**\r
+ * Interface to be implemented by classes that read configurations from a source -\r
+ * i.e. from web.xml, the file system, a database or hard-coded. \r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public interface ConfigurationReader extends Serializable {\r
     \r
+  /**\r
+   * Returns a Configuration to be used by the given Configurable\r
+   * \r
+   * @param configurable the configurable to be configured by a configuration obtained by this reader\r
+   * @return a Configuration, basically a set of key-value pairs\r
+   * @throws ConfigurationException\r
+   */\r
   public Configuration getConfiguration(Configurable configurable) throws ConfigurationException;\r
   \r
+  /**\r
+   * Returns documentation for the key-value pairs obtained by this reader\r
+   * @return\r
+   */\r
   public List<String> document();\r
 }\r