proyal 2002/10/16 13:03:52
Modified: src/java/org/apache/avalon/cornerstone/services/store
Store.java
Log:
Documentation update from Greg Steuck <[EMAIL PROTECTED]>
Revision Changes Path
1.8 +28 -9
jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/store/Store.java
Index: Store.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-cornerstone/src/java/org/apache/avalon/cornerstone/services/store/Store.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Store.java 24 Sep 2002 12:16:56 -0000 1.7
+++ Store.java 16 Oct 2002 20:03:51 -0000 1.8
@@ -11,7 +11,14 @@
import org.apache.avalon.framework.service.ServiceSelector;
/**
- * @author Federico Barbieri <[EMAIL PROTECTED]>
+ * Allows selection from a number of configured Repositories.
+ * Selection criterion is passed in as a <tt>Configuration</tt>
+ * object.
+ *
+ * @see Repository
+ * @see ObjectRepository
+ * @see StreamRepository
+ * @author <a href="mailto:[EMAIL PROTECTED]";>Federico Barbieri</a>
*/
public interface Store
extends ServiceSelector
@@ -19,14 +26,26 @@
String ROLE = Store.class.getName();
/**
- * This method accept a Configuration object as policy and returns the
- * corresponding Repository.
- * The Configuration must be in the form of:
- * <repository destinationURL="[URL of this repository]"
- * type="[repository type ex. OBJECT or STREAM or MAIL etc.]"
- * model="[repository model ex. PERSISTENT or CACHE etc.]">
- * [addition configuration]
- * </repository>
+ * Selects a Repository configured for the given <tt>policy</tt>.
+ * The <tt>policy</tt> must be an instance of
+ * {@link org.apache.avalon.framework.configuration.Configuration}.
+ * The following attributes are used by the Store and thus are mandatory
+ * in the <tt>policy</tt> parameter:
+ * <pre>
+ * <repository destinationURL="[URL of this repository]"
+ * type="[repository type e.g. OBJECT, STREAM or MAIL]"
+ * model="[repository model e.g. PERSISTENT, CACHE]">
+ * [additional configuration]
+ * </repository>
+ * </pre>
+ * <p>
+ * The <tt>policy</tt> is used both to select the appropriate
+ * Repository and to configure it.
+ * </p>
+ *
+ * @param policy a {@link
org.apache.avalon.framework.configuration.Configuration} object identifying the sought
Repository
+ * @return requested {@link Repository}
+ * @throws ServiceException if no repository matches <tt>policy</tt>
*/
Object select( Object policy )
throws ServiceException;
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
