Skip to content

Commit 84a5fcf

Browse files
britterbritter
committed
Prepare release notes for Commons IO 2.6
1 parent a246ac8 commit 84a5fcf

1 file changed

Lines changed: 125 additions & 8 deletions

File tree

‎RELEASE-NOTES.txt‎

Lines changed: 125 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,133 @@
1-
2-
Apache Commons IO
3-
Version 2.5
4-
Release Notes
1+
Apache Commons IO
2+
Version 2.6
3+
Release Notes
54

65
INTRODUCTION:
76

8-
Commons IO is a package of Java utility classes like java.io.
9-
Classes in this package are considered to be so standard and of such high
7+
Apache Commons IO is a package of Java utility classes like java.io.
8+
Classes in this package are considered to be so standard and of such high
109
reuse as to justify existence in java.io.
1110

12-
The Apache Commons IO library contains utility classes, stream implementations, file filters,
13-
file comparators, endian transformation classes, and much more.
11+
The Apache Commons IO library contains utility classes, stream implementations,
12+
file filters, file comparators, endian transformation classes, and much more.
13+
14+
Apache Commons IO 2.6 requires at least Java 7 to build and run.
15+
16+
17+
DEPRECATIONS
18+
============
19+
20+
All closeQuietly overloads in org.apache.commons.io.IOUtils have been
21+
deprecated. Use the try-with-resources statement or handle suppressed
22+
exceptions manually.
23+
24+
The class org.apache.commons.io.FileSystemUtils has been deprecated.
25+
Use equivalent methods in java.nio.file.FileStore instead, e.g.
26+
Files.getFileStore(Paths.get("/home")).getUsableSpace() or iterate over
27+
FileSystems.getDefault().getFileStores().
28+
29+
30+
COMPATIBILITY WITH JAVA 9
31+
==================
32+
33+
The MANIFEST.MF now contains an additional entry:
34+
35+
Automatic-Module-Name: org.apache.commons.io
36+
37+
This should make it possible to use Commons IO 2.6 as a module in the Java 9
38+
module system. For more information see the corresponding issue:
39+
40+
https://issues.apache.org/jira/browse/IO-551
41+
42+
Building Commons IO 2.6 should work out of the box with the latest Java 9
43+
release. Please report any Java 9 related issues at:
44+
45+
https://issues.apache.org/jira/browse/IO
46+
47+
48+
NEW FEATURES
49+
============
50+
51+
o IO-551: Add Automatic-Module-Name MANIFEST entry for Java 9 compatibility.
52+
o IO-367: Add convenience methods for copyToDirectory. Thanks to James Sawle.
53+
o IO-493: Add infinite circular input stream. Thanks to Piotr Turski.
54+
o IO-507: Add a ByteOrderUtils class.
55+
o IO-518: Add ObservableInputStream.
56+
o IO-519: Add MessageDigestCalculatingInputStream.
57+
o IO-513: Add convenience methods for reading class path resources.
58+
Thanks to Behrang Saeedzadeh.
59+
60+
FIXED BUGS
61+
==========
62+
63+
o IO-546: ClosedOutputStream#flush should throw. Thanks to Tomas Celaya.
64+
o IO-550: Documentation issue, fix 404 Javadoc issues in the description page.
65+
Thanks to Jimi Adrian.
66+
o IO-442: Javadoc contradictory for FileFilterUtils.ageFileFilter(cutoff) and
67+
the filter it constructs: AgeFileFilter(cutoff).
68+
Thanks to Simon Robinson.
69+
o IO-534: FileUtilTestCase.testForceDeleteDir() should not delete testDirectory
70+
parent.
71+
o IO-528: Fix Tailer.run race condition runaway logging. Thanks to Dave Moten.
72+
o IO-483: getPrefixLength return -1 if unix file contains colon.
73+
Thanks to Marko Vasic.
74+
o IO-520: FileUtilsTestCase#testContentEqualsIgnoreEOL fails on Windows.
75+
o IO-516: .gitattributes not correctly applied. Thanks to Jason Pyeron.
76+
o IO-515: Allow Specifying Initial Buffer Size of DeferredFileOutputStream.
77+
Thanks to Brett Lounsbury, Gary Gregory.
78+
o IO-512: ThresholdingOutputStream.thresholdReached() results in
79+
FileNotFoundException. Thanks to Ralf Hauser.
80+
o IO-511: After a few unit tests, a few newly created directories not cleaned
81+
completely. Thanks to Ahmet Celik.
82+
o IO-502: Exceptions are suppressed incorrectly when copying files.
83+
Thanks to Christian Schulte.
84+
o IO-503: Update platform requirement to Java 7.
85+
o IO-537: BOMInputStream shouldn't sort array of BOMs in-place.
86+
Thanks to Borys Zibrov.
87+
88+
CHANGES
89+
=======
90+
91+
o IO-553: Make code style of hasBOM() consistent with getBOMCharsetName().
92+
Thanks to Michael Ernst.
93+
o IO-542: FileUtils#readFileToByteArray: optimize reading of files with known
94+
size. Thanks to Ilmars Poikans.
95+
o IO-547: Throw a IllegalArgumentException instead of NullPointerException in
96+
FileSystemUtils.freeSpaceWindows(). Thanks to Nikhil Shinde,
97+
Michael Ernst, Gary Greory.
98+
o IO-506: Deprecate methods FileSystemUtils.freeSpaceKb().
99+
Thanks to Christian Schulte.
100+
o IO-505: Make LineIterator implement Closeable to support try-with-resources
101+
statements. Thanks to Christian Schulte.
102+
o IO-504: Deprecated of all IOUtils.closeQuietly() methods and use
103+
try-with-resources internally. Thanks to Christian Schulte.
104+
105+
REMOVED
106+
=======
107+
108+
o IO-514: Remove org.apache.commons.io.Java7Support.
109+
110+
COMPATIBILITY WITH OLDER VERSIONS
111+
=================================
112+
113+
Compatibility with 2.5:
114+
Binary compatible: Yes.
115+
Source compatible: Yes.
116+
Semantic compatible: Yes.
117+
118+
Compatibility with 2.6 and 1.4:
119+
Binary compatible: Yes.
120+
Source compatible: No, see the rare case in
121+
https://issues.apache.org/jira/browse/IO-318.
122+
Semantic compatible: No, see the rare case in
123+
https://issues.apache.org/jira/browse/IO-318.
124+
125+
Commons IO 2.6 requires JDK 1.7 or later.
126+
Commons IO 2.5 requires JDK 1.6 or later.
127+
Commons IO 2.4 requires JDK 1.6 or later.
128+
Commons IO 2.3 requires JDK 1.6 or later.
129+
Commons IO 2.2 requires JDK 1.5 or later.
130+
Commons IO 1.4 requires JDK 1.3 or later.
14131

15132
==============================================================================
16133
Apache Commons IO Version 2.5

0 commit comments

Comments
 (0)