proyal 2002/06/22 13:43:30
Modified: src/java/org/apache/avalon/phoenix/interfaces
ConfigurationRepository.java
Log:
Added javadocs to methods
Revision Changes Path
1.9 +21 -0
jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/ConfigurationRepository.java
Index: ConfigurationRepository.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/interfaces/ConfigurationRepository.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ConfigurationRepository.java 10 May 2002 09:13:41 -0000 1.8
+++ ConfigurationRepository.java 22 Jun 2002 20:43:30 -0000 1.9
@@ -19,9 +19,30 @@
{
String ROLE = ConfigurationRepository.class.getName();
+ /**
+ * Retrieve configuration information from the repository
+ *
+ * @param application Application name
+ * @param block Block name to get configuration for
+ *
+ * @return Configuration information
+ *
+ * @throws org.apache.avalon.framework.configuration.Configuration if no
configuration could be found
+ */
Configuration getConfiguration( String application, String block )
throws ConfigurationException;
+ /**
+ * Store configuration information in the repository
+ *
+ * @param application Application name
+ * @param block Block name to store configuration for
+ * @param configuration information to store.
+ *
+ * Question: Is the storing of a null value to remove configuration
information part of the contract?
+ *
+ * @throws org.apache.avalon.framework.configuration.Configuration if
configuration could not be stored
+ */
void storeConfiguration( String application, String block, Configuration
configuration )
throws ConfigurationException;
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
