donaldp 2002/09/24 05:13:46
Modified: src/java/org/apache/avalon/framework/service
ServiceSelector.java
Log:
Fix some javadocs
Revision Changes Path
1.7 +15 -16
jakarta-avalon/src/java/org/apache/avalon/framework/service/ServiceSelector.java
Index: ServiceSelector.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/service/ServiceSelector.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ServiceSelector.java 26 Jun 2002 09:22:19 -0000 1.6
+++ ServiceSelector.java 24 Sep 2002 12:13:46 -0000 1.7
@@ -8,8 +8,8 @@
package org.apache.avalon.framework.service;
/**
- * A <code>ServiceSelector</code> selects <code>Object</code>s based on a
- * supplied policy. The contract is that all the <code>Object</code>s implement the
+ * A <code>ServiceSelector</code> selects {@link Object}s based on a
+ * supplied policy. The contract is that all the {@link Object}s implement the
* same role.
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Berin Loritsch</a>
@@ -17,15 +17,14 @@
* @version 1.0
* @see org.apache.avalon.framework.service.Serviceable
* @see org.apache.avalon.framework.service.ServiceSelector
- *
*/
public interface ServiceSelector
{
/**
- * Select the <code>Object</code> associated with the given policy.
- * For instance, If the <code>ServiceSelector</code> has a
- * <code>Generator</code> stored and referenced by a URL, I would use the
- * following call:
+ * Select the {@link Object} associated with the given policy.
+ * For instance, If the {@link ServiceSelector} has a
+ * <code>Generator</code> stored and referenced by a URL, the
+ * following call could be used:
*
* <pre>
* try
@@ -39,30 +38,30 @@
* }
* </pre>
*
- * @param policy A criteria against which a <code>Object</code> is selected.
+ * @param policy A criteria against which a {@link Object} is selected.
*
- * @return an <code>Object</code> value
- * @throws ComponentException If the requested <code>Object</code> cannot be
supplied
+ * @return an {@link Object} value
+ * @throws ServiceException If the requested {@link Object} cannot be supplied
*/
Object select( Object policy )
throws ServiceException;
/**
- * Check to see if a <code>Object</code> exists relative to the supplied policy.
+ * Check to see if a {@link Object} exists relative to the supplied policy.
*
- * @param policy a <code>Object</code> containing the selection criteria
+ * @param policy a {@link Object} containing the selection criteria
* @return True if the component is available, False if it not.
*/
boolean isSelectable( Object policy );
/**
- * Return the <code>Object</code> when you are finished with it. This
- * allows the <code>ServiceSelector</code> to handle the End-Of-Life Lifecycle
- * events associated with the <code>Object</code>. Please note, that no
+ * Return the {@link Object} when you are finished with it. This
+ * allows the {@link ServiceSelector} to handle the End-Of-Life Lifecycle
+ * events associated with the {@link Object}. Please note, that no
* Exception should be thrown at this point. This is to allow easy use of the
* ServiceSelector system without having to trap Exceptions on a release.
*
- * @param object The <code>Object</code> we are releasing.
+ * @param object The {@link Object} we are releasing.
*/
void release( Object object );
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
