You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2010/05/12 20:18:19 UTC
svn commit: r943610 - in
/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress:
archivers/ar/ archivers/cpio/ archivers/tar/ archivers/zip/
compressors/bzip2/ compressors/gzip/
Author: sebb
Date: Wed May 12 18:18:19 2010
New Revision: 943610
URL: http://svn.apache.org/viewvc?rev=943610&view=rev
Log:
Javadoc tidyup
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveEntry.java Wed May 12 18:18:19 2010
@@ -113,10 +113,12 @@ public class ArArchiveEntry implements A
0, 0, DEFAULT_MODE, inputFile.lastModified() / 1000);
}
+ /** {@inheritDoc} */
public long getSize() {
return this.getLength();
}
+ /** {@inheritDoc} */
public String getName() {
return name;
}
@@ -149,13 +151,12 @@ public class ArArchiveEntry implements A
return length;
}
+ /** {@inheritDoc} */
public boolean isDirectory() {
return false;
}
- /* (non-Javadoc)
- * @see java.lang.Object#hashCode()
- */
+ /** {@inheritDoc} */
public int hashCode() {
final int prime = 31;
int result = 1;
@@ -163,9 +164,7 @@ public class ArArchiveEntry implements A
return result;
}
- /* (non-Javadoc)
- * @see java.lang.Object#equals(java.lang.Object)
- */
+ /** {@inheritDoc} */
public boolean equals(Object obj) {
if (this == obj) {
return true;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ar/ArArchiveOutputStream.java Wed May 12 18:18:19 2010
@@ -52,6 +52,7 @@ public class ArArchiveOutputStream exten
return header.length;
}
+ /** {@inheritDoc} */
public void closeArchiveEntry() throws IOException {
if(finished) {
throw new IOException("Stream has already been finished");
@@ -66,6 +67,7 @@ public class ArArchiveOutputStream exten
haveUnclosedEntry = false;
}
+ /** {@inheritDoc} */
public void putArchiveEntry( final ArchiveEntry pEntry ) throws IOException {
if(finished) {
throw new IOException("Stream has already been finished");
@@ -168,6 +170,9 @@ public class ArArchiveOutputStream exten
entryOffset += len;
}
+ /**
+ * Calls finish if necessary, and then closes the OutputStream
+ */
public void close() throws IOException {
if(!finished) {
finish();
@@ -176,6 +181,7 @@ public class ArArchiveOutputStream exten
prevEntry = null;
}
+ /** {@inheritDoc} */
public ArchiveEntry createArchiveEntry(File inputFile, String entryName)
throws IOException {
if(finished) {
@@ -184,9 +190,7 @@ public class ArArchiveOutputStream exten
return new ArArchiveEntry(inputFile, entryName);
}
- /* (non-Javadoc)
- * @see org.apache.commons.compress.archivers.ArchiveOutputStream#finish()
- */
+ /** {@inheritDoc} */
public void finish() throws IOException {
if(haveUnclosedEntry) {
throw new IOException("This archive contains unclosed entries.");
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveInputStream.java Wed May 12 18:18:19 2010
@@ -419,6 +419,7 @@ public class CpioArchiveInputStream exte
return total;
}
+ /** {@inheritDoc} */
public ArchiveEntry getNextEntry() throws IOException {
return getNextCPIOEntry();
}
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveOutputStream.java Wed May 12 18:18:19 2010
@@ -339,6 +339,7 @@ public class TarArchiveOutputStream exte
out.flush();
}
+ /** {@inheritDoc} */
public ArchiveEntry createArchiveEntry(File inputFile, String entryName)
throws IOException {
if(finished) {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/AbstractUnicodeExtraField.java Wed May 12 18:18:19 2010
@@ -114,6 +114,7 @@ public abstract class AbstractUnicodeExt
data = null;
}
+ /** {@inheritDoc} */
public byte[] getCentralDirectoryData() {
if (data == null) {
this.assembleData();
@@ -121,6 +122,7 @@ public abstract class AbstractUnicodeExt
return data;
}
+ /** {@inheritDoc} */
public ZipShort getCentralDirectoryLength() {
if (data == null) {
assembleData();
@@ -128,14 +130,17 @@ public abstract class AbstractUnicodeExt
return new ZipShort(data.length);
}
+ /** {@inheritDoc} */
public byte[] getLocalFileDataData() {
return getCentralDirectoryData();
}
+ /** {@inheritDoc} */
public ZipShort getLocalFileDataLength() {
return getCentralDirectoryLength();
}
+ /** {@inheritDoc} */
public void parseFromLocalFileData(byte[] buffer, int offset, int length)
throws ZipException {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodeCommentExtraField.java Wed May 12 18:18:19 2010
@@ -68,6 +68,7 @@ public class UnicodeCommentExtraField ex
super(comment, bytes);
}
+ /** {@inheritDoc} */
public ZipShort getHeaderId() {
return UCOM_ID;
}
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnicodePathExtraField.java Wed May 12 18:18:19 2010
@@ -67,6 +67,7 @@ public class UnicodePathExtraField exten
super(name, bytes);
}
+ /** {@inheritDoc} */
public ZipShort getHeaderId() {
return UPATH_ID;
}
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java Wed May 12 18:18:19 2010
@@ -207,6 +207,7 @@ public class ZipArchiveInputStream exten
return current;
}
+ /** {@inheritDoc} */
public ArchiveEntry getNextEntry() throws IOException {
return getNextZipEntry();
}
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveOutputStream.java Wed May 12 18:18:19 2010
@@ -333,9 +333,7 @@ public class ZipArchiveOutputStream exte
fallbackToUTF8 = b;
}
- /* (non-Javadoc)
- * @see org.apache.commons.compress.archivers.ArchiveOutputStream#finish()
- */
+ /** {@inheritDoc} */
public void finish() throws IOException {
if (finished) {
throw new IOException("This archive has already been finished");
@@ -425,8 +423,10 @@ public class ZipArchiveOutputStream exte
entry = null;
}
- /** {@inheritDoc} */
- // @throws ClassCastException if entry is not an instance of ZipArchiveEntry
+ /**
+ * {@inheritDoc}
+ * @throws ClassCastException if entry is not an instance of ZipArchiveEntry
+ */
public void putArchiveEntry(ArchiveEntry archiveEntry) throws IOException {
if (finished) {
throw new IOException("Stream has already been finished");
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorInputStream.java Wed May 12 18:18:19 2010
@@ -112,11 +112,7 @@ public class BZip2CompressorInputStream
init();
}
- /*
- * (non-Javadoc)
- *
- * @see java.io.InputStream#read()
- */
+ /** {@inheritDoc} */
public int read() throws IOException {
if (this.in != null) {
return read0();
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2CompressorOutputStream.java Wed May 12 18:18:19 2010
@@ -431,6 +431,7 @@ public class BZip2CompressorOutputStream
init();
}
+ /** {@inheritDoc} */
public void write(final int b) throws IOException {
if (this.out != null) {
write0(b);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorInputStream.java Wed May 12 18:18:19 2010
@@ -43,9 +43,7 @@ public class GzipCompressorInputStream e
in = new GZIPInputStream(inputStream);
}
- /* (non-Javadoc)
- * @see java.io.InputStream#read()
- */
+ /** {@inheritDoc} */
public int read() throws IOException {
int read = in.read();
this.count(read < 0 ? -1 : 1);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java?rev=943610&r1=943609&r2=943610&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/gzip/GzipCompressorOutputStream.java Wed May 12 18:18:19 2010
@@ -32,6 +32,7 @@ public class GzipCompressorOutputStream
out = new GZIPOutputStream(outputStream);
}
+ /** {@inheritDoc} */
public void write(int b) throws IOException {
out.write(b);
}