src/main/java/com/indexdata/pz2utils4jsf/config/ConfigurationReader.java

   1 package com.indexdata.pz2utils4jsf.config;\r
   2 \r
   3 import java.io.Serializable;\r
   4 import java.util.List;\r
   5 \r
   6 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
   7 \r
   8 /**\r
   9  * Interface to be implemented by classes that read configurations from a source -\r
  10  * i.e. from web.xml, the file system, a database or hard-coded. \r
  11  * \r
  12  * @author Niels Erik\r
  13  *\r
  14  */\r
  15 public interface ConfigurationReader extends Serializable {\r
  16     \r
  17   /**\r
  18    * Returns a Configuration to be used by the given Configurable\r
  19    * \r
  20    * @param configurable the configurable to be configured by a configuration obtained by this reader\r
  21    * @return a Configuration, basically a set of key-value pairs\r
  22    * @throws ConfigurationException\r
  23    */\r
  24   public Configuration getConfiguration(Configurable configurable) throws ConfigurationException;\r
  25   \r
  26   /**\r
  27    * Returns documentation for the key-value pairs obtained by this reader\r
  28    * @return\r
  29    */\r
  30   public List<String> document();\r
  31 }\r