You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ni...@apache.org on 2010/10/01 22:54:00 UTC
svn commit: r1003647 - in
/commons/proper/io/trunk/src/java/org/apache/commons/io: ./ comparator/
filefilter/ input/ monitor/ output/
Author: niallp
Date: Fri Oct 1 20:53:59 2010
New Revision: 1003647
URL: http://svn.apache.org/viewvc?rev=1003647&view=rev
Log:
@since Commons IO 2.0 tags
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java
commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java
commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java
commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java
commons/proper/io/trunk/src/java/org/apache/commons/io/IOCase.java
commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
commons/proper/io/trunk/src/java/org/apache/commons/io/comparator/AbstractFileComparator.java
commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/FileFilterUtils.java
commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
commons/proper/io/trunk/src/java/org/apache/commons/io/input/AutoCloseInputStream.java
commons/proper/io/trunk/src/java/org/apache/commons/io/input/CountingInputStream.java
commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyReader.java
commons/proper/io/trunk/src/java/org/apache/commons/io/monitor/FilesystemEntry.java
commons/proper/io/trunk/src/java/org/apache/commons/io/output/ByteArrayOutputStream.java
commons/proper/io/trunk/src/java/org/apache/commons/io/output/CountingOutputStream.java
commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullWriter.java
commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyWriter.java
commons/proper/io/trunk/src/java/org/apache/commons/io/output/StringBuilderWriter.java
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/DirectoryWalker.java Fri Oct 1 20:53:59 2010
@@ -514,6 +514,7 @@ public abstract class DirectoryWalker<T>
* @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;
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/FileSystemUtils.java Fri Oct 1 20:53:59 2010
@@ -216,6 +216,7 @@ public class FileSystemUtils {
* @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);
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/FileUtils.java Fri Oct 1 20:53:59 2010
@@ -1495,7 +1495,7 @@ public class FileUtils {
* @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 class FileUtils {
* @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 class FileUtils {
* @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) {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/FilenameUtils.java Fri Oct 1 20:53:59 2010
@@ -242,8 +242,9 @@ public class FilenameUtils {
*
* @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 class FilenameUtils {
* @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);
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/IOCase.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/IOCase.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/IOCase.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/IOCase.java Fri Oct 1 20:53:59 2010
@@ -213,7 +213,7 @@ public final class IOCase implements Ser
* @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();
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java Fri Oct 1 20:53:59 2010
@@ -194,6 +194,7 @@ public class IOUtils {
* </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 class IOUtils {
* </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 class IOUtils {
*
* @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 class IOUtils {
* @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 class IOUtils {
*
* @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 class IOUtils {
*
* @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 class IOUtils {
* @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 class IOUtils {
* @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);
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/comparator/AbstractFileComparator.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/comparator/AbstractFileComparator.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/comparator/AbstractFileComparator.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/comparator/AbstractFileComparator.java Fri Oct 1 20:53:59 2010
@@ -38,6 +38,7 @@ abstract class AbstractFileComparator im
*
* @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 @@ abstract class AbstractFileComparator im
*
* @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) {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/FileFilterUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/FileFilterUtils.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/FileFilterUtils.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/FileFilterUtils.java Fri Oct 1 20:53:59 2010
@@ -626,6 +626,7 @@ public class FileFilterUtils {
*
* @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 class FileFilterUtils {
* @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 class FileFilterUtils {
*
* @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 class FileFilterUtils {
* @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);
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/filefilter/MagicNumberFileFilter.java Fri Oct 1 20:53:59 2010
@@ -58,7 +58,7 @@ import org.apache.commons.io.IOUtils;
* System.out.println(tarFile);
* }
* </pre></code>
- *
+ * @since Commons IO 2.0
*/
public class MagicNumberFileFilter extends AbstractFileFilter implements
Serializable {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/input/AutoCloseInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/input/AutoCloseInputStream.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/input/AutoCloseInputStream.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/input/AutoCloseInputStream.java Fri Oct 1 20:53:59 2010
@@ -69,6 +69,7 @@ public class AutoCloseInputStream extend
*
* @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 {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/input/CountingInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/input/CountingInputStream.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/input/CountingInputStream.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/input/CountingInputStream.java Fri Oct 1 20:53:59 2010
@@ -65,6 +65,7 @@ public class CountingInputStream extends
* Adds the number of read bytes to the count.
*
* @param n number of bytes read, or -1 if no more bytes are available
+ * @since Commons IO 2.0
*/
@Override
protected void afterRead(int n) {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyReader.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyReader.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyReader.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyReader.java Fri Oct 1 20:53:59 2010
@@ -108,7 +108,7 @@ public abstract class ProxyReader extend
* @param target the char buffer to read the characters into
* @return the number of characters read or -1 if the end of stream
* @throws IOException if an I/O error occurs
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
@Override
public int read(CharBuffer target) throws IOException {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/monitor/FilesystemEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/monitor/FilesystemEntry.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/monitor/FilesystemEntry.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/monitor/FilesystemEntry.java Fri Oct 1 20:53:59 2010
@@ -37,6 +37,7 @@ import java.io.Serializable;
* You may also want to override the {@link #refresh()} and/or {@link #hasChanged()}
* methods.
* @see FilesystemObserver
+ * @since Commons IO 2.0
*/
public class FilesystemEntry implements Serializable {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/output/ByteArrayOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/ByteArrayOutputStream.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/output/ByteArrayOutputStream.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/output/ByteArrayOutputStream.java Fri Oct 1 20:53:59 2010
@@ -272,6 +272,7 @@ public class ByteArrayOutputStream exten
* @param input Stream to be fully buffered.
* @return A fully buffered stream.
* @throws IOException if an I/O error occurs
+ * @since Commons IO 2.0
*/
public static InputStream toBufferedInputStream(InputStream input)
throws IOException {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/output/CountingOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/CountingOutputStream.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/output/CountingOutputStream.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/output/CountingOutputStream.java Fri Oct 1 20:53:59 2010
@@ -47,6 +47,7 @@ public class CountingOutputStream extend
* Updates the count with the number of bytes that are being written.
*
* @param n number of bytes to be written to the stream
+ * @since Commons IO 2.0
*/
@Override
protected void beforeWrite(int n) {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullWriter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullWriter.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullWriter.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullWriter.java Fri Oct 1 20:53:59 2010
@@ -43,7 +43,7 @@ public class NullWriter extends Writer {
* Does nothing - output to <code>/dev/null</code>.
* @param c The character to write
* @return this writer
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
@Override
public Writer append(char c) {
@@ -57,7 +57,7 @@ public class NullWriter extends Writer {
* @param start The index of the first character to write
* @param end The index of the first character to write (exclusive)
* @return this writer
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
@Override
public Writer append(CharSequence csq, int start, int end) {
@@ -69,7 +69,7 @@ public class NullWriter extends Writer {
* Does nothing - output to <code>/dev/null</code>.
* @param csq The character sequence to write
* @return this writer
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
@Override
public Writer append(CharSequence csq) {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyWriter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyWriter.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyWriter.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyWriter.java Fri Oct 1 20:53:59 2010
@@ -48,7 +48,7 @@ public class ProxyWriter extends FilterW
* @param c The character to write
* @return this writer
* @throws IOException if an I/O error occurs
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
@Override
public Writer append(char c) throws IOException {
@@ -69,7 +69,7 @@ public class ProxyWriter extends FilterW
* @param end The index of the first character to write (exclusive)
* @return this writer
* @throws IOException if an I/O error occurs
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
@Override
public Writer append(CharSequence csq, int start, int end) throws IOException {
@@ -88,7 +88,7 @@ public class ProxyWriter extends FilterW
* @param csq The character sequence to write
* @return this writer
* @throws IOException if an I/O error occurs
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
@Override
public Writer append(CharSequence csq) throws IOException {
Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/output/StringBuilderWriter.java
URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/StringBuilderWriter.java?rev=1003647&r1=1003646&r2=1003647&view=diff
==============================================================================
--- commons/proper/io/trunk/src/java/org/apache/commons/io/output/StringBuilderWriter.java (original)
+++ commons/proper/io/trunk/src/java/org/apache/commons/io/output/StringBuilderWriter.java Fri Oct 1 20:53:59 2010
@@ -29,7 +29,7 @@ import java.io.Writer;
* <code>java.io.StringWriter</code> should be used.
*
* @version $Revision$ $Date$
- * @since IO 2.0
+ * @since Commons IO 2.0
*/
public class StringBuilderWriter extends Writer implements Serializable {