Author: britter
Date: Wed May 20 18:36:40 2015
New Revision: 1680650
URL: http://svn.apache.org/r1680650
Log:
Make JavaDoc tool happy
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BoundedReader.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsCleanSymlinksTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsDirectoryContainsTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsFileNewerTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/HexDumpTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/LineIteratorTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/FileFilterTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/BoundedInputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CharSequenceReaderTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullReaderTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ReaderInputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/TailerTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/monitor/AbstractMonitorTestCase.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/ProxyWriterTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/StringBuilderWriterTest.java
commons/proper/io/trunk/src/test/java/org/apache/commons/io/testtools/FileBasedTestCase.java
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java
(original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/CopyUtils.java
Wed May 20 18:36:40 2015
@@ -303,6 +303,9 @@ public class CopyUtils {
* <code>OutputStream</code>, and flush the <code>OutputStream</code>.
* @param input the <code>Reader</code> to read from
* @param output the <code>OutputStream</code> to write to
+ * @param encoding The name of a supported character encoding. See the
+ * <a href="http://www.iana.org/assignments/character-sets";>IANA
+ * Charset Registry</a> for a list of valid encoding types.
* @throws IOException In case of an I/O problem
* @since 2.5
*/
@@ -352,6 +355,9 @@ public class CopyUtils {
* flush the <code>OutputStream</code>.
* @param input the <code>String</code> to read from
* @param output the <code>OutputStream</code> to write to
+ * @param encoding The name of a supported character encoding. See the
+ * <a href="http://www.iana.org/assignments/character-sets";>IANA
+ * Charset Registry</a> for a list of valid encoding types.
* @throws IOException In case of an I/O problem
* @since 2.5
*/
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java
(original)
+++
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaner.java
Wed May 20 18:36:40 2015
@@ -30,7 +30,7 @@ import java.io.File;
* example), you should consider stopping the background thread if it is no
* longer needed. This is done by invoking the method
* {@link #exitWhenFinished}, typically in
- * {@link
javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}
or similar.
+ * {@code
javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)}
or similar.
*
* @version $Id$
* @deprecated Use {@link FileCleaningTracker}
@@ -137,7 +137,7 @@ public class FileCleaner {
* <p>
* This method allows the thread to be terminated. Simply call this method
* in the resource cleanup code, such as
- * {@link
javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}.
+ * {@code
javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)}.
* One called, no new objects can be tracked by the file cleaner.
* @deprecated Use {@link FileCleaningTracker#exitWhenFinished()}.
*/
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java
(original)
+++
commons/proper/io/trunk/src/main/java/org/apache/commons/io/FileCleaningTracker.java
Wed May 20 18:36:40 2015
@@ -37,7 +37,7 @@ import java.util.List;
* example), you should consider stopping the background thread if it is no
* longer needed. This is done by invoking the method
* {@link #exitWhenFinished}, typically in
- * {@link javax.servlet.ServletContextListener#contextDestroyed} or similar.
+ * {@code
javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)}
or similar.
*
* @version $Id$
*/
@@ -183,7 +183,7 @@ public class FileCleaningTracker {
* <p>
* This method allows the thread to be terminated. Simply call this method
* in the resource cleanup code, such as
- * {@link
javax.servlet.ServletContextListener#contextDestroyed(javax.servlet.ServletContextEvent)}.
+ * {@code
javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent)}.
* Once called, no new objects can be tracked by the file cleaner.
*/
public synchronized void exitWhenFinished() {
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
--- commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java
(original)
+++ commons/proper/io/trunk/src/main/java/org/apache/commons/io/IOUtils.java
Wed May 20 18:36:40 2015
@@ -3060,6 +3060,8 @@ public class IOUtils {
* @param input where to read input from
* @param length length to read, must be >= 0
*
+ * @return the bytes read from input
+ *
* @throws IOException if there is a problem reading the file
* @throws IllegalArgumentException if length is negative
* @throws EOFException if the number of bytes read was incorrect
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BoundedReader.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BoundedReader.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BoundedReader.java
(original)
+++
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/BoundedReader.java
Wed May 20 18:36:40 2015
@@ -25,10 +25,12 @@ import java.io.Reader;
* A reader that imposes a limit to the number of characters that can be read
from
* an underlying reader, returning eof when this limit is reached -regardless
of state of
* underlying reader.
- * <p/>
+ *
+ * <p>
* One use case is to avoid overrunning the readAheadLimit supplied to
* java.io.Reader#mark(int), since reading too many characters removes the
* ability to do a successful reset.
+ * </p>
*
* @since 2.5
*/
@@ -63,7 +65,7 @@ public class BoundedReader
/**
* Closes the target
*
- * @throws IOException
+ * @throws IOException If an I/O error occurs while calling the underlying
reader's close method
*/
@Override
public void close() throws IOException {
@@ -73,7 +75,7 @@ public class BoundedReader
/**
* Resets the target to the latest mark, @see java.io.Reader#reset()
*
- * @throws IOException
+ * @throws IOException If an I/O error occurs while calling the underlying
reader's reset method
*/
@Override
public void reset() throws IOException {
@@ -90,6 +92,8 @@ public class BoundedReader
* maxCharsFromTargetReader. There is no way to pass
* past maxCharsFromTargetReader, even if this value
is
* greater.
+ *
+ * @throws IOException If an I/O error occurs while calling the underlying
reader's mark method
*/
@Override
public void mark( int readAheadLimit ) throws IOException {
@@ -104,7 +108,7 @@ public class BoundedReader
* Reads a single character, @see java.io.Reader#read()
*
* @return -1 on eof or the character read
- * @throws IOException If an I/O error occurs
+ * @throws IOException If an I/O error occurs while calling the underlying
reader's read method
*/
@Override
public int read() throws IOException {
@@ -127,7 +131,7 @@ public class BoundedReader
* @param off The offset
* @param len The number of chars to read
* @return the number of chars read
- * @throws IOException
+ * @throws IOException If an I/O error occurs while calling the underlying
reader's read method
*/
@Override
public int read( char[] cbuf, int off, int len ) throws IOException {
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
(original)
+++
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/UnixLineEndingInputStream.java
Wed May 20 18:36:40 2015
@@ -60,9 +60,8 @@ public class UnixLineEndingInputStream e
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
-
@Override
public int read() throws IOException {
boolean previousWasSlashR = slashRSeen;
@@ -109,7 +108,7 @@ public class UnixLineEndingInputStream e
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
public synchronized void mark( int readlimit ) {
Modified:
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java
(original)
+++
commons/proper/io/trunk/src/main/java/org/apache/commons/io/input/WindowsLineEndingInputStream.java
Wed May 20 18:36:40 2015
@@ -59,7 +59,7 @@ public class WindowsLineEndingInputStrea
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
public int read() throws IOException {
@@ -112,7 +112,7 @@ public class WindowsLineEndingInputStrea
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*/
@Override
public synchronized void mark( int readlimit ) {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/DirectoryWalkerTestCaseJava4.java
Wed May 20 18:36:40 2015
@@ -70,18 +70,15 @@ public class DirectoryWalkerTestCaseJava
// Filter to exclude SVN files
private static final IOFileFilter NOT_SVN =
FileFilterUtils.makeSVNAware(null);
- /** Construct the TestCase using the name */
public DirectoryWalkerTestCaseJava4(final String name) {
super(name);
}
- /** Set Up */
@Override
protected void setUp() throws Exception {
super.setUp();
}
- /** Tear Down */
@Override
protected void tearDown() throws Exception {
super.tearDown();
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsCleanSymlinksTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsCleanSymlinksTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsCleanSymlinksTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsCleanSymlinksTestCase.java
Wed May 20 18:36:40 2015
@@ -24,7 +24,7 @@ import org.apache.commons.io.testtools.F
/**
* Test cases for FileUtils.cleanDirectory() method that involve symlinks.
- * & FileUtils.isSymlink(File file)
+ * & FileUtils.isSymlink(File file)
*/
public class FileUtilsCleanSymlinksTestCase extends FileBasedTestCase {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsDirectoryContainsTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsDirectoryContainsTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsDirectoryContainsTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsDirectoryContainsTestCase.java
Wed May 20 18:36:40 2015
@@ -147,7 +147,7 @@ public class FileUtilsDirectoryContainsT
/**
* Test to demonstrate a file which does not exist returns false
- * @throws IOException
+ * @throws IOException If an I/O error occurs
*/
@Test
public void testFileDoesNotExistBug() throws IOException {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsFileNewerTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsFileNewerTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsFileNewerTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsFileNewerTestCase.java
Wed May 20 18:36:40 2015
@@ -93,7 +93,7 @@ public class FileUtilsFileNewerTestCase
/**
* Tests the <code>isFileNewer(File, *)</code> methods which the specified
conditions.
- * <p/>
+ *
* Creates :
* <ul>
* <li>a <code>Date</code> which represents the time reference</li>
@@ -102,12 +102,13 @@ public class FileUtilsFileNewerTestCase
* Then compares (with the needed <code>isFileNewer</code> method) the
last modification date of
* the specified file with the specified time reference, the created
<code>Date</code> and the temporary
* file.
- * <br/>
+ * <br>
* The test is successfull if the three comparaisons return the specified
wanted result.
*
* @param description describes the tested situation
* @param file the file of which the last modification date is compared
* @param time the time reference measured in milliseconds since the epoch
+ * @param wantedResult the expected result
*
* @see FileUtils#isFileNewer(File, long)
* @see FileUtils#isFileNewer(File, Date)
@@ -126,7 +127,7 @@ public class FileUtilsFileNewerTestCase
/**
* Tests the <code>isFileNewer(File, long)</code> method without
specifying a <code>File</code>.
- * <br/>
+ * <br>
* The test is successfull if the method throws an
<code>IllegalArgumentException</code>.
*/
public void testIsFileNewerNoFile() {
@@ -138,7 +139,7 @@ public class FileUtilsFileNewerTestCase
/**
* Tests the <code>isFileNewer(File, Date)</code> method without
specifying a <code>Date</code>.
- * <br/>
+ * <br>
* The test is successfull if the method throws an
<code>IllegalArgumentException</code>.
*/
public void testIsFileNewerNoDate() {
@@ -150,7 +151,7 @@ public class FileUtilsFileNewerTestCase
/**
* Tests the <code>isFileNewer(File, File)</code> method without
specifying a reference <code>File</code>.
- * <br/>
+ * <br>
* The test is successfull if the method throws an
<code>IllegalArgumentException</code>.
*/
public void testIsFileNewerNoFileReference() {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/FileUtilsTestCase.java
Wed May 20 18:36:40 2015
@@ -93,7 +93,6 @@ public class FileUtilsTestCase extends F
testFile2Size = (int)testFile2.length();
}
- /** @see junit.framework.TestCase#setUp() */
@Override
protected void setUp() throws Exception {
getTestDirectory().mkdirs();
@@ -105,16 +104,12 @@ public class FileUtilsTestCase extends F
createFile(testFile2, testFile2Size);
}
- /** @see junit.framework.TestCase#tearDown() */
@Override
protected void tearDown() throws Exception {
FileUtils.deleteDirectory(getTestDirectory());
}
//-----------------------------------------------------------------------
- /**
- * Tests the {@link FileUtils#getFile(String...)} method.
- */
public void testGetFile() {
final File expected_A = new File("src");
final File expected_B = new File(expected_A, "main");
@@ -130,9 +125,6 @@ public class FileUtilsTestCase extends F
}
}
- /**
- * Tests the {@link FileUtils#getFile(File, String...)} method.
- */
public void testGetFile_Parent() {
final File parent = new File("parent");
final File expected_A = new File(parent, "src");
@@ -155,33 +147,21 @@ public class FileUtilsTestCase extends F
}
}
- /**
- * Tests the {@link FileUtils#getTempDirectoryPath()} method.
- */
public void testGetTempDirectoryPath() {
assertEquals(System.getProperty("java.io.tmpdir"),
FileUtils.getTempDirectoryPath());
}
- /**
- * Tests the {@link FileUtils#getTempDirectory()} method.
- */
public void testGetTempDirectory() {
final File tempDirectory = new
File(System.getProperty("java.io.tmpdir"));
assertEquals(tempDirectory, FileUtils.getTempDirectory());
}
- /**
- * Tests the {@link FileUtils#getUserDirectoryPath()} method.
- */
public void testGetUserDirectoryPath() {
assertEquals(System.getProperty("user.home"),
FileUtils.getUserDirectoryPath());
}
- /**
- * Tests the {@link FileUtils#getUserDirectory()} method.
- */
public void testGetUserDirectory() {
final File userDirectory = new File(System.getProperty("user.home"));
assertEquals(userDirectory, FileUtils.getUserDirectory());
@@ -401,7 +381,7 @@ public class FileUtilsTestCase extends F
assertTrue(file.toString().indexOf("file% %me.txt%") >= 0);
}
- /** IO-252 */
+ /* IO-252 */
public void testToFile5() throws Exception {
final URL url = new URL("file", null, "both%20are%20100%20%25%20true");
final File file = FileUtils.toFile(url);
@@ -872,10 +852,6 @@ public class FileUtilsTestCase extends F
assertEquals("longSize should equal BigSize",sizeLong1,
sizeBig.longValue());
}
- /**
- * Tests the {@link FileUtils#sizeOf(File)} method.
- * @throws Exception
- */
public void testSizeOf() throws Exception {
final File file = new File(getTestDirectory(), getName());
@@ -910,10 +886,6 @@ public class FileUtilsTestCase extends F
FileUtils.sizeOf(getTestDirectory()));
}
- /**
- * Tests the {@link FileUtils#sizeOf(File)} method.
- * @throws Exception
- */
public void testSizeOfAsBigInteger() throws Exception {
final File file = new File(getTestDirectory(), getName());
@@ -1082,12 +1054,6 @@ public class FileUtilsTestCase extends F
}
-// // TODO Remove after debugging
-// private void log(Object obj) {
-// System.out.println(
-// FileUtilsTestCase.class +" " + getName() + " " + obj);
-// }
-
// copyFile
public void testCopyFile1() throws Exception {
@@ -1303,7 +1269,7 @@ public class FileUtilsTestCase extends F
FileUtils.deleteDirectory(target);
}
- /** Test for IO-141 */
+ /* Test for IO-141 */
public void testCopyDirectoryToChild() throws Exception {
final File grandParentDir = new File(getTestDirectory(),
"grandparent");
final File parentDir = new File(grandParentDir, "parent");
@@ -1321,7 +1287,7 @@ public class FileUtilsTestCase extends F
assertTrue("Size > 0", expectedSize > 0);
}
- /** Test for IO-141 */
+ /* Test for IO-141 */
public void testCopyDirectoryToGrandChild() throws Exception {
final File grandParentDir = new File(getTestDirectory(),
"grandparent");
final File parentDir = new File(grandParentDir, "parent");
@@ -1336,7 +1302,7 @@ public class FileUtilsTestCase extends F
assertTrue("Size > 0",expectedSize > 0);
}
- /** Test for IO-217 FileUtils.copyDirectoryToDirectory makes infinite
loops */
+ /* Test for IO-217 FileUtils.copyDirectoryToDirectory makes infinite loops
*/
public void testCopyDirectoryToItself() throws Exception {
final File dir = new File(getTestDirectory(), "itself");
dir.mkdirs();
@@ -1481,7 +1447,7 @@ public class FileUtilsTestCase extends F
!testDirectory.getParentFile().exists());
}
- /**
+ /*
* Test the FileUtils implementation.
*/
public void testFileUtils() throws Exception {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/HexDumpTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/HexDumpTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/HexDumpTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/HexDumpTest.java
Wed May 20 18:36:40 2015
@@ -26,15 +26,8 @@ import org.apache.commons.io.output.Byte
/**
* @version $Id$
*/
-
public class HexDumpTest extends TestCase {
- /**
- * Creates new HexDumpTest
- *
- * @param name
- */
-
public HexDumpTest(final String name) {
super(name);
}
@@ -49,12 +42,6 @@ public class HexDumpTest extends TestCas
return hexChars[n % 16];
}
- /**
- * test dump method
- *
- * @exception IOException
- */
-
public void testDump()
throws IOException {
final byte[] testArray = new byte[256];
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/IOUtilsCopyTestCase.java
Wed May 20 18:36:40 2015
@@ -137,7 +137,7 @@ public class IOUtilsCopyTestCase extends
} catch (final NullPointerException ex) {}
}
- /**
+ /*
* Test Copying file > 2GB - see issue# IO-84
*/
public void testCopy_inputStreamToOutputStream_IO84() throws Exception {
@@ -389,7 +389,7 @@ public class IOUtilsCopyTestCase extends
} catch (final NullPointerException ex) {}
}
- /**
+ /*
* Test Copying file > 2GB - see issue# IO-84
*/
public void testCopy_readerToWriter_IO84() throws Exception {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/LineIteratorTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/LineIteratorTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/LineIteratorTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/LineIteratorTestCase.java
Wed May 20 18:36:40 2015
@@ -58,8 +58,13 @@ public class LineIteratorTestCase extend
/**
* Creates a test file with a specified number of lines.
+ *
+ * @param file target file
+ * @param lineCount number of lines to create
+ *
+ * @throws IOException If an I/O error occurs
*/
- private List<String> createLinesFile(final File file, final int lineCount)
throws Exception {
+ private List<String> createLinesFile(final File file, final int lineCount)
throws IOException {
final List<String> lines = createStringLines(lineCount);
FileUtils.writeLines(file, lines);
return lines;
@@ -67,8 +72,14 @@ public class LineIteratorTestCase extend
/**
* Creates a test file with a specified number of lines.
+ *
+ * @param file target file
+ * @param encoding the encoding to use while writing the lines
+ * @param lineCount number of lines to create
+ *
+ * @throws IOException If an I/O error occurs
*/
- private List<String> createLinesFile(final File file, final String
encoding, final int lineCount) throws Exception {
+ private List<String> createLinesFile(final File file, final String
encoding, final int lineCount) throws IOException {
final List<String> lines = createStringLines(lineCount);
FileUtils.writeLines(file, encoding, lines);
return lines;
@@ -77,7 +88,7 @@ public class LineIteratorTestCase extend
/**
* Creates String data lines.
*
- * @param lineCount
+ * @param lineCount number of lines to create
* @return a new lines list.
*/
private List<String> createStringLines(final int lineCount) {
@@ -88,7 +99,6 @@ public class LineIteratorTestCase extend
return lines;
}
- /** @see junit.framework.TestCase#setUp() */
@Override
@Before
protected void setUp() throws Exception {
@@ -100,7 +110,6 @@ public class LineIteratorTestCase extend
}
- /** @see junit.framework.TestCase#tearDown() */
@Override
@After
protected void tearDown() throws Exception {
@@ -108,9 +117,7 @@ public class LineIteratorTestCase extend
}
// -----------------------------------------------------------------------
- /**
- * Test constructor.
- */
+
@Test
public void testConstructor() throws Exception {
try {
@@ -121,41 +128,26 @@ public class LineIteratorTestCase extend
}
}
- /**
- * Test a file with no lines.
- */
@Test
public void testZeroLines() throws Exception {
doTestFileWithSpecifiedLines(0);
}
- /**
- * Test a file with 1 line.
- */
@Test
public void testOneLines() throws Exception {
doTestFileWithSpecifiedLines(1);
}
- /**
- * Test a file with 2 lines.
- */
@Test
public void testTwoLines() throws Exception {
doTestFileWithSpecifiedLines(2);
}
- /**
- * Test a file with 3 lines.
- */
@Test
public void testThreeLines() throws Exception {
doTestFileWithSpecifiedLines(3);
}
- /**
- * Test a missing File.
- */
@Test
public void testMissingFile() throws Exception {
final File testFile = new File(getTestDirectory(),
"dummy-missing-file.txt");
@@ -171,9 +163,6 @@ public class LineIteratorTestCase extend
}
}
- /**
- * Test a file with a Valid encoding.
- */
@Test
public void testValidEncoding() throws Exception {
final String encoding = "UTF-8";
@@ -194,9 +183,6 @@ public class LineIteratorTestCase extend
}
}
- /**
- * Test a file with an Invalid encoding.
- */
@Test
public void testInvalidEncoding() throws Exception {
final String encoding = "XXXXXXXX";
@@ -215,9 +201,6 @@ public class LineIteratorTestCase extend
}
}
- /**
- * Test the iterator using only the nextLine() method.
- */
@Test
public void testNextLineOnlyDefaultEncoding() throws Exception {
final File testFile = new File(getTestDirectory(),
"LineIterator-nextOnly.txt");
@@ -227,9 +210,6 @@ public class LineIteratorTestCase extend
assertLines(lines, iterator);
}
- /**
- * Test the iterator using only the nextLine() method.
- */
@Test
public void testNextLineOnlyNullEncoding() throws Exception {
final String encoding = null;
@@ -241,9 +221,6 @@ public class LineIteratorTestCase extend
assertLines(lines, iterator);
}
- /**
- * Test the iterator using only the nextLine() method.
- */
@Test
public void testNextLineOnlyUtf8Encoding() throws Exception {
final String encoding = "UTF-8";
@@ -255,9 +232,6 @@ public class LineIteratorTestCase extend
assertLines(lines, iterator);
}
- /**
- * Test the iterator using only the next() method.
- */
@Test
public void testNextOnly() throws Exception {
final String encoding = null;
@@ -277,9 +251,6 @@ public class LineIteratorTestCase extend
}
}
- /**
- * Tests hasNext when it throws an exception.
- */
@Test
public void testNextWithException() throws Exception {
final Reader reader = new BufferedReader(new StringReader("")) {
@@ -296,9 +267,6 @@ public class LineIteratorTestCase extend
}
}
- /**
- * Test closing the iterator before all the file has been processed.
- */
@Test
public void testCloseEarly() throws Exception {
final String encoding = "UTF-8";
@@ -349,8 +317,12 @@ public class LineIteratorTestCase extend
/**
* Utility method to create and test a file with a specified number of
lines.
+ *
+ * @param lineCount the lines to create in the test file
+ *
+ * @throws IOException If an I/O error occurs while creating the file
*/
- private void doTestFileWithSpecifiedLines(final int lineCount) throws
Exception {
+ private void doTestFileWithSpecifiedLines(final int lineCount) throws
IOException {
final String encoding = "UTF-8";
final String fileName = "LineIterator-" + lineCount + "-test.txt";
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/FileFilterTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/FileFilterTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/FileFilterTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/FileFilterTestCase.java
Wed May 20 18:36:40 2015
@@ -1118,7 +1118,7 @@ public class FileFilterTestCase extends
}
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filter(IOFileFilter, File...)}
* that tests that the method properly filters files from the list.
*/
@@ -1134,7 +1134,7 @@ public class FileFilterTestCase extends
assertEquals(fileA, filtered[0]);
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filter(IOFileFilter,
java.lang.Iterable)}
* that tests that the method properly filters files from the list.
*/
@@ -1151,7 +1151,7 @@ public class FileFilterTestCase extends
assertEquals(fileA, filtered[0]);
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filter(IOFileFilter, File...)}
* that tests {@code null} parameters and {@code null} elements
* in the provided list.
@@ -1178,7 +1178,7 @@ public class FileFilterTestCase extends
assertEquals(0, filtered.length);
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filterList(IOFileFilter,
java.lang.Iterable)}
* that tests that the method properly filters files from the list.
*/
@@ -1195,7 +1195,7 @@ public class FileFilterTestCase extends
assertFalse(filteredList.contains(fileB));
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filterList(IOFileFilter,
File...)}
* that tests that the method properly filters files from the list.
*/
@@ -1211,7 +1211,7 @@ public class FileFilterTestCase extends
assertFalse(filteredList.contains(fileB));
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filterList(IOFileFilter,
java.lang.Iterable)}
* that tests {@code null} parameters and {@code null} elements
* in the provided list.
@@ -1236,7 +1236,7 @@ public class FileFilterTestCase extends
assertEquals(0, filteredList.size());
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filterSet(IOFileFilter,
java.lang.Iterable)}
* that tests that the method properly filters files from the set.
*/
@@ -1253,7 +1253,7 @@ public class FileFilterTestCase extends
assertFalse(filteredSet.contains(fileB));
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filterSet(IOFileFilter, File...)}
* that tests that the method properly filters files from the set.
*/
@@ -1269,7 +1269,7 @@ public class FileFilterTestCase extends
assertFalse(filteredSet.contains(fileB));
}
- /**
+ /*
* Test method for {@link FileFilterUtils#filterSet(IOFileFilter,
java.lang.Iterable)}
* that tests {@code null} parameters and {@code null} elements
* in the provided set.
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/filefilter/IOFileFilterAbstractTestCase.java
Wed May 20 18:36:40 2015
@@ -22,10 +22,6 @@ import junit.framework.TestCase;
public abstract class IOFileFilterAbstractTestCase extends TestCase {
- /**
- * Constructs a new instance of
- * <code>IOFileFilterAbstractTestCase</code>.
- */
public IOFileFilterAbstractTestCase(final String name) {
super(name);
}
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/AutoCloseInputStreamTest.java
Wed May 20 18:36:40 2015
@@ -45,9 +45,6 @@ public class AutoCloseInputStreamTest ex
closed = false;
}
- /**
- * Test the <code>close()</code> method.
- */
public void testClose() throws IOException {
stream.close();
assertTrue("closed", closed);
@@ -55,9 +52,6 @@ public class AutoCloseInputStreamTest ex
}
- /**
- * Test the <code>read()</code> method.
- */
public void testRead() throws IOException {
for (final byte element : data) {
assertEquals("read()", element, stream.read());
@@ -67,9 +61,6 @@ public class AutoCloseInputStreamTest ex
assertTrue("closed", closed);
}
- /**
- * Test the <code>read(b)</code> method.
- */
public void testReadBuffer() throws IOException {
final byte[] b = new byte[data.length * 2];
int total = 0;
@@ -85,9 +76,6 @@ public class AutoCloseInputStreamTest ex
assertEquals("read(b)", -1, stream.read(b));
}
- /**
- * Test the <code>read(b, off, len)</code> method.
- */
public void testReadBufferOffsetLength() throws IOException {
final byte[] b = new byte[data.length * 2];
int total = 0;
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/BoundedInputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/BoundedInputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/BoundedInputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/BoundedInputStreamTest.java
Wed May 20 18:36:40 2015
@@ -33,9 +33,6 @@ public class BoundedInputStreamTest exte
super(name);
}
- /**
- * Test {@link BoundedInputStream#read()}.
- */
public void testReadSingle() throws Exception {
BoundedInputStream bounded = null;
final byte[] helloWorld = "Hello World".getBytes();
@@ -63,9 +60,6 @@ public class BoundedInputStreamTest exte
assertEquals("limit < length end", -1, bounded.read());
}
- /**
- * Test {@link BoundedInputStream#read(byte[], int, int)}.
- */
public void testReadArray() throws Exception {
BoundedInputStream bounded = null;
@@ -88,9 +82,6 @@ public class BoundedInputStreamTest exte
compare("limit < length", hello, IOUtils.toByteArray(bounded));
}
- /**
- * Compare byte arrays.
- */
private void compare(final String msg, final byte[] expected, final byte[]
actual) {
assertEquals(msg + " length", expected.length, actual.length);
for (int i = 0; i < expected.length; i++) {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CharSequenceReaderTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CharSequenceReaderTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CharSequenceReaderTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CharSequenceReaderTest.java
Wed May 20 18:36:40 2015
@@ -32,7 +32,6 @@ import org.junit.Test;
public class CharSequenceReaderTest {
private static final char NONE = (new char[1])[0];
- /** Test {@link Reader#close()}. */
@Test
public void testClose() throws IOException {
final Reader reader = new CharSequenceReader("FooBar");
@@ -41,7 +40,6 @@ public class CharSequenceReaderTest {
checkRead(reader, "Foo");
}
- /** Test {@link Reader#markSupported()}. */
@Test
public void testMarkSupported() throws Exception {
final Reader reader = new CharSequenceReader("FooBar");
@@ -49,7 +47,6 @@ public class CharSequenceReaderTest {
reader.close();
}
- /** Test {@link Reader#mark(int)}. */
@Test
public void testMark() throws IOException {
final Reader reader = new CharSequenceReader("FooBar");
@@ -64,7 +61,6 @@ public class CharSequenceReaderTest {
checkRead(reader, "Foo");
}
- /** Test {@link Reader#skip(long)}. */
@Test
public void testSkip() throws IOException {
final Reader reader = new CharSequenceReader("FooBar");
@@ -80,7 +76,6 @@ public class CharSequenceReaderTest {
assertEquals(-1, reader.read());
}
- /** Test {@link Reader#read()}. */
@Test
public void testRead() throws IOException {
final Reader reader = new CharSequenceReader("Foo");
@@ -92,7 +87,6 @@ public class CharSequenceReaderTest {
reader.close();
}
- /** Test {@link Reader#read(char[])}. */
@Test
public void testReadCharArray() throws IOException {
final Reader reader = new CharSequenceReader("FooBar");
@@ -109,7 +103,6 @@ public class CharSequenceReaderTest {
reader.close();
}
- /** Test {@link Reader#read(char[], int, int)}. */
@Test
public void testReadCharArrayPortion() throws IOException {
final char[] chars = new char[10];
@@ -128,6 +121,7 @@ public class CharSequenceReaderTest {
expected.charAt(i), (char)reader.read());
}
}
+
private void checkArray(final char[] expected, final char[] actual) {
for (int i = 0; i < expected.length; i++) {
assertEquals("Compare[" +i + "]", expected[i], actual[i]);
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CloseShieldInputStreamTest.java
Wed May 20 18:36:40 2015
@@ -48,9 +48,6 @@ public class CloseShieldInputStreamTest
closed = false;
}
- /**
- * Test the <code>close()</code> method.
- */
public void testClose() throws IOException {
shielded.close();
assertFalse("closed", closed);
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ClosedInputStreamTest.java
Wed May 20 18:36:40 2015
@@ -23,9 +23,6 @@ import junit.framework.TestCase;
*/
public class ClosedInputStreamTest extends TestCase {
- /**
- * Test the <code>read()</code> method.
- */
public void testRead() throws Exception {
final ClosedInputStream cis = new ClosedInputStream();
assertEquals("read()", -1, cis.read());
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/CountingInputStreamTest.java
Wed May 20 18:36:40 2015
@@ -70,7 +70,7 @@ public class CountingInputStreamTest ext
}
- /**
+ /*
* Test for files > 2GB in size - see issue IO-84
*/
public void testLargeFiles_IO84() throws Exception {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullInputStreamTest.java
Wed May 20 18:36:40 2015
@@ -29,26 +29,20 @@ import junit.framework.TestCase;
*/
public class NullInputStreamTest extends TestCase {
- /** Constructor */
public NullInputStreamTest(final String name) {
super(name);
}
- /** Set up */
@Override
protected void setUp() throws Exception {
super.setUp();
}
- /** Tear Down */
@Override
protected void tearDown() throws Exception {
super.tearDown();
}
- /**
- * Test <code>available()</code> method.
- */
public void testRead() throws Exception {
final int size = 5;
final InputStream input = new TestNullInputStream(size);
@@ -75,9 +69,6 @@ public class NullInputStreamTest extends
assertEquals("Available after close", size, input.available());
}
- /**
- * Test <code>read(byte[])</code> method.
- */
public void testReadByteArray() throws Exception {
final byte[] bytes = new byte[10];
final InputStream input = new TestNullInputStream(15);
@@ -121,10 +112,6 @@ public class NullInputStreamTest extends
}
}
- /**
- * Test when configured to throw an EOFException at the end of file
- * (rather than return -1).
- */
public void testEOFException() throws Exception {
final InputStream input = new TestNullInputStream(2, false, true);
assertEquals("Read 1", 0, input.read());
@@ -138,9 +125,6 @@ public class NullInputStreamTest extends
input.close();
}
- /**
- * Test <code>mark()</code> and <code>reset()</code> methods.
- */
public void testMarkAndReset() throws Exception {
int position = 0;
final int readlimit = 10;
@@ -192,9 +176,6 @@ public class NullInputStreamTest extends
input.close();
}
- /**
- * Test <code>mark()</code> not supported.
- */
public void testMarkNotSupported() throws Exception {
final InputStream input = new TestNullInputStream(100, false, true);
assertFalse("Mark Should NOT be Supported", input.markSupported());
@@ -215,9 +196,6 @@ public class NullInputStreamTest extends
input.close();
}
- /**
- * Test <code>skip()</code> method.
- */
public void testSkip() throws Exception {
final InputStream input = new TestNullInputStream(10, true, false);
assertEquals("Read 1", 0, input.read());
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullReaderTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullReaderTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullReaderTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/NullReaderTest.java
Wed May 20 18:36:40 2015
@@ -29,26 +29,20 @@ import junit.framework.TestCase;
*/
public class NullReaderTest extends TestCase {
- /** Constructor */
public NullReaderTest(final String name) {
super(name);
}
- /** Set up */
@Override
protected void setUp() throws Exception {
super.setUp();
}
- /** Tear Down */
@Override
protected void tearDown() throws Exception {
super.tearDown();
}
- /**
- * Test <code>available()</code> method.
- */
public void testRead() throws Exception {
final int size = 5;
final TestNullReader reader = new TestNullReader(size);
@@ -72,9 +66,6 @@ public class NullReaderTest extends Test
assertEquals("Available after close", 0, reader.getPosition());
}
- /**
- * Test <code>read(char[])</code> method.
- */
public void testReadCharArray() throws Exception {
final char[] chars = new char[10];
final Reader reader = new TestNullReader(15);
@@ -118,10 +109,6 @@ public class NullReaderTest extends Test
}
}
- /**
- * Test when configured to throw an EOFException at the end of file
- * (rather than return -1).
- */
public void testEOFException() throws Exception {
final Reader reader = new TestNullReader(2, false, true);
assertEquals("Read 1", 0, reader.read());
@@ -135,9 +122,6 @@ public class NullReaderTest extends Test
reader.close();
}
- /**
- * Test <code>mark()</code> and <code>reset()</code> methods.
- */
public void testMarkAndReset() throws Exception {
int position = 0;
final int readlimit = 10;
@@ -189,9 +173,6 @@ public class NullReaderTest extends Test
reader.close();
}
- /**
- * Test <code>mark()</code> not supported.
- */
public void testMarkNotSupported() throws Exception {
final Reader reader = new TestNullReader(100, false, true);
assertFalse("Mark Should NOT be Supported", reader.markSupported());
@@ -212,9 +193,6 @@ public class NullReaderTest extends Test
reader.close();
}
- /**
- * Test <code>skip()</code> method.
- */
public void testSkip() throws Exception {
final Reader reader = new TestNullReader(10, true, false);
assertEquals("Read 1", 0, reader.read());
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ProxyReaderTest.java
Wed May 20 18:36:40 2015
@@ -33,7 +33,6 @@ public class ProxyReaderTest extends Tes
super(name);
}
- /** Test writing Null Char Array */
public void testNullCharArray() throws Exception {
final ProxyReader proxy = new ProxyReaderImpl(new CustomNullReader(0));
@@ -52,7 +51,6 @@ public class ProxyReaderTest extends Tes
proxy.close();
}
- /** Test writing Null CharBuffer */
public void testNullCharBuffer() throws Exception {
final ProxyReader proxy = new ProxyReaderImpl(new CustomNullReader(0));
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ReaderInputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ReaderInputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ReaderInputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/ReaderInputStreamTest.java
Wed May 20 18:36:40 2015
@@ -131,10 +131,8 @@ public class ReaderInputStreamTest {
r.close();
}
- /**
+ /*
* Tests https://issues.apache.org/jira/browse/IO-277
- *
- * @throws IOException
*/
@Test
public void testCharsetMismatchInfiniteLoop() throws IOException {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/TailerTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/TailerTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/TailerTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/TailerTest.java
Wed May 20 18:36:40 2015
@@ -330,10 +330,8 @@ public class TailerTest extends FileBase
assertEquals("fileRotated should be not be called", 0 ,
listener.rotated);
}
- /**
+ /*
* Tests [IO-357][Tailer] InterruptedException while the thead is sleeping
is silently ignored.
- *
- * @throws Exception
*/
public void testInterrupt() throws Exception {
final File file = new File(getTestDirectory(), "nosuchfile");
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderTest.java
Wed May 20 18:36:40 2015
@@ -33,8 +33,6 @@ import java.util.Map;
import org.apache.commons.io.IOUtils;
import org.junit.Test;
-/**
- */
public class XmlStreamReaderTest {
private static final String XML5 =
"xml-prolog-encoding-spaced-single-quotes";
private static final String XML4 = "xml-prolog-encoding-single-quotes";
@@ -424,7 +422,10 @@ public class XmlStreamReaderTest {
*
* @param bomType no-bom, UTF-16BE-bom, UTF-16LE-bom, UTF-8-bom
* @param xmlType xml, xml-prolog, xml-prolog-charset
+ * @param streamEnc encoding of the stream
+ * @param prologEnc encoding of the prolog
* @return XML stream
+ * @throws IOException If an I/O error occurs
*/
protected InputStream getXmlStream(final String bomType, final String
xmlType,
final String streamEnc, final String prologEnc) throws IOException
{
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/XmlStreamReaderUtilitiesTest.java
Wed May 20 18:36:40 2015
@@ -47,7 +47,6 @@ public class XmlStreamReaderUtilitiesTes
private static String APPXML_UTF32LE = "application/xml;charset=UTF-32LE";
private static String TXTXML = "text/xml";
- /** Test for {@link XmlStreamReader#getContentTypeEncoding(String)}. */
@Test
public void testContentTypeEncoding() {
checkContentTypeEncoding(null, null);
@@ -71,7 +70,6 @@ public class XmlStreamReaderUtilitiesTes
assertEquals("ContentTypeEncoding=[" + httpContentType + "]",
expected, XmlStreamReader.getContentTypeEncoding(httpContentType));
}
- /** Test for {@link XmlStreamReader#getContentTypeEncoding(String)}. */
@Test
public void testContentTypeMime() {
checkContentTypeMime(null, null);
@@ -86,7 +84,6 @@ public class XmlStreamReaderUtilitiesTes
assertEquals("ContentTypeMime=[" + httpContentType + "]", expected,
XmlStreamReader.getContentTypeMime(httpContentType));
}
- /** Test for {@link XmlStreamReader#isAppXml(String)}. */
@Test
public void testAppXml() {
checkAppXml(false, null);
@@ -108,7 +105,6 @@ public class XmlStreamReaderUtilitiesTes
assertEquals("Mime=[" + mime + "]", expected,
XmlStreamReader.isAppXml(mime));
}
- /** Test for {@link XmlStreamReader#isTextXml(String)}. */
@Test
public void testTextXml() {
checkTextXml(false, null);
@@ -127,7 +123,6 @@ public class XmlStreamReaderUtilitiesTes
assertEquals("Mime=[" + mime + "]", expected,
XmlStreamReader.isTextXml(mime));
}
- /** No BOM calculateRawEncoding() Test */
@Test
public void testCalculateRawEncodingNoBOM() throws IOException {
// No BOM Expected BOM Guess XML
Default
@@ -146,7 +141,6 @@ public class XmlStreamReaderUtilitiesTes
checkRawEncoding("UTF-16LE", null, "UTF-16LE", "UTF-16", null);
}
- /** BOM calculateRawEncoding() Test */
@Test
public void testCalculateRawEncodingStandard() throws IOException {
// Standard BOM Checks BOM Other Default
@@ -155,7 +149,6 @@ public class XmlStreamReaderUtilitiesTes
testCalculateRawEncodingStandard("UTF-16LE", "UTF-8", "UTF-16BE");
}
- /** BOM calculateRawEncoding() Test */
@Test
//@Ignore
public void testCalculateRawEncodingStandardUtf32() throws IOException {
@@ -178,7 +171,6 @@ public class XmlStreamReaderUtilitiesTes
}
- /** Additional UTF-16 calculateRawEncoding() Test */
@Test
public void testCalculateRawEncodingAdditonalUTF16() throws IOException {
// BOM Guess XML
Default
@@ -194,7 +186,6 @@ public class XmlStreamReaderUtilitiesTes
checkRawError(RAWMGS1, "UTF-16LE", "UTF-16LE", "UTF-16BE", null);
}
- /** Additional UTF-32 calculateRawEncoding() Test */
@Test
public void testCalculateRawEncodingAdditonalUTF32() throws IOException {
// BOM Guess XML
Default
@@ -248,7 +239,6 @@ public class XmlStreamReaderUtilitiesTes
}
}
- /** Test calculate HTTP Encoding */
@Test
public void testCalculateHttpEncoding() throws IOException {
// No BOM Expected Lenient cType BOM
Guess XML Default
@@ -274,9 +264,7 @@ public class XmlStreamReaderUtilitiesTes
checkHttpEncoding("UTF-8", false, APPXML_UTF8, "UTF-16BE",
"UTF-16BE", "UTF-16BE", "UTF-16BE");
}
- /** Test calculate HTTP Encoding */
@Test
- //@Ignore
public void testCalculateHttpEncodingUtf32() throws IOException {
// No BOM Expected Lenient cType BOM
Guess XML Default
checkHttpEncoding("UTF-32LE", true, null, null,
null, "UTF-32LE", null);
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/input/compatibility/XmlStreamReader.java
Wed May 20 18:36:40 2015
@@ -304,6 +304,7 @@ public class XmlStreamReader extends Rea
* the charset encoding.
* @param lenient indicates if the charset encoding detection should be
* relaxed.
+ * @param defaultEncoding the default encoding to use
* @throws IOException thrown if there is a problem reading the file.
* @throws XmlStreamReaderException thrown if the charset encoding could
not
* be determined according to the specs.
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/monitor/AbstractMonitorTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/monitor/AbstractMonitorTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/monitor/AbstractMonitorTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/monitor/AbstractMonitorTestCase.java
Wed May 20 18:36:40 2015
@@ -101,6 +101,8 @@ public abstract class AbstractMonitorTes
/**
* Check all the Collections are empty
+ *
+ * @param label the label to use for this check
*/
protected void checkCollectionsEmpty(final String label) {
checkCollectionSizes("EMPTY-" + label, 0, 0, 0, 0, 0, 0);
@@ -108,8 +110,22 @@ public abstract class AbstractMonitorTes
/**
* Check all the Collections have the expected sizes.
+ *
+ * @param label the label to use for this check
+ * @param dirCreate expected number of dirs created
+ * @param dirChange expected number of dirs changed
+ * @param dirDelete expected number of dirs deleted
+ * @param fileCreate expected number of files created
+ * @param fileChange expected number of files changed
+ * @param fileDelete expected number of files deleted
*/
- protected void checkCollectionSizes(String label, final int dirCreate,
final int dirChange, final int dirDelete, final int fileCreate, final int
fileChange, final int fileDelete) {
+ protected void checkCollectionSizes(String label,
+ final int dirCreate,
+ final int dirChange,
+ final int dirDelete,
+ final int fileCreate,
+ final int fileChange,
+ final int fileDelete) {
label = label + "[" + listener.getCreatedDirectories().size() +
" " + listener.getChangedDirectories().size() +
" " + listener.getDeletedDirectories().size() +
@@ -150,6 +166,8 @@ public abstract class AbstractMonitorTes
/**
* Thread.sleep(timeInMilliseconds) - ignore InterruptedException
+ *
+ * @param timeInMilliseconds the time to sleep
*/
protected void sleepHandleInterruped(final long timeInMilliseconds) {
try {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CloseShieldOutputStreamTest.java
Wed May 20 18:36:40 2015
@@ -44,9 +44,6 @@ public class CloseShieldOutputStreamTest
closed = false;
}
- /**
- * Test the <code>close()</code> method.
- */
public void testClose() throws IOException {
shielded.close();
assertFalse("closed", closed);
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/CountingOutputStreamTest.java
Wed May 20 18:36:40 2015
@@ -74,7 +74,7 @@ public class CountingOutputStreamTest ex
cos.close();
}
- /**
+ /*
* Test for files > 2GB in size - see issue IO-84
*/
public void testLargeFiles_IO84() throws Exception {
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/ProxyWriterTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/ProxyWriterTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/ProxyWriterTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/ProxyWriterTest.java
Wed May 20 18:36:40 2015
@@ -29,7 +29,6 @@ public class ProxyWriterTest extends Tes
super(name);
}
- /** Test Appending a CharSequence */
public void testAppendCharSequence() throws Exception {
final StringBuilderWriter writer = new StringBuilderWriter();
final ProxyWriter proxy = new ProxyWriter(writer);
@@ -42,7 +41,6 @@ public class ProxyWriterTest extends Tes
proxy.close();
}
- /** Test Writing a String */
public void testWriteString() throws Exception {
final StringBuilderWriter writer = new StringBuilderWriter();
final ProxyWriter proxy = new ProxyWriter(writer);
@@ -55,7 +53,6 @@ public class ProxyWriterTest extends Tes
proxy.close();
}
- /** Test Writing a Partial String */
public void testWriteStringPartial() throws Exception {
final StringBuilderWriter writer = new StringBuilderWriter();
final ProxyWriter proxy = new ProxyWriter(writer);
@@ -68,7 +65,6 @@ public class ProxyWriterTest extends Tes
proxy.close();
}
- /** Test Writing a Char array */
public void testWriteCharArray() throws Exception {
final StringBuilderWriter writer = new StringBuilderWriter();
final ProxyWriter proxy = new ProxyWriter(writer);
@@ -81,7 +77,6 @@ public class ProxyWriterTest extends Tes
proxy.close();
}
- /** Test Writing a Partial Char array */
public void testWriteCharArrayPartial() throws Exception {
final StringBuilderWriter writer = new StringBuilderWriter();
final ProxyWriter proxy = new ProxyWriter(writer);
@@ -94,7 +89,6 @@ public class ProxyWriterTest extends Tes
proxy.close();
}
- /** Test writing Null String */
public void testNullString() throws Exception {
final ProxyWriter proxy = new ProxyWriter(new NullWriter());
@@ -113,7 +107,6 @@ public class ProxyWriterTest extends Tes
proxy.close();
}
- /** Test writing Null Char array */
public void testNullCharArray() throws Exception {
final ProxyWriter proxy = new ProxyWriter(new NullWriter());
@@ -132,7 +125,6 @@ public class ProxyWriterTest extends Tes
proxy.close();
}
- /** Test appending Null CharSequence */
public void testNullCharSequencec() throws Exception {
final ProxyWriter proxy = new ProxyWriter(new NullWriter());
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/StringBuilderWriterTest.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/StringBuilderWriterTest.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/StringBuilderWriterTest.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/output/StringBuilderWriterTest.java
Wed May 20 18:36:40 2015
@@ -29,15 +29,10 @@ import junit.framework.TestCase;
public class StringBuilderWriterTest extends TestCase {
private static final char[] FOOBAR_CHARS = new char[] {'F', 'o', 'o', 'B',
'a', 'r'};
- /**
- * Contruct a new test case.
- * @param name The name of the test
- */
public StringBuilderWriterTest(final String name) {
super(name);
}
- /** Test {@link StringBuilderWriter} constructor. */
public void testAppendConstructCapacity() throws IOException {
final Writer writer = new StringBuilderWriter(100);
writer.append("Foo");
@@ -45,7 +40,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link StringBuilderWriter} constructor. */
public void testAppendConstructStringBuilder() {
final StringBuilder builder = new StringBuilder("Foo");
final StringBuilderWriter writer = new StringBuilderWriter(builder);
@@ -55,7 +49,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link StringBuilderWriter} constructor. */
public void testAppendConstructNull() throws IOException {
final Writer writer = new StringBuilderWriter((StringBuilder)null);
writer.append("Foo");
@@ -63,7 +56,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#append(char)}. */
public void testAppendChar() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.append('F').append('o').append('o');
@@ -71,7 +63,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#append(CharSequence)}. */
public void testAppendCharSequence() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.append("Foo").append("Bar");
@@ -79,7 +70,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#append(CharSequence, int, int)}. */
public void testAppendCharSequencePortion() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.append("FooBar", 3, 6).append(new StringBuffer("FooBar"), 0, 3);
@@ -87,7 +77,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#close()}. */
public void testClose() {
final Writer writer = new StringBuilderWriter();
try {
@@ -100,7 +89,6 @@ public class StringBuilderWriterTest ext
assertEquals("FooBar", writer.toString());
}
- /** Test {@link Writer#write(int)}. */
public void testWriteChar() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.write('F');
@@ -112,7 +100,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#write(char[])}. */
public void testWriteCharArray() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.write(new char[] {'F', 'o', 'o'});
@@ -122,7 +109,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#write(char[], int, int)}. */
public void testWriteCharArrayPortion() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.write(FOOBAR_CHARS, 3, 3);
@@ -132,7 +118,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#write(String)}. */
public void testWriteString() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.write("Foo");
@@ -142,7 +127,6 @@ public class StringBuilderWriterTest ext
writer.close();
}
- /** Test {@link Writer#write(String, int, int)}. */
public void testWriteStringPortion() throws IOException {
final Writer writer = new StringBuilderWriter();
writer.write("FooBar", 3, 3);
Modified:
commons/proper/io/trunk/src/test/java/org/apache/commons/io/testtools/FileBasedTestCase.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/test/java/org/apache/commons/io/testtools/FileBasedTestCase.java?rev=1680650&r1=1680649&r2=1680650&view=diff
==============================================================================
---
commons/proper/io/trunk/src/test/java/org/apache/commons/io/testtools/FileBasedTestCase.java
(original)
+++
commons/proper/io/trunk/src/test/java/org/apache/commons/io/testtools/FileBasedTestCase.java
Wed May 20 18:36:40 2015
@@ -159,7 +159,14 @@ public abstract class FileBasedTestCase
}
}
- /** Assert that the content of a file is equal to that in a byte[]. */
+ /**
+ * Assert that the content of a file is equal to that in a byte[].
+ *
+ * @param b0 the expected contents
+ * @param file the file to check
+ *
+ * @throws IOException If an I/O error occurs while reading the file
contents
+ */
protected void assertEqualContent(final byte[] b0, final File file) throws
IOException {
final InputStream is = new java.io.FileInputStream(file);
int count = 0, numRead = 0;
@@ -178,7 +185,14 @@ public abstract class FileBasedTestCase
}
}
- /** Assert that the content of a file is equal to that in a char[]. */
+ /**
+ * Assert that the content of a file is equal to that in a char[].
+ *
+ * @param c0 the expected contents
+ * @param file the file to check
+ *
+ * @throws IOException If an I/O error occurs while reading the file
contents
+ */
protected void assertEqualContent(final char[] c0, final File file) throws
IOException {
final Reader ir = new java.io.FileReader(file);
int count = 0, numRead = 0;
