cvs commit: avalon-sandbox/merlin/composition-spi/src/java/org/apache/avalon/composition/model StageModel.java

[mc...@apache.org]

mcconnell    2003/07/24 15:13:52

  Added:       merlin/composition-spi/src/java/org/apache/avalon/composition/model
                        StageModel.java
  Log:
  Definition of a stage model that provides suppport for the explicit declaration of a stage provider (via component address) or via extension selection constrain filtering.
  
  Revision  Changes    Path
  1.1                  avalon-sandbox/merlin/composition-spi/src/java/org/apache/avalon/composition/model/StageModel.java
  
  Index: StageModel.java
  ===================================================================
  /*
  
   ============================================================================
                     The Apache Software License, Version 1.1
   ============================================================================
  
   Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved.
  
   Redistribution and use in source and binary forms, with or without modifica-
   tion, are permitted provided that the following conditions are met:
  
   1. Redistributions of  source code must  retain the above copyright  notice,
      this list of conditions and the following disclaimer.
  
   2. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  
   3. The end-user documentation included with the redistribution, if any, must
      include  the following  acknowledgment:  "This product includes  software
      developed  by the  Apache Software Foundation  (http://www.apache.org/)."
      Alternately, this  acknowledgment may  appear in the software itself,  if
      and wherever such third-party acknowledgments normally appear.
  
   4. The names "Jakarta", "Apache Avalon", "Avalon Framework" and
      "Apache Software Foundation"  must not be used to endorse or promote
      products derived  from this  software without  prior written
      permission. For written permission, please contact apache@apache.org.
  
   5. Products  derived from this software may not  be called "Apache", nor may
      "Apache" appear  in their name,  without prior written permission  of the
      Apache Software Foundation.
  
   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
   APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
   INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
   DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
   OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
   ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
   (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  
   This software  consists of voluntary contributions made  by many individuals
   on  behalf of the Apache Software  Foundation. For more  information on the
   Apache Software Foundation, please see <http://www.apache.org/>.
  
  */
  
  package org.apache.avalon.composition.model;
  
  import org.apache.avalon.meta.info.StageDescriptor;
  import org.apache.avalon.meta.info.ExtensionDescriptor;
  
  /**
   * Stage model handles the establishment of an explicit source 
   * extension defintion or stage provider selection based on 
   * extension qualification.
   *
   * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
   * @version $Revision: 1.1 $ $Date: 2003/07/24 22:13:52 $
   */
  public interface StageModel
  {
     /**
      * Return the stage descriptor for the model.
      *
      * @return the descriptor declaring the component 
      *    stage dependency
      */
      StageDescriptor getStage();
  
     /**
      * Return an explicit path to a component.  
      * If a stage directive has been declared
      * and the directive contains a source declaration, the value 
      * returned is the result of parsing the source value relative 
      * to the absolute address of the dependent component.
      *
      * @return the explicit path
      */
      String getPath();
  
     /**
      * Filter a set of candidate service descriptors and return the 
      * set of acceptable service as a ordered sequence.
      *
      * @param candidates the set of candidate extension providers
      *    for the stage dependency
      * @return the accepted candidates in ranked order
      */
      ExtensionDescriptor[] filter( ExtensionDescriptor[] candidates );
  
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org