Release notes for 2.2.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1301334 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

RELEASE-NOTES.txt

@@ -4,7 +4,6 @@ $Id$
 			    Version 2.1
 			   Release Notes
 
-
 INTRODUCTION:
 
 Commons IO is a package of Java utility classes for java.io's hierarchy.  
@@ -14,6 +13,36 @@ reuse as to justify existence in java.io.
 Commons IO contains utility classes, stream implementations, file filters, 
 file comparators and endian transformation classes.
 
+==============================================================================
+Commons IO Package Version 2.2
+==============================================================================
+
+New features:
+o Use terabyte (TB) , petabyte (PB) and exabyte (EB) in FileUtils.byteCountToDisplaySize(long size)  Issue: IO-287. Thanks to Ron Kuris, Gary Gregory. 
+o FileUtils.listFiles() doesn't return directories  Issue: IO-173. Thanks to Marcos Vin�cius da Silva. 
+o CharSequenceInputStream to efficiently stream content of a CharSequence  Issue: IO-297. Thanks to Oleg Kalnichevski. 
+o The second constructor of Tailer class does not pass 'delay' to the third one  Issue: IO-304. Thanks to liangly. 
+o TeeOutputStream does not call branch.close() when main.close() throws an exception  Issue: IO-303. Thanks to fabian.barney. 
+o ArrayIndexOutOfBoundsException in BOMInputStream when reading a file without BOM multiple times  Issue: IO-302. Thanks to jsteuerwald, detinho. 
+o Add IOUtils.closeQuietly(Selector) necessary  Issue: IO-301. Thanks to kaykay.unique. 
+o IOUtils.closeQuietly() should take a ServerSocket as a parameter  Issue: IO-292. Thanks to sebb. 
+o Add read/readFully methods to IOUtils  Issue: IO-290. Thanks to sebb. 
+o Supply a ReversedLinesFileReader  Issue: IO-288. Thanks to Georg Henzler. 
+o Add new function FileUtils.directoryContains.  Issue: IO-291. Thanks to ggregory. 
+o FileUtils.contentEquals and IOUtils.contentEquals - Add option to ignore "line endings"
+        Added contentEqualsIgnoreEOL methods to both classes  Issue: IO-275. Thanks to CJ Aspromgos. 
+
+Fixed Bugs:
+o FileUtils.moveDirectoryToDirectory removes source directory if destination is a subdirectory  Issue: IO-300. 
+o ReaderInputStream#read(byte[] b, int off, int len) should check for valid parameters  Issue: IO-307. 
+o ReaderInputStream#read(byte[] b, int off, int len) should always return 0 for length == 0  Issue: IO-306. 
+o "FileUtils#deleteDirectoryOnExit(File)" does not work  Issue: IO-276. Thanks to nkami. 
+o BoundedInputStream.read() treats max differently from BoundedInputStream.read(byte[]...)  Issue: IO-273. Thanks to sebb. 
+o Various methods of class 'org.apache.commons.io.FileUtils' incorrectly suppress 'java.io.IOException'  Issue: IO-298. Thanks to Christian Schulte. 
+
+Changes:
+o ReaderInputStream optimization: more efficient reading of small chunks of data  Issue: IO-296. Thanks to Oleg Kalnichevski. 
+
 ==============================================================================
 Commons IO Package Version 2.1
 ==============================================================================
@@ -40,7 +69,6 @@ o FileSystemUtils.freeSpaceKb throws exception for Windows volumes with no visib
 Changes:
 o FileAlterationMonitor.stop(boolean allowIntervalToFinish)  Issue: IO-259. 
 
-
 ==============================================================================
 Commons IO Package Version 2.0.1
 ==============================================================================
@@ -57,13 +85,11 @@ Semantic compatible - Yes
 Commons IO 2.0.1 requires a minimum of JDK 1.5
  (Commons IO 1.4 had a minimum of JDK 1.3) 
 
-
 Enhancements from 2.0
 ---------------------
 
    * [IO-256] - Provide thread factory for FileAlternationMonitor
 
-
 Bug fixes from 2.0
 ------------------
 
@@ -86,7 +112,6 @@ Semantic compatible - Yes
 Commons IO 2.0 requires a minimum of JDK 1.5
  (Commons IO 1.4 had a minimum of JDK 1.3) 
 
-
 Deprecations from 1.4
 ---------------------
 
@@ -99,7 +124,6 @@ Deprecations from 1.4
   - andFileFilter(IOFileFilter, IOFileFilter) in favour of and(IOFileFilter...) 
   - orFileFilter(IOFileFilter, IOFileFilter)  in favour of or(IOFileFilter...)
 
-
 Enhancements from 1.4
 ---------------------
 
@@ -145,7 +169,6 @@ Enhancements from 1.4
   * [IO-211] Proxy Input/Output streams - add pre/post processing support
   * [IO-242] Proxy Reader/Writer - add pre/post processing support
 
-
 Bug fixes from 1.4
 ------------------
   * [IO-214] ByteArrayOutputStream - fix inconsistent synchronization of fields
@@ -174,7 +197,6 @@ Bug fixes from 1.4
   * [IO-235] Tests - remove unused YellOnFlushAndCloseOutputStream from CopyUtilsTest
   * [IO-161] Tests - fix FileCleaningTrackerTestCase hanging
 
