Return-Path: Delivered-To: apmail-jakarta-avalon-cvs-archive@apache.org Received: (qmail 17849 invoked from network); 24 Sep 2002 12:13:52 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 24 Sep 2002 12:13:52 -0000 Received: (qmail 4672 invoked by uid 97); 24 Sep 2002 12:14:30 -0000 Delivered-To: qmlist-jakarta-archive-avalon-cvs@jakarta.apache.org Received: (qmail 4630 invoked by uid 97); 24 Sep 2002 12:14:29 -0000 Mailing-List: contact avalon-cvs-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Avalon CVS List" Reply-To: "Avalon Developers List" Delivered-To: mailing list avalon-cvs@jakarta.apache.org Received: (qmail 4618 invoked by uid 98); 24 Sep 2002 12:14:28 -0000 X-Antivirus: nagoya (v4218 created Aug 14 2002) Date: 24 Sep 2002 12:13:46 -0000 Message-ID: <20020924121346.5784.qmail@icarus.apache.org> From: donaldp@apache.org To: jakarta-avalon-cvs@apache.org Subject: cvs commit: jakarta-avalon/src/java/org/apache/avalon/framework/service ServiceSelector.java X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N 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 ServiceSelector selects Objects based on a - * supplied policy. The contract is that all the Objects implement the + * A ServiceSelector selects {@link Object}s based on a + * supplied policy. The contract is that all the {@link Object}s implement the * same role. * * @author Berin Loritsch @@ -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 Object associated with the given policy. - * For instance, If the ServiceSelector has a - * Generator 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 + * Generator stored and referenced by a URL, the + * following call could be used: * * 
        * try
  @@ -39,30 +38,30 @@
        * }
        *
* - * @param policy A criteria against which a Object is selected. + * @param policy A criteria against which a {@link Object} is selected. * - * @return an Object value - * @throws ComponentException If the requested Object 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 Object exists relative to the supplied policy. + * Check to see if a {@link Object} exists relative to the supplied policy. * - * @param policy a Object 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 Object when you are finished with it. This - * allows the ServiceSelector to handle the End-Of-Life Lifecycle - * events associated with the Object. 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 Object we are releasing. + * @param object The {@link Object} we are releasing. */ void release( Object object ); -- To unsubscribe, e-mail: For additional commands, e-mail: