commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sand...@apache.org
Subject cvs commit: jakarta-commons-sandbox/codec .cvsignore PROPOSAL.html RELEASE-NOTES.txt STATUS.html
Date Thu, 24 Jan 2002 05:25:20 GMT
sanders     02/01/23 21:25:20

  Added:       codec    .cvsignore PROPOSAL.html RELEASE-NOTES.txt
                        STATUS.html
  Log:
  Initial Proposal and status files
  
  Revision  Changes    Path
  1.1                  jakarta-commons-sandbox/codec/.cvsignore
  
  Index: .cvsignore
  ===================================================================
  build.properties
  dist
  target
  codec.ipr
  
  
  1.1                  jakarta-commons-sandbox/codec/PROPOSAL.html
  
  Index: PROPOSAL.html
  ===================================================================
  <html>
  <head>
  <title>Proposal for Codec Package</title>
  </head>
  <body bgcolor="white">
  
  <div align="center">
  <h1>Proposal for <em>Codec</em> Package</h1>
  </div>
  
  <h3>(0) Rationale</h3>
  
  <p>Many software projects have a need to use various formats of data, and to
  be able to switch between various formats.  The codec package seeks to 
  encapsulate some of the most popular encode/decode algorithms in one easy
  to use, well tested package.  A base64 codec is the first candidate, with 
  others to follow soon.</p>
  
  
  <h3>(1) Scope of the Package</h3>
  
  <p>This proposal is to create a package of Java utility classes for the
  encoding/decoding of various types of data. A base64 codec will be the
  first implementation.</p>
  
  
  <h3>(1.5) Interaction With Other Packages</h3>
  
  <p><em>Codec</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.  Codec will be a dependency for
  several existing components in the open source world.</p>
  
  <p>No external configuration files are utilized.</p>
  
  
  <h3>(2) Initial Source of the Package</h3>
  
  <p>The original Java classes (<code>Base64</code>, etc.) are splashed
around
  various Apache subprojects.  We intend to seek them out and integrate them.</p>
  
  <p>The proposed package name for the new component is
  <code>org.apache.commons.codec</code>.</p>
  
  
  <h3>(3)  Required Jakarta-Commons Resources</h3>
  
  <ul>
  <li>CVS Repository - New directory <code>codec</code> in the
      <code>jakarta-commons</code> CVS repository.</li>
  <li>Mailing List - Discussions will take place on the general
      <em>jakarta-commons@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
      [Codec].</li>
  <li>Bugzilla - New component "Codec" under the "Commons" product
      category, with appropriate version identifiers as needed.</li>
  <li>Jyve FAQ - New category "commons-codec" (when available).</li>
  </ul>
  
  
  <h3>(4) Initial Committers</h3>
  
  <p>The initial committers on the BeanUtils component shall be Scott Sanders
  and ???(Your name here)</p>
  
  
  
  </body>
  </html>
  
  
  
  1.1                  jakarta-commons-sandbox/codec/RELEASE-NOTES.txt
  
  Index: RELEASE-NOTES.txt
  ===================================================================
  $Id: RELEASE-NOTES.txt,v 1.1 2002/01/24 05:25:20 sanders Exp $
  
  			Commons Codec Package
  			   Version 1.0-dev
  			    Release Notes
  
  
  INTRODUCTION:
  
  This document contains the release notes for this version of the Commons
  Codec package, and highlights changes since the previous version.  The
  current release adds new features and bug fixes, and is being done now to
  follow the release early/release often mentality.
  
  
  NEW FEATURES:
  
  * Base64 class from commons-httpclient in org.apache.commons.codec.base64
  
  
  BUG FIXES:
  
  
  
  
  
  1.1                  jakarta-commons-sandbox/codec/STATUS.html
  
  Index: STATUS.html
  ===================================================================
  <html>
  <head>
  <title>Status File for Jakarta Commons "Codec" Component</title>
  </head>
  <body bgcolor="white">
  
  
  <div align="center">
  <h1>The Jakarta Commons <em>Codec</em> Component</h1>
  $Id: STATUS.html,v 1.1 2002/01/24 05:25:20 sanders 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>Codec</em> Component contains a set of Java classes that provide
  encode/decode functionality and helper methods for various data formats.  
  The following classes are included:</p>
  <ul>
  <li><strong>Base64</strong> - Encoding/decoding of the popular base64
format.</li>
  </ul>
  
  
  <a name="Dependencies"></a>
  <h3>2.  DEPENDENCIES</h3>
  
  <p>The <em>Codec</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: Codec 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>Codec</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><a href="mailto:sanders@apache.org">Scott Sanders</a></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.3
  release of this component:</p>
  
  <table border="1">
  
    <tr>
      <th width="80%">Action Item</th>
      <th width="20%">Volunteer</th>
    </tr>
  
    <tr>
      <td><strong>Integration</strong>.  Seek and integrate various codec
related classes.</td>
      <td align="center">Everyone</td>
    </tr>
  
    <tr>
      <td><strong>Install / Use Documentation</strong>.  Create simple
          installation and User's Guide documentation for this component.</td>
      <td align="center">scott</td>
    </tr>
  
  </table>
  
  </body>
  </html>
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message