xref: /aosp_15_r20/external/apache-commons-io/PROPOSAL.html (revision 0c4d7b72e49a04598d65c566f44504b95342d75a)
1*0c4d7b72SSadaf Ebrahimi<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2*0c4d7b72SSadaf Ebrahimi<!--
3*0c4d7b72SSadaf Ebrahimi   Licensed to the Apache Software Foundation (ASF) under one or more
4*0c4d7b72SSadaf Ebrahimi   contributor license agreements.  See the NOTICE file distributed with
5*0c4d7b72SSadaf Ebrahimi   this work for additional information regarding copyright ownership.
6*0c4d7b72SSadaf Ebrahimi   The ASF licenses this file to You under the Apache License, Version 2.0
7*0c4d7b72SSadaf Ebrahimi   (the "License"); you may not use this file except in compliance with
8*0c4d7b72SSadaf Ebrahimi   the License.  You may obtain a copy of the License at
9*0c4d7b72SSadaf Ebrahimi
10*0c4d7b72SSadaf Ebrahimi       http://www.apache.org/licenses/LICENSE-2.0
11*0c4d7b72SSadaf Ebrahimi
12*0c4d7b72SSadaf Ebrahimi   Unless required by applicable law or agreed to in writing, software
13*0c4d7b72SSadaf Ebrahimi   distributed under the License is distributed on an "AS IS" BASIS,
14*0c4d7b72SSadaf Ebrahimi   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15*0c4d7b72SSadaf Ebrahimi   See the License for the specific language governing permissions and
16*0c4d7b72SSadaf Ebrahimi   limitations under the License.
17*0c4d7b72SSadaf Ebrahimi-->
18*0c4d7b72SSadaf Ebrahimi<html>
19*0c4d7b72SSadaf Ebrahimi<head>
20*0c4d7b72SSadaf Ebrahimi  <title>Proposal for IO Package</title>
21*0c4d7b72SSadaf Ebrahimi</head>
22*0c4d7b72SSadaf Ebrahimi <body bgcolor="white">
23*0c4d7b72SSadaf Ebrahimi
24*0c4d7b72SSadaf Ebrahimi<div align="center">
25*0c4d7b72SSadaf Ebrahimi<h1>Proposal for <em>IO</em> Package</h1>
26*0c4d7b72SSadaf Ebrahimi </div>
27*0c4d7b72SSadaf Ebrahimi
28*0c4d7b72SSadaf Ebrahimi<h3>(0) Rationale</h3>
29*0c4d7b72SSadaf Ebrahimi
30*0c4d7b72SSadaf Ebrahimi<p>Many software projects have a need to perform I/O in various ways, and
31*0c4d7b72SSadaf Ebrahimithe JDK class libraries provide a lot of functionality, but sometimes you
32*0c4d7b72SSadaf Ebrahimineed just a little bit more.  The io package seeks to  encapsulate some of
33*0c4d7b72SSadaf Ebrahimithe most popular i/o base classes into one easy to  use package.</p>
34*0c4d7b72SSadaf Ebrahimi
35*0c4d7b72SSadaf Ebrahimi<h3>(1) Scope of the Package</h3>
36*0c4d7b72SSadaf Ebrahimi
37*0c4d7b72SSadaf Ebrahimi<p>This proposal is to create a package of Java utility classes for  various
38*0c4d7b72SSadaf Ebrahimitypes of i/o related activity.</p>
39*0c4d7b72SSadaf Ebrahimi
40*0c4d7b72SSadaf Ebrahimi<h3>(1.5) Interaction With Other Packages</h3>
41*0c4d7b72SSadaf Ebrahimi
42*0c4d7b72SSadaf Ebrahimi<p><em>IO</em> relies only on standard JDK 1.2 (or later) APIs for production
43*0c4d7b72SSadaf Ebrahimideployment.  It utilizes the JUnit unit testing framework for developing
44*0c4d7b72SSadaf Ebrahimiand executing unit tests, but this is of interest only to developers of the
45*0c4d7b72SSadaf Ebrahimicomponent.  IO will be a dependency for several existing components in the
46*0c4d7b72SSadaf Ebrahimiopen source world.</p>
47*0c4d7b72SSadaf Ebrahimi
48*0c4d7b72SSadaf Ebrahimi<p>No external configuration files are utilized.</p>
49*0c4d7b72SSadaf Ebrahimi
50*0c4d7b72SSadaf Ebrahimi<h3>(2) Initial Source of the Package</h3>
51*0c4d7b72SSadaf Ebrahimi
52*0c4d7b72SSadaf Ebrahimi<p>The original Java classes are splashed around various Apache  subprojects.
53*0c4d7b72SSadaf Ebrahimi We intend to seek them out and integrate them.</p>
54*0c4d7b72SSadaf Ebrahimi
55*0c4d7b72SSadaf Ebrahimi<p>The proposed package name for the new component is <code>org.apache.commons.io</code>.</p>
56*0c4d7b72SSadaf Ebrahimi
57*0c4d7b72SSadaf Ebrahimi<h3>(3)  Required Jakarta-Commons Resources</h3>
58*0c4d7b72SSadaf Ebrahimi
59*0c4d7b72SSadaf Ebrahimi<ul>
60*0c4d7b72SSadaf Ebrahimi <li>CVS Repository - New directory <code>io</code> in the     <code>jakarta-commons</code>
61*0c4d7b72SSadaf EbrahimiCVS repository.</li>
62*0c4d7b72SSadaf Ebrahimi <li>Mailing List - Discussions will take place on the general     <em>[email protected]</em>
63*0c4d7b72SSadaf Ebrahimimailing list.  To help     list subscribers identify messages of interest,
64*0c4d7b72SSadaf Ebrahimiit is suggested that     the message subject of messages about this component
65*0c4d7b72SSadaf Ebrahimibe prefixed with     [IO].</li>
66*0c4d7b72SSadaf Ebrahimi <li>Bugzilla - New component "IO" under the "Commons" product     category,
67*0c4d7b72SSadaf Ebrahimiwith appropriate version identifiers as needed.</li>
68*0c4d7b72SSadaf Ebrahimi <li>Jyve FAQ - New category "commons-io" (when available).</li>
69*0c4d7b72SSadaf Ebrahimi
70*0c4d7b72SSadaf Ebrahimi</ul>
71*0c4d7b72SSadaf Ebrahimi
72*0c4d7b72SSadaf Ebrahimi<h3>(4) Initial Committers</h3>
73*0c4d7b72SSadaf Ebrahimi
74*0c4d7b72SSadaf Ebrahimi<p>The initial committers on the IO component shall be Scott Sanders and
75*0c4d7b72SSadaf EbrahimiNicola Ken Barozzi and Henri Yandell</p>
76*0c4d7b72SSadaf Ebrahimi    <br>
77*0c4d7b72SSadaf Ebrahimi</body>
78*0c4d7b72SSadaf Ebrahimi</html>
79