Author: niallp
Date: Tue Jan 8 06:50:59 2008
New Revision: 610010
URL: http://svn.apache.org/viewvc?rev=610010&view=rev
Log:
Checkstyle/javadoc only - @see no longer works since checkstyle 4 - see
http://tinyurl.com/2x8cev
Modified:
commons/proper/io/trunk/pom.xml
commons/proper/io/trunk/src/java/org/apache/commons/io/input/AutoCloseInputStream.java
commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyInputStream.java
commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyReader.java
commons/proper/io/trunk/src/java/org/apache/commons/io/input/SwappedDataInputStream.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/FileWriterWithEncoding.java
commons/proper/io/trunk/src/java/org/apache/commons/io/output/LockableFileWriter.java
commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullOutputStream.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/ProxyOutputStream.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/TeeOutputStream.java
Modified: commons/proper/io/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/pom.xml?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
--- commons/proper/io/trunk/pom.xml (original)
+++ commons/proper/io/trunk/pom.xml Tue Jan 8 06:50:59 2008
@@ -308,6 +308,23 @@
</reportSet>
</reportSets>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <configuration>
+ <configLocation>checkstyle.xml</configLocation>
+ <enableRulesSummary>false</enableRulesSummary>
+ </configuration>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.3</version>
+ <configuration>
+ <links>http://java.sun.com/j2se/1.4.2/docs/api,</links>
+ </configuration>
+ </plugin>
+
</plugins>
</reporting>
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=610010&r1=610009&r2=610010&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
Tue Jan 8 06:50:59 2008
@@ -119,6 +119,7 @@
* Ensures that the stream is closed before it gets garbage-collected.
* As mentioned in [EMAIL PROTECTED] #close()}, this is a no-op if the
stream has
* already been closed.
+ * @throws Throwable if an error occurs
*/
protected void finalize() throws Throwable {
close();
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyInputStream.java?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
---
commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyInputStream.java
(original)
+++
commons/proper/io/trunk/src/java/org/apache/commons/io/input/ProxyInputStream.java
Tue Jan 8 06:50:59 2008
@@ -44,47 +44,84 @@
// the proxy is stored in a protected superclass variable named 'in'
}
- /** @see java.io.InputStream#read() */
+ /**
+ * Invokes the delegate's <code>read()</code> method.
+ * @return the byte read or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ */
public int read() throws IOException {
return in.read();
}
- /** @see java.io.InputStream#read(byte[]) */
+ /**
+ * Invokes the delegate's <code>read(byte[])</code> method.
+ * @param bts the buffer to read the bytes into
+ * @return the number of bytes read or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ */
public int read(byte[] bts) throws IOException {
return in.read(bts);
}
- /** @see java.io.InputStream#read(byte[], int, int) */
+ /**
+ * Invokes the delegate's <code>read(byte[], int, int)</code> method.
+ * @param bts the buffer to read the bytes into
+ * @param st The start offset
+ * @param end The number of bytes to read
+ * @return the number of bytes read or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ */
public int read(byte[] bts, int st, int end) throws IOException {
return in.read(bts, st, end);
}
- /** @see java.io.InputStream#skip(long) */
+ /**
+ * Invokes the delegate's <code>skip(long)</code> method.
+ * @param ln the number of bytes to skip
+ * @return the number of bytes to skipped or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ */
public long skip(long ln) throws IOException {
return in.skip(ln);
}
- /** @see java.io.InputStream#available() */
+ /**
+ * Invokes the delegate's <code>available()</code> method.
+ * @return the number of available bytes
+ * @throws IOException if an I/O error occurs
+ */
public int available() throws IOException {
return in.available();
}
- /** @see java.io.InputStream#close() */
+ /**
+ * Invokes the delegate's <code>close()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public void close() throws IOException {
in.close();
}
- /** @see java.io.InputStream#mark(int) */
+ /**
+ * Invokes the delegate's <code>mark(int)</code> method.
+ * @param idx read ahead limit
+ */
public synchronized void mark(int idx) {
in.mark(idx);
}
- /** @see java.io.InputStream#reset() */
+ /**
+ * Invokes the delegate's <code>reset()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public synchronized void reset() throws IOException {
in.reset();
}
- /** @see java.io.InputStream#markSupported() */
+ /**
+ * Invokes the delegate's <code>markSupported()</code> method.
+ * @return true if mark is supported, otherwise false
+ */
public boolean markSupported() {
return in.markSupported();
}
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=610010&r1=610009&r2=610010&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
Tue Jan 8 06:50:59 2008
@@ -44,47 +44,85 @@
// the proxy is stored in a protected superclass variable named 'in'
}
- /** @see java.io.Reader#read() */
+ /**
+ * Invokes the delegate's <code>read()</code> method.
+ * @return the character read or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ */
public int read() throws IOException {
return in.read();
}
- /** @see java.io.Reader#read(char[]) */
+ /**
+ * Invokes the delegate's <code>read(char[])</code> method.
+ * @param chr the 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
+ */
public int read(char[] chr) throws IOException {
return in.read(chr);
}
- /** @see java.io.Reader#read(char[], int, int) */
+ /**
+ * Invokes the delegate's <code>read(char[], int, int)</code> method.
+ * @param chr the buffer to read the characters into
+ * @param st The start offset
+ * @param end The number of bytes to read
+ * @return the number of characters read or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ */
public int read(char[] chr, int st, int end) throws IOException {
return in.read(chr, st, end);
}
- /** @see java.io.Reader#skip(long) */
+ /**
+ * Invokes the delegate's <code>skip(long)</code> method.
+ * @param ln the number of bytes to skip
+ * @return the number of bytes to skipped or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ */
public long skip(long ln) throws IOException {
return in.skip(ln);
}
- /** @see java.io.Reader#ready() */
+ /**
+ * Invokes the delegate's <code>ready()</code> method.
+ * @return true if the stream is ready to be read
+ * @throws IOException if an I/O error occurs
+ */
public boolean ready() throws IOException {
return in.ready();
}
- /** @see java.io.Reader#close() */
+ /**
+ * Invokes the delegate's <code>close()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public void close() throws IOException {
in.close();
}
- /** @see java.io.Reader#mark(int) */
+ /**
+ * Invokes the delegate's <code>mark(int)</code> method.
+ * @param idx read ahead limit
+ * @throws IOException if an I/O error occurs
+ */
public synchronized void mark(int idx) throws IOException {
in.mark(idx);
}
- /** @see java.io.Reader#reset() */
+ /**
+ * Invokes the delegate's <code>reset()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public synchronized void reset() throws IOException {
in.reset();
}
- /** @see java.io.Reader#markSupported() */
+ /**
+ * Invokes the delegate's <code>markSupported()</code> method.
+ * @return true if mark is supported, otherwise false
+ */
public boolean markSupported() {
return in.markSupported();
}
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/input/SwappedDataInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/input/SwappedDataInputStream.java?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
---
commons/proper/io/trunk/src/java/org/apache/commons/io/input/SwappedDataInputStream.java
(original)
+++
commons/proper/io/trunk/src/java/org/apache/commons/io/input/SwappedDataInputStream.java
Tue Jan 8 06:50:59 2008
@@ -47,49 +47,89 @@
super( input );
}
- /** @see java.io.DataInput#readBoolean() */
+ /**
+ * Return <code>[EMAIL PROTECTED] #readByte()} == 0</code>
+ * @return the true if the byte read is zero, otherwise false
+ * @throws IOException if an I/O error occurs
+ * @throws EOFException if an end of file is reached unexpectedly
+ */
public boolean readBoolean()
throws IOException, EOFException
{
return ( 0 == readByte() );
}
- /** @see java.io.DataInput#readByte() */
+ /**
+ * Invokes the delegate's <code>read()</code> method.
+ * @return the byte read or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ * @throws EOFException if an end of file is reached unexpectedly
+ */
public byte readByte()
throws IOException, EOFException
{
return (byte)in.read();
}
- /** @see java.io.DataInput#readChar() */
+ /**
+ * Reads a character delegating to [EMAIL PROTECTED] #readShort()}.
+ * @return the byte read or -1 if the end of stream
+ * @throws IOException if an I/O error occurs
+ * @throws EOFException if an end of file is reached unexpectedly
+ */
public char readChar()
throws IOException, EOFException
{
return (char)readShort();
}
- /** @see java.io.DataInput#readDouble() */
+ /**
+ * Delegates to [EMAIL PROTECTED]
EndianUtils#readSwappedDouble(InputStream)}.
+ * @return the read long
+ * @throws IOException if an I/O error occurs
+ * @throws EOFException if an end of file is reached unexpectedly
+ */
public double readDouble()
throws IOException, EOFException
{
return EndianUtils.readSwappedDouble( in );
}
- /** @see java.io.DataInput#readFloat() */
+ /**
+ * Delegates to [EMAIL PROTECTED]
EndianUtils#readSwappedFloat(InputStream)}.
+ * @return the read long
+ * @throws IOException if an I/O error occurs
+ * @throws EOFException if an end of file is reached unexpectedly
+ */
public float readFloat()
throws IOException, EOFException
{
return EndianUtils.readSwappedFloat( in );
}
- /** @see java.io.DataInput#readFully(byte[]) */
+ /**
+ * Invokes the delegate's <code>read(byte[] data, int, int)</code> method.
+ *
+ * @param data the buffer to read the bytes into
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public void readFully( byte[] data )
throws IOException, EOFException
{
readFully( data, 0, data.length );
}
- /** @see java.io.DataInput#readFully(byte[], int, int) */
+
+ /**
+ * Invokes the delegate's <code>read(byte[] data, int, int)</code> method.
+ *
+ * @param data the buffer to read the bytes into
+ * @param offset The start offset
+ * @param length The number of bytes to read
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public void readFully( byte[] data, int offset, int length )
throws IOException, EOFException
{
@@ -109,7 +149,12 @@
}
}
- /** @see java.io.DataInput#readInt() */
+ /**
+ * Delegates to [EMAIL PROTECTED]
EndianUtils#readSwappedInteger(InputStream)}.
+ * @return the read long
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public int readInt()
throws IOException, EOFException
{
@@ -117,9 +162,10 @@
}
/**
- * Not currently supported.
- *
- * @see java.io.DataInput#readLine()
+ * Not currently supported - throws [EMAIL PROTECTED]
UnsupportedOperationException}.
+ * @return the line read
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
*/
public String readLine()
throws IOException, EOFException
@@ -128,28 +174,48 @@
"Operation not supported: readLine()" );
}
- /** @see java.io.DataInput#readLong() */
+ /**
+ * Delegates to [EMAIL PROTECTED]
EndianUtils#readSwappedLong(InputStream)}.
+ * @return the read long
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public long readLong()
throws IOException, EOFException
{
return EndianUtils.readSwappedLong( in );
}
- /** @see java.io.DataInput#readShort() */
+ /**
+ * Delegates to [EMAIL PROTECTED]
EndianUtils#readSwappedShort(InputStream)}.
+ * @return the read long
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public short readShort()
throws IOException, EOFException
{
return EndianUtils.readSwappedShort( in );
}
- /** @see java.io.DataInput#readUnsignedByte() */
+ /**
+ * Invokes the delegate's <code>read()</code> method.
+ * @return the byte read or -1 if the end of stream
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public int readUnsignedByte()
throws IOException, EOFException
{
return in.read();
}
- /** @see java.io.DataInput#readUnsignedShort() */
+ /**
+ * Delegates to [EMAIL PROTECTED]
EndianUtils#readSwappedUnsignedShort(InputStream)}.
+ * @return the read long
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public int readUnsignedShort()
throws IOException, EOFException
{
@@ -157,9 +223,10 @@
}
/**
- * Not currently supported.
- *
- * @see java.io.DataInput#readUTF()
+ * Not currently supported - throws [EMAIL PROTECTED]
UnsupportedOperationException}.
+ * @return UTF String read
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
*/
public String readUTF()
throws IOException, EOFException
@@ -168,7 +235,13 @@
"Operation not supported: readUTF()" );
}
- /** @see java.io.DataInput#skipBytes(int) */
+ /**
+ * Invokes the delegate's <code>skip(int)</code> method.
+ * @param count the number of bytes to skip
+ * @return the number of bytes to skipped or -1 if the end of stream
+ * @throws EOFException if an end of file is reached unexpectedly
+ * @throws IOException if an I/O error occurs
+ */
public int skipBytes( int count )
throws IOException, EOFException
{
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=610010&r1=610009&r2=610010&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
Tue Jan 8 06:50:59 2008
@@ -131,7 +131,10 @@
}
/**
- * @see java.io.OutputStream#write(byte[], int, int)
+ * Write the bytes to byte array.
+ * @param b the bytes to write
+ * @param off The start offset
+ * @param len The number of bytes to write
*/
public void write(byte[] b, int off, int len) {
if ((off < 0)
@@ -161,7 +164,8 @@
}
/**
- * @see java.io.OutputStream#write(int)
+ * Write a byte to byte array.
+ * @param b the byte to write
*/
public synchronized void write(int b) {
int inBufferPos = count - filledBufferSum;
@@ -202,7 +206,8 @@
}
/**
- * @see java.io.ByteArrayOutputStream#size()
+ * Return the current size of the byte array.
+ * @return the current size of the byte array
*/
public synchronized int size() {
return count;
@@ -280,7 +285,7 @@
/**
* Gets the curent contents of this byte stream as a string.
- *
+ * @return the contents of the byte array as a String
* @see java.io.ByteArrayOutputStream#toString()
*/
public String toString() {
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
---
commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java
(original)
+++
commons/proper/io/trunk/src/java/org/apache/commons/io/output/FileWriterWithEncoding.java
Tue Jan 8 06:50:59 2008
@@ -251,37 +251,67 @@
}
//-----------------------------------------------------------------------
- /** @see java.io.Writer#write(int) */
+ /**
+ * Write a character.
+ * @param idx the character to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(int idx) throws IOException {
out.write(idx);
}
- /** @see java.io.Writer#write(char[]) */
+ /**
+ * Write the characters from an array.
+ * @param chr the characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(char[] chr) throws IOException {
out.write(chr);
}
- /** @see java.io.Writer#write(char[], int, int) */
+ /**
+ * Write the specified characters from an array.
+ * @param chr the characters to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(char[] chr, int st, int end) throws IOException {
out.write(chr, st, end);
}
- /** @see java.io.Writer#write(String) */
+ /**
+ * Write the characters from a string.
+ * @param str the string to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(String str) throws IOException {
out.write(str);
}
- /** @see java.io.Writer#write(String, int, int) */
+ /**
+ * Write the specified characters from a string.
+ * @param str the string to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(String str, int st, int end) throws IOException {
out.write(str, st, end);
}
- /** @see java.io.Writer#flush() */
+ /**
+ * Flush the stream.
+ * @throws IOException if an I/O error occurs
+ */
public void flush() throws IOException {
out.flush();
}
- /** @see java.io.Writer#close() */
+ /**
+ * Close the stream.
+ * @throws IOException if an I/O error occurs
+ */
public void close() throws IOException {
out.close();
}
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/output/LockableFileWriter.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/LockableFileWriter.java?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
---
commons/proper/io/trunk/src/java/org/apache/commons/io/output/LockableFileWriter.java
(original)
+++
commons/proper/io/trunk/src/java/org/apache/commons/io/output/LockableFileWriter.java
Tue Jan 8 06:50:59 2008
@@ -273,32 +273,59 @@
}
//-----------------------------------------------------------------------
- /** @see java.io.Writer#write(int) */
+ /**
+ * Write a character.
+ * @param idx the character to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(int idx) throws IOException {
out.write(idx);
}
- /** @see java.io.Writer#write(char[]) */
+ /**
+ * Write the characters from an array.
+ * @param chr the characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(char[] chr) throws IOException {
out.write(chr);
}
- /** @see java.io.Writer#write(char[], int, int) */
+ /**
+ * Write the specified characters from an array.
+ * @param chr the characters to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(char[] chr, int st, int end) throws IOException {
out.write(chr, st, end);
}
- /** @see java.io.Writer#write(String) */
+ /**
+ * Write the characters from a string.
+ * @param str the string to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(String str) throws IOException {
out.write(str);
}
- /** @see java.io.Writer#write(String, int, int) */
+ /**
+ * Write the specified characters from a string.
+ * @param str the string to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(String str, int st, int end) throws IOException {
out.write(str, st, end);
}
- /** @see java.io.Writer#flush() */
+ /**
+ * Flush the stream.
+ * @throws IOException if an I/O error occurs
+ */
public void flush() throws IOException {
out.flush();
}
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullOutputStream.java?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
---
commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullOutputStream.java
(original)
+++
commons/proper/io/trunk/src/java/org/apache/commons/io/output/NullOutputStream.java
Tue Jan 8 06:50:59 2008
@@ -36,21 +36,27 @@
public static final NullOutputStream NULL_OUTPUT_STREAM = new
NullOutputStream();
/**
- * @see java.io.OutputStream#write(byte[], int, int)
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param b The bytes to write
+ * @param off The start offset
+ * @param len The number of bytes to write
*/
public void write(byte[] b, int off, int len) {
//to /dev/null
}
/**
- * @see java.io.OutputStream#write(int)
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param b The byte to write
*/
public void write(int b) {
//to /dev/null
}
/**
- * @see java.io.OutputStream#write(byte[])
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param b The bytes to write
+ * @throws IOException never
*/
public void write(byte[] b) throws IOException {
//to /dev/null
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=610010&r1=610009&r2=610010&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
Tue Jan 8 06:50:59 2008
@@ -39,27 +39,46 @@
public NullWriter() {
}
- /** @see java.io.Writer#write(int) */
+ /**
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param idx The character to write
+ */
public void write(int idx) {
//to /dev/null
}
- /** @see java.io.Writer#write(char[]) */
+ /**
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param chr The characters to write
+ */
public void write(char[] chr) {
//to /dev/null
}
- /** @see java.io.Writer#write(char[], int, int) */
+ /**
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param chr The characters to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ */
public void write(char[] chr, int st, int end) {
//to /dev/null
}
- /** @see java.io.Writer#write(String) */
+ /**
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param str The string to write
+ */
public void write(String str) {
//to /dev/null
}
- /** @see java.io.Writer#write(String, int, int) */
+ /**
+ * Does nothing - output to <code>/dev/null</code>.
+ * @param str The string to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ */
public void write(String str, int st, int end) {
//to /dev/null
}
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyOutputStream.java?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
---
commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyOutputStream.java
(original)
+++
commons/proper/io/trunk/src/java/org/apache/commons/io/output/ProxyOutputStream.java
Tue Jan 8 06:50:59 2008
@@ -41,27 +41,47 @@
// the proxy is stored in a protected superclass variable named 'out'
}
- /** @see java.io.OutputStream#write(int) */
+ /**
+ * Invokes the delegate's <code>write(int)</code> method.
+ * @param idx the byte to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(int idx) throws IOException {
out.write(idx);
}
- /** @see java.io.OutputStream#write(byte[]) */
+ /**
+ * Invokes the delegate's <code>write(byte[])</code> method.
+ * @param bts the bytes to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(byte[] bts) throws IOException {
out.write(bts);
}
- /** @see java.io.OutputStream#write(byte[], int, int) */
+ /**
+ * Invokes the delegate's <code>write(byte[])</code> method.
+ * @param bts the bytes to write
+ * @param st The start offset
+ * @param end The number of bytes to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(byte[] bts, int st, int end) throws IOException {
out.write(bts, st, end);
}
- /** @see java.io.OutputStream#flush() */
+ /**
+ * Invokes the delegate's <code>flush()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public void flush() throws IOException {
out.flush();
}
- /** @see java.io.OutputStream#close() */
+ /**
+ * Invokes the delegate's <code>close()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public void close() throws IOException {
out.close();
}
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=610010&r1=610009&r2=610010&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
Tue Jan 8 06:50:59 2008
@@ -43,37 +43,67 @@
// the proxy is stored in a protected superclass variable named 'out'
}
- /** @see java.io.Writer#write(int) */
+ /**
+ * Invokes the delegate's <code>write(int)</code> method.
+ * @param idx the character to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(int idx) throws IOException {
out.write(idx);
}
- /** @see java.io.Writer#write(char[]) */
+ /**
+ * Invokes the delegate's <code>write(char[])</code> method.
+ * @param chr the characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(char[] chr) throws IOException {
out.write(chr);
}
- /** @see java.io.Writer#write(char[], int, int) */
+ /**
+ * Invokes the delegate's <code>write(char[], int, int)</code> method.
+ * @param chr the characters to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(char[] chr, int st, int end) throws IOException {
out.write(chr, st, end);
}
- /** @see java.io.Writer#write(String) */
+ /**
+ * Invokes the delegate's <code>write(String)</code> method.
+ * @param str the string to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(String str) throws IOException {
out.write(str);
}
- /** @see java.io.Writer#write(String, int, int) */
+ /**
+ * Invokes the delegate's <code>write(String)</code> method.
+ * @param str the string to write
+ * @param st The start offset
+ * @param end The number of characters to write
+ * @throws IOException if an I/O error occurs
+ */
public void write(String str, int st, int end) throws IOException {
out.write(str, st, end);
}
- /** @see java.io.Writer#flush() */
+ /**
+ * Invokes the delegate's <code>flush()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public void flush() throws IOException {
out.flush();
}
- /** @see java.io.Writer#close() */
+ /**
+ * Invokes the delegate's <code>close()</code> method.
+ * @throws IOException if an I/O error occurs
+ */
public void close() throws IOException {
out.close();
}
Modified:
commons/proper/io/trunk/src/java/org/apache/commons/io/output/TeeOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/output/TeeOutputStream.java?rev=610010&r1=610009&r2=610010&view=diff
==============================================================================
---
commons/proper/io/trunk/src/java/org/apache/commons/io/output/TeeOutputStream.java
(original)
+++
commons/proper/io/trunk/src/java/org/apache/commons/io/output/TeeOutputStream.java
Tue Jan 8 06:50:59 2008
@@ -41,19 +41,33 @@
this.branch = branch;
}
- /** @see java.io.OutputStream#write(byte[]) */
+ /**
+ * Write the bytes to both streams.
+ * @param b the bytes to write
+ * @throws IOException if an I/O error occurs
+ */
public synchronized void write(byte[] b) throws IOException {
super.write(b);
this.branch.write(b);
}
- /** @see java.io.OutputStream#write(byte[], int, int) */
+ /**
+ * Write the specified bytes to both streams.
+ * @param b the bytes to write
+ * @param off The start offset
+ * @param len The number of bytes to write
+ * @throws IOException if an I/O error occurs
+ */
public synchronized void write(byte[] b, int off, int len) throws
IOException {
super.write(b, off, len);
this.branch.write(b, off, len);
}
- /** @see java.io.OutputStream#write(int) */
+ /**
+ * Write a byte to both streams.
+ * @param b the byte to write
+ * @throws IOException if an I/O error occurs
+ */
public synchronized void write(int b) throws IOException {
super.write(b);
this.branch.write(b);
@@ -61,8 +75,7 @@
/**
* Flushes both streams.
- *
- * @see java.io.OutputStream#flush()
+ * @throws IOException if an I/O error occurs
*/
public void flush() throws IOException {
super.flush();
@@ -71,8 +84,7 @@
/**
* Closes both streams.
- *
- * @see java.io.OutputStream#close()
+ * @throws IOException if an I/O error occurs
*/
public void close() throws IOException {
super.close();
