You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2003/07/27 05:17:08 UTC

cvs commit: avalon-sandbox/merlin/composition/src/java/org/apache/avalon/composition/model/impl DefaultProfileSelector.java

mcconnell    2003/07/26 20:17:08

  Added:       merlin/composition/src/java/org/apache/avalon/composition/model/impl
                        DefaultProfileSelector.java
  Log:
  Addition of the profile selector implementation.
  
  Revision  Changes    Path
  1.1                  avalon-sandbox/merlin/composition/src/java/org/apache/avalon/composition/model/impl/DefaultProfileSelector.java
  
  Index: DefaultProfileSelector.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002 The Apache Software Foundation. All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, 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", "Avalon", 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 (INCLUDING, 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.impl;
  
  import java.util.ArrayList;
  
  import org.apache.avalon.composition.model.ProfileSelector;
  import org.apache.avalon.meta.info.DependencyDescriptor;
  import org.apache.avalon.meta.info.StageDescriptor;
  import org.apache.avalon.composition.data.Mode;
  import org.apache.avalon.composition.data.Profile;
  
  /**
   * Default profile selector class. The default selector selects profiles based
   * of ranking of profile relative to EXPLICIT, PACKAGED and IMPLICIT
   * status. For each category, if a supplied profile matches the category
   * the first profile matching the category is returned.
   *
   * @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
   * @version $Revision: 1.1 $ $Date: 2003/07/27 03:17:08 $
   */
  class DefaultProfileSelector implements ProfileSelector
  {
      //==============================================================
      // ProfileSelector
      //==============================================================
  
      /**
       * Returns the preferred profile from an available selection of
       * candidates profiles.
       *
       * @param profiles the set of candidate profiles
       * @param dependency a service dependency
       * @return the preferred profile or null if no satisfactory profile 
       *    can be established
       */
      public Profile select( Profile[] profiles, DependencyDescriptor dependency )
      {
          return select( profiles );
      }
  
      /**
       * Returns the preferred profile from an available selection of
       * candidates profiles.
       *
       * @param profiles the set of candidate profiles
       * @param dependency a stage dependency
       * @return the preferred extension provider profile or null if 
       *    no satisfactory profile can be established
       */
      public Profile select( Profile[] profiles, StageDescriptor stage )
      {
          return select( profiles );
      }
  
      //==============================================================
      // implementation
      //==============================================================
  
      /**
       * Select a profile from a set of profiles based on a priority ordering
       * of EXPLICIT, PACKAGE and lastly IMPLICIT.  If multiple candidates
       * exist for a particular mode, return the first candidate.
       *
       * @param profiles the set of candidate profiles
       * @param dependency the service dependency
       * @return the preferred profile or null if no satisfactory 
       *   provider can be established
       */
      private Profile select( Profile[] profiles )
      {
          if( profiles.length == 0 )
          {
              return null;
          }
  
          for( int i=0; i<profiles.length; i++ )
          {
              if( profiles[i].getMode().equals( Mode.EXPLICIT ) )
              {
                  return profiles[i];
              }
          }
  
          for( int i=0; i<profiles.length; i++ )
          {
              if( profiles[i].getMode().equals( Mode.PACKAGED ) )
              {
                  return profiles[i];
              }
          }
  
          for( int i=0; i<profiles.length; i++ )
          {
              if( profiles[i].getMode().equals( Mode.IMPLICIT ) )
              {
                  return profiles[i];
              }
          }
  
          return null;
      }
  }
  
  
  

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