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