Author: sebb
Date: Mon May 10 17:36:40 2010
New Revision: 942826
URL: http://svn.apache.org/viewvc?rev=942826&view=rev
Log:
@since markers
Javadoc updates
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarConstants.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.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/compressors/CompressorInputStream.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/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/ArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveEntry.java
Mon May 10 17:36:40 2010
@@ -37,6 +37,10 @@ public interface ArchiveEntry {
/** True if the entry refers to a directory */
public boolean isDirectory();
- /** The last modified date of the entry */
+ /**
+ * The last modified date of the entry.
+ *
+ * @since Apache Commons Compress 1.1
+ */
public Date getLastModifiedDate();
}
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
Mon May 10 17:36:40 2010
@@ -250,6 +250,8 @@ public class CpioArchiveEntry implements
* CpioConstants.FORMAT_NEW_CRC<br/>
* CpioConstants.FORMAT_OLD_BINARY<br/>
* CpioConstants.FORMAT_OLD_ASCII<br/>
+ *
+ * @since Apache Commons Compress 1.1
*/
public CpioArchiveEntry(final short format, final String name) {
this(format);
@@ -286,6 +288,8 @@ public class CpioArchiveEntry implements
* CpioConstants.FORMAT_NEW_CRC<br/>
* CpioConstants.FORMAT_OLD_BINARY<br/>
* CpioConstants.FORMAT_OLD_ASCII<br/>
+ *
+ * @since Apache Commons Compress 1.1
*/
public CpioArchiveEntry(final short format, final String name,
final long size) {
@@ -324,6 +328,8 @@ public class CpioArchiveEntry implements
* CpioConstants.FORMAT_NEW_CRC<br/>
* CpioConstants.FORMAT_OLD_BINARY<br/>
* CpioConstants.FORMAT_OLD_ASCII<br/>
+ *
+ * @since Apache Commons Compress 1.1
*/
public CpioArchiveEntry(final short format, File inputFile,
String entryName) {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveOutputStream.java
Mon May 10 17:36:40 2010
@@ -107,6 +107,8 @@ public class CpioArchiveOutputStream ext
* The format of the stream
* @param blockSize
* The block size of the archive.
+ *
+ * @since Apache Commons Compress 1.1
*/
public CpioArchiveOutputStream(final OutputStream out, final short format,
final int blockSize) {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioConstants.java
Mon May 10 17:36:40 2010
@@ -135,6 +135,10 @@ public interface CpioConstants {
/** The special trailer marker */
final String CPIO_TRAILER = "TRAILER!!!";
- /** The default block size */
+ /**
+ * The default block size.
+ *
+ * @since Apache Commons Compress 1.1
+ */
final int BLOCK_SIZE = 512;
}
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveInputStream.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveInputStream.java
Mon May 10 17:36:40 2010
@@ -45,6 +45,16 @@ public class JarArchiveInputStream exten
return getNextJarEntry();
}
+ /**
+ * Checks if the signature matches what is expected for a jar file
+ * (in this case it is the same as for a zip file).
+ *
+ * @param signature
+ * the bytes to check
+ * @param length
+ * the number of bytes to check
+ * @return true, if this stream is a jar archive stream, false otherwise
+ */
public static boolean matches(byte[] signature, int length ) {
return ZipArchiveInputStream.matches(signature, length);
}
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
Mon May 10 17:36:40 2010
@@ -177,6 +177,8 @@ public class TarArchiveEntry implements
* @param name the entry name
* @param preserveLeadingSlashes whether to allow leading slashes
* in the name.
+ *
+ * @since Apache Commons Compress 1.1
*/
public TarArchiveEntry(String name, boolean preserveLeadingSlashes) {
this();
@@ -359,9 +361,13 @@ public class TarArchiveEntry implements
/**
* Set this entry's link name.
+ *
+ * @param link the link name to use.
+ *
+ * @since Apache Commons Compress 1.1
*/
public void setLinkName(String link) {
- linkName = link;
+ this.linkName = link;
}
/**
@@ -547,6 +553,8 @@ public class TarArchiveEntry implements
* Check if this is a Pax header.
*
* @return <code>true</code> if this is a Pax header.
+ *
+ * @since Apache Commons Compress 1.1
*/
public boolean isPaxHeader(){
return linkFlag == LF_PAX_EXTENDED_HEADER_LC
@@ -557,6 +565,8 @@ public class TarArchiveEntry implements
* Check if this is a Pax header.
*
* @return <code>true</code> if this is a Pax header.
+ *
+ * @since Apache Commons Compress 1.1
*/
public boolean isGlobalPaxHeader(){
return linkFlag == LF_PAX_GLOBAL_EXTENDED_HEADER;
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveInputStream.java
Mon May 10 17:36:40 2010
@@ -401,8 +401,15 @@ public class TarArchiveInputStream exten
hasHitEOF = b;
}
- // ArchiveInputStream
-
+ /**
+ * Checks if the signature matches what is expected for a tar file.
+ *
+ * @param signature
+ * the bytes to check
+ * @param length
+ * the number of bytes to check
+ * @return true, if this stream is a tar archive stream, false otherwise
+ */
public static boolean matches(byte[] signature, int length) {
if (length < TarConstants.VERSION_OFFSET+TarConstants.VERSIONLEN) {
return false;
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarConstants.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarConstants.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarConstants.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarConstants.java
Mon May 10 17:36:40 2010
@@ -155,12 +155,21 @@ public interface TarConstants {
/**
* Identifies the entry as a Pax extended header.
+ * @since Apache Commons Compress 1.1
*/
- byte LF_PAX_EXTENDED_HEADER_LC = (byte) 'x'; //
- byte LF_PAX_EXTENDED_HEADER_UC = (byte) 'X'; // SunOS tar -E
+ byte LF_PAX_EXTENDED_HEADER_LC = (byte) 'x';
+
+ /**
+ * Identifies the entry as a Pax extended header (SunOS tar -E).
+ *
+ * @since Apache Commons Compress 1.1
+ */
+ byte LF_PAX_EXTENDED_HEADER_UC = (byte) 'X';
/**
* Identifies the entry as a Pax global extended header.
+ *
+ * @since Apache Commons Compress 1.1
*/
byte LF_PAX_GLOBAL_EXTENDED_HEADER = (byte) 'g';
@@ -180,8 +189,16 @@ public interface TarConstants {
/**
* The magic tag representing an Ant tar archive.
+ *
+ * @since Apache Commons Compress 1.1
*/
String MAGIC_ANT = "ustar\0";
+
+ /**
+ * The "version" representing an Ant tar archive.
+ *
+ * @since Apache Commons Compress 1.1
+ */
// Does not appear to have a version, however Ant does write 8 bytes,
// so assume the version is 2 nulls
String VERSION_ANT = "\0\0";
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ExtraFieldUtils.java
Mon May 10 17:36:40 2010
@@ -120,6 +120,8 @@ public class ExtraFieldUtils {
* cannot be parsed.
* @return an array of ExtraFields
* @throws ZipException on error
+ *
+ * @since Apache Commons Compress 1.1
*/
public static ZipExtraField[] parse(byte[] data, boolean local,
UnparseableExtraField
onUnparseableData)
@@ -252,6 +254,8 @@ public class ExtraFieldUtils {
/**
* "enum" for the possible actions to take if the extra field
* cannot be parsed.
+ *
+ * @since Apache Commons Compress 1.1
*/
public static final class UnparseableExtraField {
/**
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnparseableExtraFieldData.java
Mon May 10 17:36:40 2010
@@ -25,6 +25,8 @@ package org.apache.commons.compress.arch
* {...@link <a href="http://www.pkware.com/documents/casestudies/APPNOTE.TXT";>
* APPNOTE.TXT</a>}). Since it isn't used anywhere except to satisfy the
* ZipExtraField contract it shouldn't matter anyway.</p>
+ *
+ * @since Apache Commons Compress 1.1
* @NotThreadSafe
*/
public final class UnparseableExtraFieldData implements ZipExtraField {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveEntry.java
Mon May 10 17:36:40 2010
@@ -172,6 +172,8 @@ public class ZipArchiveEntry extends jav
* compression method has not been specified.
*
* @return compression method
+ *
+ * @since Apache Commons Compress 1.1
*/
public int getMethod() {
return method;
@@ -181,6 +183,8 @@ public class ZipArchiveEntry extends jav
* Sets the compression method of this entry.
*
* @param method compression method
+ *
+ * @since Apache Commons Compress 1.1
*/
public void setMethod(int method) {
if (method < 0) {
@@ -297,6 +301,8 @@ public class ZipArchiveEntry extends jav
* extra fields as {...@link UnparseableExtraFieldData} if such data
* exists.
* @return an array of the extra fields
+ *
+ * @since Apache Commons Compress 1.1
*/
public ZipExtraField[] getExtraFields(boolean includeUnparseable) {
if (extraFields == null) {
@@ -369,6 +375,8 @@ public class ZipArchiveEntry extends jav
/**
* Removes unparseable extra field data.
+ *
+ * @since Apache Commons Compress 1.1
*/
public void removeUnparseableExtraFieldData() {
if (unparseableExtra == null) {
@@ -394,6 +402,8 @@ public class ZipArchiveEntry extends jav
* Looks up extra field data that couldn't be parsed correctly.
*
* @return null if no such field exists.
+ *
+ * @since Apache Commons Compress 1.1
*/
public UnparseableExtraFieldData getUnparseableExtraFieldData() {
return unparseableExtra;
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=942826&r1=942825&r2=942826&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
Mon May 10 17:36:40 2010
@@ -329,9 +329,16 @@ public class ZipArchiveInputStream exten
throw new IllegalArgumentException();
}
- /*
- * This test assumes that the zip file does not have any additional
leading content,
- * which is something that is allowed by the specification (e.g.
self-extracting zips)
+ /**
+ * Checks if the signature matches what is expected for a zip file.
+ * Does not currently handle self-extracting zips which may have arbitrary
+ * leading content.
+ *
+ * @param signature
+ * the bytes to check
+ * @param length
+ * the number of bytes to check
+ * @return true, if this stream is a zip archive stream, false otherwise
*/
public static boolean matches(byte[] signature, int length) {
if (length < ZipArchiveOutputStream.LFH_SIG.length) {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java?rev=942826&r1=942825&r2=942826&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorInputStream.java
Mon May 10 17:36:40 2010
@@ -28,6 +28,8 @@ public abstract class CompressorInputStr
* Doesn't increment if the EOF has been hit (read == -1)
*
* @param read the number of bytes read
+ *
+ * @since Apache Commons Compress 1.1
*/
protected void count(int read) {
count((long) read);
@@ -58,6 +60,8 @@ public abstract class CompressorInputStr
/**
* Returns the current number of bytes read from this stream.
* @return the number of read bytes
+ *
+ * @since Apache Commons Compress 1.1
*/
public long getBytesRead() {
return bytesRead;
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=942826&r1=942825&r2=942826&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
Mon May 10 17:36:40 2010
@@ -965,6 +965,17 @@ public class BZip2CompressorInputStream
}
+ /**
+ * Checks if the signature matches what is expected for a bzip2 file.
+ *
+ * @param signature
+ * the bytes to check
+ * @param length
+ * the number of bytes to check
+ * @return true, if this stream is a bzip2 compressed stream, false
otherwise
+ *
+ * @since Apache Commons Compress 1.1
+ */
public static boolean matches(byte[] signature, int length) {
if (length < 3) {
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=942826&r1=942825&r2=942826&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
Mon May 10 17:36:40 2010
@@ -52,8 +52,10 @@ public class GzipCompressorInputStream e
return read;
}
- /* (non-Javadoc)
- * @see java.io.InputStream#read(byte[])
+ /**
+ * {...@inheritdoc}
+ *
+ * @since Apache Commons Compress 1.1
*/
public int read(byte[] b) throws IOException {
int read = in.read(b);
@@ -61,8 +63,10 @@ public class GzipCompressorInputStream e
return read;
}
- /* (non-Javadoc)
- * @see java.io.InputStream#read(byte[], int, int)
+ /**
+ * {...@inheritdoc}
+ *
+ * @since Apache Commons Compress 1.1
*/
public int read(byte[] b, int from, int length) throws IOException {
int read = in.read(b, from, length);
@@ -70,6 +74,17 @@ public class GzipCompressorInputStream e
return read;
}
+ /**
+ * Checks if the signature matches what is expected for a gzip file.
+ *
+ * @param signature
+ * the bytes to check
+ * @param length
+ * the number of bytes to check
+ * @return true, if this stream is a gzipped compressed stream, false
otherwise
+ *
+ * @since Apache Commons Compress 1.1
+ */
public static boolean matches(byte[] signature, int length) {
if (length < 2) {
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=942826&r1=942825&r2=942826&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
Mon May 10 17:36:40 2010
@@ -36,10 +36,20 @@ public class GzipCompressorOutputStream
out.write(b);
}
+ /**
+ * {...@inheritdoc}
+ *
+ * @since Apache Commons Compress 1.1
+ */
public void write(byte[] b) throws IOException {
out.write(b);
}
+ /**
+ * {...@inheritdoc}
+ *
+ * @since Apache Commons Compress 1.1
+ */
public void write(byte[] b, int from, int length) throws IOException {
out.write(b, from, length);
}
