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