xref: /aosp_15_r20/external/apache-commons-io/src/site/xdoc/upgradeto2_4.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>Upgrade from 2.3 to 2.4</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="Upgrade">
26*0c4d7b72SSadaf Ebrahimi<p>
27*0c4d7b72SSadaf EbrahimiThese are the release notes and advice for upgrading Commons-IO from
28*0c4d7b72SSadaf Ebrahimiversion 2.3 to version 2.4
29*0c4d7b72SSadaf Ebrahimi<source>
30*0c4d7b72SSadaf EbrahimiCommons IO is a package of Java utility classes like java.io.
31*0c4d7b72SSadaf EbrahimiClasses in this package are considered to be so standard and of such high
32*0c4d7b72SSadaf Ebrahimireuse as to justify existence in java.io.
33*0c4d7b72SSadaf Ebrahimi
34*0c4d7b72SSadaf EbrahimiThe Commons IO library contains utility classes, stream implementations, file filters,
35*0c4d7b72SSadaf Ebrahimifile comparators, endian transformation classes, and much more.
36*0c4d7b72SSadaf Ebrahimi
37*0c4d7b72SSadaf Ebrahimi==============================================================================
38*0c4d7b72SSadaf EbrahimiApache Commons IO Version 2.4-SNAPSHOT
39*0c4d7b72SSadaf Ebrahimi==============================================================================
40*0c4d7b72SSadaf Ebrahimi
41*0c4d7b72SSadaf EbrahimiChanges in this version include:
42*0c4d7b72SSadaf Ebrahimi
43*0c4d7b72SSadaf EbrahimiNew features:
44*0c4d7b72SSadaf Ebrahimio IO-269:  Tailer locks file from deletion/rename on Windows. Thanks to sebb.
45*0c4d7b72SSadaf Ebrahimio IO-333:  Export OSGi packages at version 1.x in addition to 2.x. Thanks to fmeschbe.
46*0c4d7b72SSadaf Ebrahimio IO-320:  Add XmlStreamReader support for UTF-32. Thanks to ggregory.
47*0c4d7b72SSadaf Ebrahimio IO-331:  BOMInputStream wrongly detects UTF-32LE_BOM files as UTF-16LE_BOM files in method getBOM(). Thanks to ggregory.
48*0c4d7b72SSadaf Ebrahimio IO-327:  Add byteCountToDisplaySize(BigInteger). Thanks to ggregory.
49*0c4d7b72SSadaf Ebrahimio IO-326:  Add new FileUtils.sizeOf[Directory] APIs to return BigInteger. Thanks to ggregory.
50*0c4d7b72SSadaf Ebrahimio IO-325:  Add IOUtils.toByteArray methods to work with URL and URI. Thanks to raviprak.
51*0c4d7b72SSadaf Ebrahimio IO-324:  Add missing Charset sister APIs to method that take a String charset name. Thanks to raviprak.
52*0c4d7b72SSadaf Ebrahimi
53*0c4d7b72SSadaf EbrahimiFixed Bugs:
54*0c4d7b72SSadaf Ebrahimio IO-279:  Tailer erroneously considers file as new. Thanks to Sergio Bossa, Chris Baron.
55*0c4d7b72SSadaf Ebrahimio IO-335:  Tailer#readLines - incorrect CR handling.
56*0c4d7b72SSadaf Ebrahimio IO-334:  FileUtils.toURLs throws NPE for null parameter; document the behavior.
57*0c4d7b72SSadaf Ebrahimio IO-332:  Improve tailer's reading performance. Thanks to liangly.
58*0c4d7b72SSadaf Ebrahimio IO-279:  Improve Tailer performance with buffered reads (see IO-332).
59*0c4d7b72SSadaf Ebrahimio IO-329:  FileUtils.writeLines uses unbuffered IO. Thanks to tivv.
60*0c4d7b72SSadaf Ebrahimio IO-319:  FileUtils.sizeOfDirectory follows symbolic links. Thanks to raviprak.
61*0c4d7b72SSadaf Ebrahimi
62*0c4d7b72SSadaf EbrahimiCompatibility with 2.3:
63*0c4d7b72SSadaf EbrahimiBinary compatible: Yes.
64*0c4d7b72SSadaf EbrahimiSource compatible: Yes.
65*0c4d7b72SSadaf EbrahimiSemantic compatible: Yes.
66*0c4d7b72SSadaf Ebrahimi
67*0c4d7b72SSadaf EbrahimiCompatibility with 2.2 and 1.4:
68*0c4d7b72SSadaf EbrahimiBinary compatible: Yes.
69*0c4d7b72SSadaf EbrahimiSource compatible: No, see the rare case in https://issues.apache.org/jira/browse/IO-318.
70*0c4d7b72SSadaf EbrahimiSemantic compatible: No, see the rare case in https://issues.apache.org/jira/browse/IO-318.
71*0c4d7b72SSadaf Ebrahimi
72*0c4d7b72SSadaf EbrahimiCommons IO 2.4 requires JDK 1.6 or later.
73*0c4d7b72SSadaf EbrahimiCommons IO 2.3 requires JDK 1.6 or later.
74*0c4d7b72SSadaf EbrahimiCommons IO 2.2 requires JDK 1.5 or later.
75*0c4d7b72SSadaf EbrahimiCommons IO 1.4 requires JDK 1.3 or later.
76*0c4d7b72SSadaf Ebrahimi</source>
77*0c4d7b72SSadaf Ebrahimi</p>
78*0c4d7b72SSadaf Ebrahimi</section>
79*0c4d7b72SSadaf Ebrahimi
80*0c4d7b72SSadaf Ebrahimi</body>
81*0c4d7b72SSadaf Ebrahimi</document>
82