@SInCE Commons IO 2.0 tags

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

Author: Niall Pemberton

src/java/org/apache/commons/io/DirectoryWalker.java

@@ -514,6 +514,7 @@ protected void handleDirectoryStart(File directory, int depth, Collection<T> res
      * @param files the files (possibly filtered) in the directory
      * @return the filtered list of files
      * @throws IOException if an I/O Error occurs
+     * @since Commons IO 2.0
      */
     protected File[] filterDirectoryContents(File directory, int depth, File[] files) throws IOException {
         return files;

src/java/org/apache/commons/io/FileSystemUtils.java

@@ -216,6 +216,7 @@ public static long freeSpaceKb(String path, long timeout) throws IOException {
      * @return the amount of free drive space on the drive or volume in kilobytes
      * @throws IllegalStateException if an error occurred in initialisation
      * @throws IOException if an error occurs when finding the free space
+     * @since Commons IO 2.0
      */
     public static long freeSpaceKb() throws IOException {
         return freeSpaceKb(-1); 

src/java/org/apache/commons/io/FileUtils.java

@@ -1495,7 +1495,7 @@ public static void writeStringToFile(File file, String data) throws IOException
      * @param file  the file to write
      * @param data  the content to write to the file
      * @throws IOException in case of an I/O error
-     * @since IO 2.0
+     * @since Commons IO 2.0
      */
     public static void write(File file, CharSequence data) throws IOException {
         String str = data == null ? null : data.toString();
@@ -1510,7 +1510,7 @@ public static void write(File file, CharSequence data) throws IOException {
      * @param encoding  the encoding to use, <code>null</code> means platform default
      * @throws IOException in case of an I/O error
      * @throws java.io.UnsupportedEncodingException if the encoding is not supported by the VM
-     * @since IO 2.0
+     * @since Commons IO 2.0
      */
     public static void write(File file, CharSequence data, String encoding) throws IOException {
         String str = data == null ? null : data.toString();
@@ -2184,7 +2184,7 @@ public static void moveToDirectory(File src, File destDir, boolean createDestDir
      * @param file the file to check
      * @return true if the file is a Symbolic Link
      * @throws IOException if an IO error occurs while checking the file
-     * @since IO 2.0
+     * @since Commons IO 2.0
      */
     public static boolean isSymlink(File file) throws IOException {
         if (file == null) {

src/java/org/apache/commons/io/FilenameUtils.java

@@ -242,8 +242,9 @@ public static String normalize(String filename) {
      *
      * @param filename  the filename to normalize, null returns null
      * @param unixSeparator <code>true</code> if a unix separator should
-     * be used or <code>false</code> if a windows separtor should be used.
+     * be used or <code>false</code> if a windows separator should be used.
      * @return the normalized filename, or null if invalid
+     * @since Commons IO 2.0
      */
     public static String normalize(String filename, boolean unixSeparator) {
         char separator = (unixSeparator ? UNIX_SEPARATOR : WINDOWS_SEPARATOR);
@@ -337,6 +338,7 @@ public static String normalizeNoEndSeparator(String filename) {
      * @param unixSeparator <code>true</code> if a unix separator should
      * be used or <code>false</code> if a windows separtor should be used.
      * @return the normalized filename, or null if invalid
+     * @since Commons IO 2.0
      */
     public static String normalizeNoEndSeparator(String filename, boolean unixSeparator) {
          char separator = (unixSeparator ? UNIX_SEPARATOR : WINDOWS_SEPARATOR);

src/java/org/apache/commons/io/IOCase.java

@@ -213,7 +213,7 @@ public boolean checkEndsWith(String str, String end) {
      * @return the first index of the search String,
      *  -1 if no match or <code>null</code> string input
      * @throws NullPointerException if either string is null
-     * @since 2.0
+     * @since Commons IO 2.0
      */
     public int checkIndexOf(String str, int strStartIndex, String search) {
         int endIndex = str.length() - search.length();

src/java/org/apache/commons/io/IOUtils.java

@@ -194,6 +194,7 @@ public static void closeQuietly(Reader input) {
      * </pre>
      *
      * @param channel the Channel to close, may be null or already closed
+     * @since Commons IO 2.0
      */
     public static void closeQuietly(Channel channel) {
         closeQuietly((Closeable)channel);
@@ -333,6 +334,7 @@ public static void closeQuietly(Closeable closeable) {
      * </pre>
      *
      * @param sock the Socket to close, may be null or already closed
+     * @since Commons IO 2.0
      */
     public static void closeQuietly(Socket sock){
         if (sock != null){
@@ -760,7 +762,7 @@ public static LineIterator lineIterator(InputStream input, String encoding)
      *
      * @param input the CharSequence to convert
      * @return an input stream
-     * @since IO 2.0
+     * @since Commons IO 2.0
      */
     public static InputStream toInputStream(CharSequence input) {
         return toInputStream(input.toString());
@@ -777,7 +779,7 @@ public static InputStream toInputStream(CharSequence input) {
      * @param encoding the encoding to use, null means platform default
      * @throws IOException if the encoding is invalid
      * @return an input stream
-     * @since IO 2.0
+     * @since Commons IO 2.0
      */
     public static InputStream toInputStream(CharSequence input, String encoding) throws IOException {
         return toInputStream(input.toString(), encoding);
@@ -1548,6 +1550,7 @@ public static boolean contentEquals(Reader input1, Reader input2)
      * 
      * @throws IOException if there is a problem reading the file
      * @throws IllegalArgumentException if toSkip is negative
+     * @since Commons IO 2.0
      */
     public static long skip(InputStream input, long toSkip) throws IOException {
         if (toSkip < 0) {
@@ -1588,6 +1591,7 @@ public static long skip(InputStream input, long toSkip) throws IOException {
      * 
      * @throws IOException if there is a problem reading the file
      * @throws IllegalArgumentException if toSkip is negative
+     * @since Commons IO 2.0
      */
     public static long skip(Reader input, long toSkip) throws IOException {
         if (toSkip < 0) {
@@ -1627,6 +1631,7 @@ public static long skip(Reader input, long toSkip) throws IOException {
      * @throws IOException if there is a problem reading the file
      * @throws IllegalArgumentException if toSkip is negative
      * @throws EOFException if the number of bytes skipped was incorrect 
+     * @since Commons IO 2.0
      */
     public static void skipFully(InputStream input, long toSkip) throws IOException {
         if (toSkip < 0){
@@ -1651,6 +1656,7 @@ public static void skipFully(InputStream input, long toSkip) throws IOException
      * @throws IOException if there is a problem reading the file
      * @throws IllegalArgumentException if toSkip is negative
      * @throws EOFException if the number of characters skipped was incorrect
+     * @since Commons IO 2.0
      */
     public static void skipFully(Reader input, long toSkip) throws IOException {
         long skipped = skip(input, toSkip);

src/java/org/apache/commons/io/comparator/AbstractFileComparator.java

@@ -38,6 +38,7 @@ abstract class AbstractFileComparator implements Comparator<File> {
      *
      * @param files The files to sort, may be null
      * @return The sorted array
+     * @since Commons IO 2.0
      */
     public File[] sort(File... files) {
         if (files != null) {
@@ -54,6 +55,7 @@ public File[] sort(File... files) {
      *
      * @param files The files to sort, may be null
      * @return The sorted list
+     * @since Commons IO 2.0
      */
     public List<File> sort(List<File> files) {
         if (files != null) {

src/java/org/apache/commons/io/filefilter/FileFilterUtils.java

@@ -626,6 +626,7 @@ public static IOFileFilter sizeRangeFileFilter(long minSizeInclusive, long maxSi
      *         
      * @throws IllegalArgumentException if <code>magicNumber</code> is 
      *         <code>null</code> or the empty String.
+     * @since Commons IO 2.0
      */
     public static IOFileFilter magicNumberFileFilter(String magicNumber) {
         return new MagicNumberFileFilter(magicNumber);
@@ -645,6 +646,7 @@ public static IOFileFilter magicNumberFileFilter(String magicNumber) {
      * @throws IllegalArgumentException if <code>magicNumber</code> is 
      *         <code>null</code> or the empty String, or if offset is a 
      *         negative number.
+     * @since Commons IO 2.0
      */
     public static IOFileFilter magicNumberFileFilter(String magicNumber, long offset) {
         return new MagicNumberFileFilter(magicNumber, offset);
@@ -662,6 +664,7 @@ public static IOFileFilter magicNumberFileFilter(String magicNumber, long offset
      *         
      * @throws IllegalArgumentException if <code>magicNumber</code> is 
      *         <code>null</code> or is of length zero.
+     * @since Commons IO 2.0
      */
     public static IOFileFilter magicNumberFileFilter(byte[] magicNumber) {
         return new MagicNumberFileFilter(magicNumber);
@@ -681,6 +684,7 @@ public static IOFileFilter magicNumberFileFilter(byte[] magicNumber) {
      * @throws IllegalArgumentException if <code>magicNumber</code> is 
      *         <code>null</code>, or contains no bytes, or <code>offset</code> 
      *         is a negative number.
+     * @since Commons IO 2.0
      */
     public static IOFileFilter magicNumberFileFilter(byte[] magicNumber, long offset) {
         return new MagicNumberFileFilter(magicNumber, offset);

src/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java

@@ -58,7 +58,7 @@
  *     System.out.println(tarFile);
  * }
  * </pre></code>
- * 
+ * @since Commons IO 2.0
  */
 public class MagicNumberFileFilter extends AbstractFileFilter implements
         Serializable {

src/java/org/apache/commons/io/input/AutoCloseInputStream.java

@@ -69,6 +69,7 @@ public void close() throws IOException {
      *
      * @param n number of bytes read, or -1 if no more bytes are available
      * @throws IOException if the stream could not be closed
+     * @since Commons IO 2.0
      */
     @Override
     protected void afterRead(int n) throws IOException {