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