You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2003/09/02 00:00:54 UTC

cvs commit: jakarta-commons-sandbox/primitives/src/conf MANIFEST.MF

scolebourne    2003/09/01 15:00:54

  Added:       primitives project.xml maven.xml build.properties.sample
                        STATUS.html PROPOSAL.html RELEASE-NOTES.txt
                        build.xml LICENSE.txt .cvsignore project.properties
                        checkstyle.xml
               primitives/src/conf MANIFEST.MF
  Log:
  Initial checkin
  
  Revision  Changes    Path
  1.1                  jakarta-commons-sandbox/primitives/project.xml
  
  Index: project.xml
  ===================================================================
  <?xml version="1.0"?>
  <project>
    <extend>../project.xml</extend>
    <id>commons-primitives</id>
    <name>Commons Primitives</name>
    <currentVersion>0.5-dev</currentVersion>
    <inceptionYear>2003</inceptionYear>
    
    <description>
      Commons Primitives is a set of utility and collection classes for primitive types.
      The Java language has a clear distinction between Object and primitive types.
      A lot of functionality is provided for Object types, including the Java Collection Framework.
      Relatively little functionality is provided by the JDK for primitives.
      This package addresses this by providing a set of utility and collection classes for primiives.
    </description>
    
    <shortDescription>Apache Jakarta Commons Primitives</shortDescription>
  
    <developers>
      <developer>
        <name>Stephen Colebourne</name>
        <id>scolebourne</id>
        <email>scolebourne@apache.org</email>
        <organization>SITA ATS Ltd</organization>
      </developer>
      <developer>
        <name>Rodney Waldhoff</name>
        <id>rwaldhoff</id>
        <email>rwaldhoff@apache.org</email>
        <organization></organization>
      </developer>
    </developers>
  
    <contributors>
    </contributors>
    
    <!-- Primitives should depend on very little -->
    <dependencies>
      <dependency><!-- compile time -->
        <id>junit</id>
        <version>3.7</version>
      </dependency>
    </dependencies>
  
    <build>
      <unitTest>
        <includes>
          <include>**/AllPrimitivesTestSuite.java</include>
        </includes>
        <excludes>
        </excludes>
      </unitTest>
    </build>
  
  </project>
  
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/maven.xml
  
  Index: maven.xml
  ===================================================================
  <project default="java:jar"
    xmlns:j="jelly:core">
  
  </project>
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/build.properties.sample
  
  Index: build.properties.sample
  ===================================================================
  # The directory containing your binary distribution of JUnit, 
  # version 3.7 or later
  junit.home = /usr/local/junit3.7
  
  # The pathname of the "junit.jar" JAR file
  junit.jar = ${junit.home}/junit.jar
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/STATUS.html
  
  Index: STATUS.html
  ===================================================================
  <html>
  <head>
  <title>Status File for Jakarta Commons "Primitives" Component</title>
  </head>
  <body bgcolor="white">
  
  
  <div align="center">
  <h1>The Jakarta Commons <em>primitives</em> Component</h1>
  $Id: STATUS.html,v 1.1 2003/09/01 22:00:54 scolebourne Exp $<br />
  <a href="#Introduction">[Introduction]</a>
  <a href="#Dependencies">[Dependencies]</a>
  <a href="#Release Info">[Release Info]</a>
  <a href="#Committers">[Committers]</a>
  <a href="#Action Items">[Action Items]</a>
  <br /><br />
  </div>
  
  
  <a name="Introduction"></a>
  <h3>1.  INTRODUCTION</h3>
  
  <p>The <em>primitives</em> Component contains a set of Java classes that provide
  ......The following classes are included:</p>
  <ul>
  <li><strong>TBD</strong> - TBD.</li>
  </ul>
  
  
  <a name="Dependencies"></a>
  <h3>2.  DEPENDENCIES</h3>
  
  <p>The <em>primitives</em> component is dependent upon the following external
  components for development and use:</p>
  <ul>
  <li><a href="http://java.sun.com/j2se">Java Development Kit</a>
      (Version 1.2 or later)</li>
  <li><a href="http://www.junit.org">JUnit Testing Framework</a>
      (Version 3.7 or later) - for unit tests only, not required
      for deployment</li>
  </ul>
  
  
  <a name="Release Info"></a>
  <h3>3.  RELEASE INFO</h3>
  
  <p>Current Release: primitives is yet to be released.  We hope it will be RSN.</p>
  
  <p>Planned Next Release:  Real Soon Now :)  See the
  <a href="#Action Items">Action Items</a> list for tasks that need to be
  completed prior to this release.</p>
  
  
  <a name="Committers"></a>
  <h3>4.  COMMITTERS</h3>
  
  <p>The following individuals are the primary developers and maintainers of this
  component.  Developers who plan to use <em>primitives</em> in their own
  projects are encouraged to collaborate on the future development of this
  component to ensure that it continues to meet a variety of needs.</p>
  <ul>
  <li>Stephen Colebourne</li>
  <li>Rodney Waldhoff</li>
  <li>Fancy volunteering?  We need you!</li>
  </ul>
  
  
  <a name="Action Items"></a>
  <h3>5.  ACTION ITEMS</h3>
  
  <p>The following action items need to be completed prior to a Version 1.0
  release of this component:</p>
  
  <table border="1">
  
    <tr>
      <th width="80%">Action Item</th>
      <th width="20%">Volunteer</th>
    </tr>
  
    <tr>
      <td><strong>CODE!</strong>.  Add code to make this package useful.</td>
      <td align="center">Everyone</td>
    </tr>
  
  </table>
  
  </body>
  </html>
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/PROPOSAL.html
  
  Index: PROPOSAL.html
  ===================================================================
  <html>
  <head>
  <title>Proposal for Primitives Package</title>
  </head>
  <body bgcolor="white">
  
  <div align="center">
  <h1>Proposal for <em>Primitives</em> Package</h1>
  </div>
  
  <h3>(0) Rationale</h3>
  <p>
     The Java language has a fundamental distinction between Object and primitive types.
     The JDK provides many method for manipulating and working with Objects.
     There is relatively little support for working with primitive types.
  </p>
  <p>
     One example of the lack of primitive support is the Java Collections Framework.
     This fully supports functionality for Objects, but requires primitives to be wrapped.
     This has serious memory and performance implications.
  </p>
  <p>
     The primitives package supplies a suite of primitive-based methods, utilities
     and collections for all primitive types.
  </p>
  
  <h3>(1) Scope of the Package</h3>
  <p>
     The package will create and maintain a set of utilities and collections for
     primitive types, distributed under the ASF license.
  </p>
  
  <h3>(1.5) Interaction With Other Packages</h3>
  <p>
     <em>Primitives</em> relies only on standard JDK 1.2 (or later) APIs for
     production deployment.  It utilizes the JUnit unit testing framework for
     developing and executing unit tests, but this is of interest only to
     developers of the component.
  </p>
  <p>
     No external configuration files are utilized.
  </p>
  
  <h3>(2) Initial Source of the Package</h3>
  <p>
     The initial codebase was harvested from code in the Commons Collections CVS and
     the PCJ open source library.
  </p>
  
  <p>The proposed package name for the new component is
  <code>org.apache.commons.primitives</code>.</p>
  
  
  <h3>(3)  Required Jakarta-Commons Resources</h3>
  <ul>
  <li>CVS Repository - New directory <code>pcollections</code> in the
      <code>jakarta-commons-sandbox</code> CVS repository.</li>
  <li>Mailing List - Discussions will take place on the general
      <em>commons-dev@jakarta.apache.org</em> mailing list.  To help
      list subscribers identify messages of interest, it is suggested that
      the message subject of messages about this component be prefixed with
      [primitives].</li>
  <li>Bugzilla - New component "Primitives" under the "Commons" product
      category, with appropriate version identifiers as needed.</li>
  <li>Jyve FAQ - New category "commons-primitives" (when available).
  </ul>
  
  
  <h3>(4) Initial Committers</h3>
  <ul>
     <li>Stephen Colebourne</li>
     <li>Rodney Waldhoff</li>
  </ul>
  </body>
  </html>
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/RELEASE-NOTES.txt
  
  Index: RELEASE-NOTES.txt
  ===================================================================
  $Id: RELEASE-NOTES.txt,v 1.1 2003/09/01 22:00:54 scolebourne Exp $
  
  			 Commons Primitives Package
  			   Version 1.0-dev
  			    Release Notes
  
  
  INTRODUCTION:
  
  This is the first release of the Commons Primitives package.
  
  
  NEW FEATURES:
  
  * 
  
  
  BUG FIXES:
  
  
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/build.xml
  
  Index: build.xml
  ===================================================================
  <project name="time" default="compile" basedir=".">
  
  
  <!--
          "Primitives" component of the Jakarta Commons Subproject
          $Id: build.xml,v 1.1 2003/09/01 22:00:54 scolebourne Exp $
  -->
  
  
  <!-- ========== Initialize Properties ===================================== -->
  
  
    <property file="build.properties"/>                <!-- Component local   -->
    <property file="../build.properties"/>             <!-- Commons local     -->
    <property file="${user.home}/build.properties"/>   <!-- User local        -->
  
  
  <!-- ========== External Dependencies ===================================== -->
  
  
    <!-- The directory containing your binary distribution of JUnit,
         version 3.7 or later -->
    <property name="junit.home"              value="/usr/local/junit3.7"/>
  
  
  <!-- ========== Derived Values ============================================ -->
  
  
    <!-- The pathname of the "junit.jar" JAR file -->
    <property name="junit.jar"               value="${junit.home}/junit.jar"/>
  
  
  <!-- ========== Component Declarations ==================================== -->
  
  
    <!-- The name of this component -->
    <property name="component.name"          value="primitives"/>
  
    <!-- The primary package name of this component -->
    <property name="component.package"       value="org.apache.commons.primitives"/>
  
    <!-- The title of this component -->
    <property name="component.title"         value="Primitive type utilities"/>
  
    <!-- The current version number of this component -->
    <property name="component.version"       value="1.0-dev"/>
  
    <!-- The base directory for compilation targets -->
    <property name="build.home"              value="target"/>
  
    <!-- The base directory for component configuration files -->
    <property name="conf.home"               value="src/conf"/>
  
    <!-- The base directory for distribution targets -->
    <property name="dist.home"               value="dist"/>
  
    <!-- The base directory for component sources -->
    <property name="source.home"             value="src/java"/>
  
    <!-- The base directory for unit test sources -->
    <property name="test.home"               value="src/test"/>
  
  
  <!-- ========== Compiler Defaults ========================================= -->
  
  
    <!-- Should Java compilations set the 'debug' compiler option? -->
    <property name="compile.debug"           value="true"/>
  
    <!-- Should Java compilations set the 'deprecation' compiler option? -->
    <property name="compile.deprecation"     value="true"/>
  
    <!-- Should Java compilations set the 'optimize' compiler option? -->
    <property name="compile.optimize"        value="true"/>
  
    <!-- Construct compile classpath -->
    <path id="compile.classpath">
      <pathelement location="${build.home}/classes"/>
    </path>
  
  
  <!-- ========== Test Execution Defaults =================================== -->
  
  
    <!-- Construct unit test classpath -->
    <path id="test.classpath">
      <pathelement location="${build.home}/classes"/>
      <pathelement location="${build.home}/tests"/>
      <pathelement location="${junit.jar}"/>
    </path>
  
    <!-- Should all tests fail if one does? -->
    <property name="test.failonerror"        value="true"/>
  
    <!-- The test runner to execute -->
    <property name="test.runner"             value="junit.textui.TestRunner"/>
  
  
  <!-- ========== Executable Targets ======================================== -->
  
  
    <target name="init"
     description="Initialize and evaluate conditionals">
      <echo message="-------- ${component.name} ${component.version} --------"/>
      <filter  token="name"                  value="${component.name}"/>
      <filter  token="package"               value="${component.package}"/>
      <filter  token="version"               value="${component.version}"/>
    </target>
  
  
    <target name="prepare" depends="init"
     description="Prepare build directory">
      <mkdir dir="${build.home}"/>
      <mkdir dir="${build.home}/classes"/>
      <mkdir dir="${build.home}/conf"/>
      <mkdir dir="${build.home}/tests"/>
    </target>
  
  
    <target name="static" depends="prepare"
     description="Copy static files to build directory">
      <tstamp/>
      <copy  todir="${build.home}/conf" filtering="on">
        <fileset dir="${conf.home}" includes="*.MF"/>
      </copy>
    </target>
  
  
    <target name="compile" depends="static"
     description="Compile shareable components">
      <javac  srcdir="${source.home}"
             destdir="${build.home}/classes"
               debug="${compile.debug}"
         deprecation="${compile.deprecation}"
            optimize="${compile.optimize}">
        <classpath refid="compile.classpath"/>
      </javac>
      <copy    todir="${build.home}/classes" filtering="on">
        <fileset dir="${source.home}" excludes="**/*.java"/>
      </copy>
    </target>
  
  
    <target name="compile.tests" depends="compile"
     description="Compile unit test cases">
      <javac  srcdir="${test.home}"
             destdir="${build.home}/tests"
               debug="${compile.debug}"
         deprecation="${compile.deprecation}"
            optimize="${compile.optimize}">
        <classpath refid="test.classpath"/>
      </javac>
      <copy    todir="${build.home}/tests" filtering="on">
        <fileset dir="${test.home}" excludes="**/*.java"/>
      </copy>
    </target>
  
  
    <target name="clean"
     description="Clean build and distribution directories">
      <delete    dir="${build.home}"/>
      <delete    dir="${dist.home}"/>
    </target>
  
  
    <target name="all" depends="clean,compile"
     description="Clean and compile all components"/>
  
  
    <target name="javadoc" depends="compile"
     description="Create component Javadoc documentation">
      <mkdir      dir="${dist.home}"/>
      <mkdir      dir="${dist.home}/docs"/>
      <mkdir      dir="${dist.home}/docs/api"/>
      <javadoc sourcepath="${source.home}"
                  destdir="${dist.home}/docs/api"
             packagenames="org.apache.commons.*"
                   author="true"
                  private="true"
                  version="true"
                 doctitle="&lt;h1&gt;${component.title}&lt;/h1&gt;"
              windowtitle="${component.title} (Version ${component.version})"
                   bottom="Copyright (c) 2003 - Apache Software Foundation">
        <classpath refid="compile.classpath"/>
      </javadoc>
    </target>
  
  
    <target name="dist" depends="compile,javadoc"
     description="Create binary distribution">
      <mkdir      dir="${dist.home}"/>
      <copy      file="../LICENSE"
                todir="${dist.home}"/>
      <copy      file="RELEASE-NOTES.txt"
                todir="${dist.home}"/>
      <antcall target="jar"/>
    </target>
  
  
    <target name="jar" depends="compile"
     description="Create jar">
      <mkdir      dir="${dist.home}"/>
      <mkdir      dir="${build.home}/classes/META-INF"/>
      <copy      file="../LICENSE"
               tofile="${build.home}/classes/META-INF/LICENSE.txt"/>
      <jar    jarfile="${dist.home}/commons-${component.name}.jar"
              basedir="${build.home}/classes"
             manifest="${build.home}/conf/MANIFEST.MF"/>
    </target>
  
  
    <target name="install-jar" depends="jar"
     description="--> Installs jar file in ${lib.repo}">
      <copy todir="${lib.repo}" filtering="no">
        <fileset dir="${dist.home}">
          <include name="commons-${component.name}.jar"/>
        </fileset>
      </copy>
    </target>
  
  
  <!-- ========== Unit Test Targets ========================================= -->
  
  
    <target name="test"  depends="compile.tests,
                                  test.primitives"
     description="Run all unit test cases">
    </target>
  
  
    <target name="test.primitives" depends="compile.tests">
      <echo message="Running primitives tests ..."/>
      <java classname="${test.runner}" fork="yes"
          failonerror="${test.failonerror}">
        <arg value="org.apache.commons.primitives.AllPrimitivesTestSuite"/>
        <classpath refid="test.classpath"/>
      </java>
    </target>
  
  </project>
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/LICENSE.txt
  
  Index: LICENSE.txt
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2003 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 acknowledgement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowledgement may appear in the software itself,
   *    if and wherever such third-party acknowledgements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", 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 names 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/>.
   */
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/.cvsignore
  
  Index: .cvsignore
  ===================================================================
  .classpath
  .project
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/project.properties
  
  Index: project.properties
  ===================================================================
  maven.checkstyle.properties=checkstyle.xml
  maven.junit.fork=true
  maven.xdoc.date = left
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/checkstyle.xml
  
  Index: checkstyle.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <!DOCTYPE module PUBLIC
      "-//Puppy Crawl//DTD Check Configuration 1.1//EN"
      "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">
  
  <!-- commons lang customization of default Checkstyle behavior -->
  <module name="Checker">
    <property name="basedir" value="."/>
    <property name="localeLanguage" value="en"/>
    <module name="PackageHtml"/>
    <module name="TreeWalker">
      <module name="TabCharacter"/>
      <module name="AvoidStarImport"/>
      <module name="RedundantImport"/>
      <module name="UnusedImports"/>
      <module name="NeedBraces"/>
      <module name="RedundantThrows">
        <property name="allowUnchecked" value="true"/>
      </module>
      <module name="LineLength">
        <property name="max" value="120"/>
      </module>
      <module name="JavadocMethod">
        <property name="allowUndeclaredRTE" value="true"/>
      </module>
   </module>
  </module>
                          
  
  
  
  
  1.1                  jakarta-commons-sandbox/primitives/src/conf/MANIFEST.MF
  
  Index: MANIFEST.MF
  ===================================================================
  Extension-Name: @name@
  Specification-Title: Jakarta Commons Primitives
  Specification-Vendor: Apache Software Foundation
  Specification-Version: 2.0
  Implementation-Vendor: Apache Software Foundation
  Implementation-Title: org.apache.commons.primitives
  Implementation-Version: @version@