xref: /aosp_15_r20/external/apache-commons-io/src/site/xdoc/index.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>Commons IO Overview</title>
21    <author email="[email protected]">Commons Documentation Team</author>
22  </properties>
23  <body>
24    <!-- ================================================== -->
25    <section name="Apache Commons IO">
26      <p>
27        Apache Commons IO is a library of utilities to assist with developing IO functionality.
28      </p>
29      <p>
30        There are six main areas included:
31      </p>
32      <ul>
33        <li>
34          <a href="apidocs/index.html?org/apache/commons/io/package-summary.html">io</a>
35          - This package defines utility classes for working with streams, readers, writers and files.
36        </li>
37        <li>
38          <a href="apidocs/index.html?org/apache/commons/io/build/package-summary.html">build</a>
39          - This package provides classes to implement IO builders.
40        </li>
41        <li>
42          <a href="apidocs/index.html?org/apache/commons/io/charset/package-summary.html">charset</a>
43          - This package provides classes to work with code from <code>java.nio.charset</code>.
44        </li>
45        <li>
46          <a href="apidocs/index.html?org/apache/commons/io/comparator/package-summary.html">comparator</a>
47          - This package provides various Comparator implementations for Files and Paths.
48        </li>
49        <li>
50          <a href="apidocs/index.html?org/apache/commons/io/file/package-summary.html">file</a>
51          - This package provides extensions in the realm of java.nio.file.
52        </li>
53        <li>
54          <a href="apidocs/index.html?org/apache/commons/io/file/attribute/package-summary.html">file.attribute</a>
55          - This package provides help using <code>java.nio.file.attribute</code> types.
56        </li>
57        <li>
58          <a href="apidocs/index.html?org/apache/commons/io/file/spi/package-summary.html">file SPI</a>
59          - This package provides extensions in the realm of <code>java.nio.file.spi</code>.
60        </li>
61        <li>
62          <a href="apidocs/index.html?org/apache/commons/io/filefilter/package-summary.html">filefilter</a>
63          - This package defines an interface (IOFileFilter) that combines both FileFilter and FilenameFilter.
64        </li>
65        <li>
66          <a href="apidocs/index.html?org/apache/commons/io/function/package-summary.html">function</a>
67          - This package defines IO-only related functional interfaces for lambda expressions and method references.
68        </li>
69        <li>
70          <a href="apidocs/index.html?org/apache/commons/io/input/package-summary.html">input</a>
71          - This package provides implementations of input classes, such as InputStream and Reader.
72        </li>
73        <li>
74          <a href="apidocs/index.html?org/apache/commons/io/input/buffer/package-summary.html">input.buffer</a>
75          - This package provides implementations of buffered input classes, such as CircularBufferInputStream and PeekableInputStream.
76        </li>
77        <li>
78          <a href="apidocs/index.html?org/apache/commons/io/monitor/package-summary.html">monitor</a>
79          - This package provides a component for monitoring file system events (directory and file create, update and delete events).
80        </li>
81        <li>
82          <a href="apidocs/index.html?org/apache/commons/io/output/package-summary.html">output</a>
83          - This package provides implementations of output classes, such as OutputStream and Writer.
84        </li>
85        <li>
86          <a href="apidocs/index.html?org/apache/commons/io/serialization/package-summary.html">serialization</a>
87          - This package provides a framework for controlling the deserialization of classes.
88        </li>
89      </ul>
90    </section>
91    <!-- ================================================== -->
92    <section name="Releases">
93
94      <subsection name="Latest Release (Java 8 and up)">
95        <p>
96          Commons IO 2.13.0 requires a minimum of Java 8 -
97          <a href="https://commons.apache.org/io/download_io.cgi">Download now</a>
98          .
99        </p>
100        <p>
101          View the
102          <a href="changes-report.html">Release Notes</a>
103          and
104          <a href="apidocs/index.html">Javadoc API documents</a>
105          .
106        </p>
107      </subsection>
108
109      <subsection name="Previous Releases">
110        <p>
111          See the
112          <a href="https://archive.apache.org/dist/commons/io/">download archive</a>
113          and
114          <a href="https://javadoc.io/doc/commons-io/commons-io/">Javadoc archive</a>
115          .
116        </p>
117        <p>
118          The Java platform requirements are:
119        </p>
120        <ul>
121          <li>Version 2.7 and up requires Java 8.</li>
122          <li>Version 2.6 requires Java 7.</li>
123          <li>Version 2.3 through 2.5 requires Java 6.</li>
124          <li>Version 2.2 requires Java 5.</li>
125        </ul>
126      </subsection>
127
128    </section>
129    <!-- ================================================== -->
130    <section name="Support">
131      <p>
132        The
133        <a href="mail-lists.html">commons mailing lists</a>
134        act as the main support forum.
135        The user list is suitable for most library usage queries.
136        The dev list is intended for the development discussion.
137        Please remember that the lists are shared between all commons components,
138        so prefix your email by [io].
139      </p>
140      <p>
141        Issues may be reported via
142        <a href="issue-tracking.html">ASF JIRA</a>
143        .
144        Please read the instructions carefully to submit a useful bug report or enhancement request.
145      </p>
146    </section>
147    <!-- ================================================== -->
148  </body>
149</document>
150