xref: /aosp_15_r20/external/apache-commons-io/src/site/xdoc/upgradeto2_1.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>Upgrade from 2.0.1 to 2.1</title>
21  <author email="[email protected]">Commons Documentation Team</author>
22 </properties>
23<body>
24
25<section name="Upgrade">
26<p>
27These are the release notes and advice for upgrading Commons-IO from
28version 2.0.1 to version 2.1
29<source>
30Commons IO is a package of Java utility classes for java.io's hierarchy.
31Classes in this package are considered to be so standard and of such high
32reuse as to justify existence in java.io.
33
34Commons IO contains utility classes, stream implementations, file filters,
35file comparators and endian transformation classes.
36
37Compatibility with 2.0.1 and 1.4
38--------------------------------
39
40Binary compatible - Yes
41
42Source compatible - Yes
43
44Semantic compatible - Yes
45  Check the bug fixes section for semantic bug fixes
46
47Commons IO 2.1 requires a minimum of JDK 1.5
48  (Commons IO 1.4 had a minimum of JDK 1.3)
49
50
51New features since 2.0.1
52------------------------
53
54o Use standard Maven directory layout  Issue: IO-285. Thanks to ggregory.
55o Add IOUtils API toString for URL and URI to get contents  Issue: IO-284. Thanks to ggregory.
56o Add API FileUtils.copyFile(File input, OutputStream output)  Issue: IO-282. Thanks to ggregory.
57o FileAlterationObserver has no getter for FileFilter  Issue: IO-262.
58o Add FileUtils.getFile API with varargs parameter  Issue: IO-261.
59o Add new APPEND parameter for writing string into files  Issue: IO-182.
60o Add new read method "toByteArray" to handle InputStream with known size.  Issue: IO-251. Thanks to Marco Albini.
61
62Fixed Bugs since 2.0.1
63----------------------
64
65o Dubious use of mkdirs() return code  Issue: IO-280. Thanks to sebb.
66o ReaderInputStream enters infinite loop when it encounters an unmappable character  Issue: IO-277.
67o FileUtils.moveFile() Javadoc should specify FileExistsException thrown  Issue: IO-264.
68o ClassLoaderObjectInputStream does not handle Proxy classes  Issue: IO-260.
69o Tailer returning partial lines when reaching EOF before EOL  Issue: IO-274. Thanks to Frank Grimes.
70o FileUtils.copyFile() throws IOException when copying large files to a shared directory (on Windows)  Issue: IO-266. Thanks to Igor Smereka.
71o FileSystemUtils.freeSpaceKb throws exception for Windows volumes with no visible files.
72        Improve coverage by also looking for hidden files.  Issue: IO-263. Thanks to Gil Adam.
73
74Changes since 2.0.1
75-------------------
76o FileAlterationMonitor.stop(boolean allowIntervalToFinish)  Issue: IO-259.
77</source>
78</p>
79</section>
80
81</body>
82</document>
83