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/09/14 15:08:01 UTC

cvs commit: avalon-sandbox/merlin/repository/spi/src/java/org/apache/avalon/repository BlockManifest.java

mcconnell    2003/09/14 06:08:01

  Added:       merlin/repository/impl/src/java/org/apache/avalon/repository/impl
                        DefaultBlockManifest.java
               merlin/repository/spi/src/java/org/apache/avalon/repository
                        BlockManifest.java
  Log:
  Improve interface and impl documentation and add block installation so that we can install into the users local repository (independently of the system repository).
  
  Revision  Changes    Path
  1.1                  avalon-sandbox/merlin/repository/impl/src/java/org/apache/avalon/repository/impl/DefaultBlockManifest.java
  
  Index: DefaultBlockManifest.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.repository.impl;
  
  import java.util.jar.Manifest;
  import org.apache.avalon.repository.BlockManifest;
  
  /**
   * An extended manifest that provides a set of convinience operations
   * to access block related attributes.
   *
   * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
   * @version $Revision: 1.1 $ $Date: 2003/09/14 13:08:01 $
   */
  public final class DefaultBlockManifest implements BlockManifest
  {
  
     /**
      * Group identifier.
      */
      private final String m_group;
  
     /**
      * Name.
      */
      private final String m_name;
  
     /**
      * Version identifier.
      */
      private final String m_version;
  
     /**
      * Creation of a new block manifest
      * @param manifest the jar manifest
      */
      public DefaultBlockManifest( Manifest manifest ) throws NullPointerException 
      {
          m_group = (String) manifest.getMainAttributes().getValue( BLOCK_GROUP_KEY );
          m_name = (String) manifest.getMainAttributes().getValue( BLOCK_NAME_KEY );
          m_version = (String) manifest.getMainAttributes().getValue( BLOCK_VERSION_KEY );
      }
  
      public String getBlockGroup()
      {
          return m_group;
      }
  
      public String getBlockName()
      {
          return m_name;
      }
  
      public String getBlockVersion()
      {
          return m_version;
      }
  }
  
  
  
  1.1                  avalon-sandbox/merlin/repository/spi/src/java/org/apache/avalon/repository/BlockManifest.java
  
  Index: BlockManifest.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.repository;
  
  /**
   * A block manifest that provides a set of convinience operations
   * to access block related attributes.
   *
   * @author <a href="mailto:dev@avalon.apache.org">Avalon Development Team</a>
   * @version $Revision: 1.1 $ $Date: 2003/09/14 13:08:01 $
   */
  public interface BlockManifest
  {
  
     /**
      * Group identifier manifest key.
      */
      public static final String BLOCK_GROUP_KEY = "Block-Group";
  
     /**
      * Name identifier manifest key.
      */
      public static final String BLOCK_NAME_KEY = "Block-Name";
  
     /**
      * Version identifier manifest key.
      */
      public static final String BLOCK_VERSION_KEY = "Block-Version";
  
     /**
      * Get the name of the group that the block is a part of.
      * @return the block group
      */
      String getBlockGroup();
  
     /**
      * Get the name the block.
      * @return the block name
      */
      String getBlockName();
  
     /**
      * Get the version of the block.
      * @return the block version
      */
      String getBlockVersion();
  }
  
  
  

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