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 2013/03/11 15:14:48 UTC
svn commit: r1455148 - in
/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress:
archivers/ archivers/tar/ archivers/zip/ compressors/ compressors/bzip2/
compressors/xz/
Author: sebb
Date: Mon Mar 11 14:14:47 2013
New Revision: 1455148
URL: http://svn.apache.org/r1455148
Log:
@since: Standardise on number only; drop redundant component name
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.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/TarArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveStreamFactory.java Mon Mar 11 14:14:47 2013
@@ -75,32 +75,32 @@ public class ArchiveStreamFactory {
/**
* Constant used to identify the AR archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String AR = "ar";
/**
* Constant used to identify the CPIO archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String CPIO = "cpio";
/**
* Constant used to identify the Unix DUMP archive format.
- * @since Commons Compress 1.3
+ * @since 1.3
*/
public static final String DUMP = "dump";
/**
* Constant used to identify the JAR archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String JAR = "jar";
/**
* Constant used to identify the TAR archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String TAR = "tar";
/**
* Constant used to identify the ZIP archive format.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String ZIP = "zip";
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=1455148&r1=1455147&r2=1455148&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 Mar 11 14:14:47 2013
@@ -315,7 +315,7 @@ public class TarArchiveEntry implements
*
* @param headerBuf The header bytes from a tar archive entry.
* @param encoding encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @throws IllegalArgumentException if any of the numeric fields have an invalid format
*/
public TarArchiveEntry(byte[] headerBuf, ZipEncoding encoding)
@@ -922,7 +922,7 @@ public class TarArchiveEntry implements
*
* @param header The tar entry header buffer to get information from.
* @param encoding encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @throws IllegalArgumentException if any of the numeric fields
* have an invalid format
*/
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=1455148&r1=1455147&r2=1455148&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 Mar 11 14:14:47 2013
@@ -71,7 +71,7 @@ public class TarArchiveInputStream exten
* Constructor for TarInputStream.
* @param is the input stream to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveInputStream(InputStream is, String encoding) {
this(is, TarBuffer.DEFAULT_BLKSIZE, TarBuffer.DEFAULT_RCDSIZE, encoding);
@@ -91,7 +91,7 @@ public class TarArchiveInputStream exten
* @param is the input stream to use
* @param blockSize the block size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveInputStream(InputStream is, int blockSize,
String encoding) {
@@ -114,7 +114,7 @@ public class TarArchiveInputStream exten
* @param blockSize the block size to use
* @param recordSize the record size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveInputStream(InputStream is, int blockSize, int recordSize,
String encoding) {
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=1455148&r1=1455147&r2=1455148&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 Mon Mar 11 14:14:47 2013
@@ -99,7 +99,7 @@ public class TarArchiveOutputStream exte
* Constructor for TarInputStream.
* @param os the output stream to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveOutputStream(OutputStream os, String encoding) {
this(os, TarBuffer.DEFAULT_BLKSIZE, TarBuffer.DEFAULT_RCDSIZE, encoding);
@@ -119,7 +119,7 @@ public class TarArchiveOutputStream exte
* @param os the output stream to use
* @param blockSize the block size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveOutputStream(OutputStream os, int blockSize,
String encoding) {
@@ -142,7 +142,7 @@ public class TarArchiveOutputStream exte
* @param blockSize the block size to use
* @param recordSize the record size to use
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public TarArchiveOutputStream(OutputStream os, int blockSize,
int recordSize, String encoding) {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/TarUtils.java Mon Mar 11 14:14:47 2013
@@ -277,7 +277,7 @@ public class TarUtils {
* @param offset The offset into the buffer from which to parse.
* @param length The maximum number of bytes to parse.
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @return The entry name.
*/
public static String parseName(byte[] buffer, final int offset,
@@ -342,7 +342,7 @@ public class TarUtils {
* @param offset The starting offset into the buffer
* @param length The maximum number of header bytes to copy.
* @param encoding name of the encoding to use for file names
- * @since Commons Compress 1.4
+ * @since 1.4
* @return The updated offset, i.e. offset + length
*/
public static int formatNameBytes(String name, byte[] buf, final int offset,
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/UnsupportedZipFeatureException.java Mon Mar 11 14:14:47 2013
@@ -23,7 +23,7 @@ import java.util.zip.ZipException;
/**
* Exception thrown when attempting to read or write data for a zip
* entry that uses ZIP features not supported by this library.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public class UnsupportedZipFeatureException extends ZipException {
@@ -88,7 +88,7 @@ public class UnsupportedZipFeatureExcept
/**
* ZIP Features that may or may not be supported.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static class Feature {
/**
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipFile.java Mon Mar 11 14:14:47 2013
@@ -284,7 +284,7 @@ public class ZipFile {
*
* @return all entries as {@link ZipArchiveEntry} instances
*
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public Enumeration<ZipArchiveEntry> getEntriesInPhysicalOrder() {
ZipArchiveEntry[] allEntries =
@@ -992,7 +992,7 @@ public class ZipFile {
* <p>Won't return any meaningful results if one of the entries
* isn't part of the archive at all.</p>
*
- * @since Commons Compress 1.1
+ * @since 1.1
*/
private final Comparator<ZipArchiveEntry> OFFSET_COMPARATOR =
new Comparator<ZipArchiveEntry>() {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java Mon Mar 11 14:14:47 2013
@@ -62,24 +62,24 @@ public class CompressorStreamFactory {
/**
* Constant used to identify the BZIP2 compression algorithm.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String BZIP2 = "bzip2";
/**
* Constant used to identify the GZIP compression algorithm.
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public static final String GZIP = "gz";
/**
* Constant used to identify the PACK200 compression algorithm.
- * @since Commons Compress 1.3
+ * @since 1.3
*/
public static final String PACK200 = "pack200";
/**
* Constant used to identify the XZ compression method.
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public static final String XZ = "xz";
@@ -111,7 +111,7 @@ public class CompressorStreamFactory {
* @return the compressor input stream
* @throws CompressorException if the compressor name is not known
* @throws IllegalArgumentException if the stream is null or does not support mark
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public CompressorInputStream createCompressorInputStream(final InputStream in)
throws CompressorException {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/bzip2/BZip2Utils.java Mon Mar 11 14:14:47 2013
@@ -25,7 +25,7 @@ import org.apache.commons.compress.compr
/**
* Utility code for the BZip2 compression format.
* @ThreadSafe
- * @since Commons Compress 1.1
+ * @since 1.1
*/
public abstract class BZip2Utils {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorInputStream.java Mon Mar 11 14:14:47 2013
@@ -28,7 +28,7 @@ import org.apache.commons.compress.compr
/**
* XZ decompressor.
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public class XZCompressorInputStream extends CompressorInputStream {
private final InputStream in;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZCompressorOutputStream.java Mon Mar 11 14:14:47 2013
@@ -27,7 +27,7 @@ import org.apache.commons.compress.compr
/**
* XZ compressor.
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public class XZCompressorOutputStream extends CompressorOutputStream {
private final XZOutputStream out;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java?rev=1455148&r1=1455147&r2=1455148&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java Mon Mar 11 14:14:47 2013
@@ -25,7 +25,7 @@ import org.apache.commons.compress.compr
/**
* Utility code for the xz compression format.
* @ThreadSafe
- * @since Commons Compress 1.4
+ * @since 1.4
*/
public class XZUtils {