-
 Documentation changes from 1.4
 ------------------------------
   * [IO-183 FilenameUtils.getExtension() method documentation improvements
@@ -207,12 +229,10 @@ Commons IO 1.4 introduces four new implementations which depend on JDK 1.4 featu
 It has been built with the JDK source and target options set to JDK 1.3 and, except for
 those implementations, can be used with JDK 1.3 (see IO IO-127).
 
-
 Deprecations from 1.3.2
 -----------------------
 - FileCleaner deprecated in favour of FileCleaningTracker [see IO-116]
 
-
 Bug fixes from 1.3.2
 --------------------
 - FileUtils
@@ -225,7 +245,6 @@ Bug fixes from 1.3.2
 - HexDump
   - HexDump's use of static StringBuffers isn't thread-safe [IO-136]
 
-
 Enhancements from 1.3.2
 -----------------------
 - FileUtils
@@ -293,7 +312,6 @@ Enhancements from 1.3.2
   - PathFileComparator - compares files using file paths.
   - SizeFileComparator - compares files using file sizes.
 
-  
 ==============================================================================
 Commons IO Package Version 1.3.2
 ==============================================================================
@@ -306,7 +324,6 @@ Source compatible - Yes
 
 Semantic compatible - Yes
 
-
 Compatibility with 1.3
 ----------------------
 Binary compatible - No
@@ -317,15 +334,13 @@ Source compatible - No
 
 Semantic compatible - Yes
 
-
 Enhancements since 1.3.1
 ------------------------
 
 - Created the FileCleaningTracker, basically a non-static version of the
   FileCleaner, which can be controlled by the user. [IO-116]
 - The FileCleaner is deprecated.
 
-
 Bug fixes from 1.3.1
 --------------------
 
@@ -335,15 +350,13 @@ Bug fixes from 1.3.1
   - Both readSwappedUnsignedInteger(...) methods could return negative 
     numbers due to int/long casting. [IO-117]
 
-
 Bug fixes from 1.3
 ------------------
 
 - FileUtils
   - NPE in openOutputStream(File) when file has no parent in path [IO-112]
   - readFileToString(File) is not static [IO-113]
 
-
 ==============================================================================
 Commons IO Package Version 1.3.1
 ==============================================================================
@@ -358,15 +371,13 @@ Source compatible - No
 
 Semantic compatible - Yes
 
-
 Bug fixes from 1.3
 ------------------
 
 - FileUtils
   - NPE in openOutputStream(File) when file has no parent in path [IO-112]
   - readFileToString(File) is not static [IO-113]
 
-  
 ==============================================================================
 Commons IO Package Version 1.3
 ==============================================================================
@@ -380,7 +391,6 @@ Source compatible - Yes
 Semantic compatible - Yes
   Check the bug fixes section for semantic bug fixes
 
-
 Deprecations from 1.2
 ---------------------
 - WildcardFilter deprecated, replaced by WildcardFileFilter
@@ -392,7 +402,6 @@ Deprecations from 1.2
   - freeSpaceKb returns much better and more consistent results
   - freeSpaceKb existed in v1.2, so this is a gentle cutover
 
-
 Bug fixes from 1.2
 ------------------
 - LineIterator now implements Iterator
@@ -556,7 +565,6 @@ Enhancements from 1.2
 - ByteArrayOutputStream  [IO-97]
   - Performance enhancements
 
-
 ==============================================================================
 Commons IO Package Version 1.2
 ==============================================================================
@@ -569,11 +577,9 @@ Source compatible - Yes
 
 Semantic compatible - Yes
 
-
 Deprecations from 1.1
 ---------------------
 
-
 Bug fixes from 1.1
 ------------------
 - FileSystemUtils.freeSpace(drive)
@@ -586,7 +592,6 @@ Bug fixes from 1.1
   Locking mechanism was broken and only provided limited protection [38942]
   File deletion and locking in case of constructor error was broken
 
-
 Enhancements from 1.1
 ---------------------
 - AgeFileFilter/SizeFileFilter
@@ -608,7 +613,6 @@ Enhancements from 1.1
 - FileUtils.copyDirectoryToDirectory
   New method to copy a directory to within another directory [36315]
 
-  
 ==============================================================================
 Commons IO Package Version 1.1
 ==============================================================================
@@ -637,7 +641,6 @@ plus these bug fixes may affect you semantically:
 - FileUtils.sizeOfDirectory()  (Bug fix 36801)
     May now return a size of 0 if the directory is security restricted
 
-
 Deprecations from 1.0
 ---------------------
 - CopyUtils has been deprecated.
@@ -648,7 +651,6 @@ Deprecations from 1.0
 - IOUtils.toString(byte[]) - Use {@link String#String(byte[])}
 - IOUtils.toString(byte[],String) - Use {@link String#String(byte[],String)}
 
-
 Bug fixes from 1.0
 ------------------
 - FileUtils - touch()  [29821]
@@ -679,7 +681,6 @@ Bug fixes from 1.0
 - FileUtils - writeStringToFile()
     Null encoding now correctly uses the platform default
 
-
 Enhancements from 1.0
 ---------------------
 - FilenameUtils - new class  [33303,29351]
@@ -776,8 +777,7 @@ Enhancements from 1.0
     Create directories if necesssary
 
 - IOUtils and EndianUtils are no longer final  [28978]
-    Allows developers to have subclasses if desired
-    
+    Allows developers to have subclasses if desired   
 
 ==============================================================================
 Feedback