Author: sebb
Date: Sat Mar 28 00:03:11 2009
New Revision: 759397
URL: http://svn.apache.org/viewvc?rev=759397&view=rev
Log:
These classes are immutable, i.e. thread-safe
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/cpio/CpioUtil.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/FallbackZipEncoding.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.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/utils/IOUtils.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=759397&r1=759396&r2=759397&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
Sat Mar 28 00:03:11 2009
@@ -40,7 +40,7 @@
* implementation from super of course)
*
* TODO add example here
- *
+ * @Immutable
*/
public class ArchiveStreamFactory {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/cpio/CpioUtil.java
Sat Mar 28 00:03:11 2009
@@ -18,6 +18,11 @@
*/
package org.apache.commons.compress.archivers.cpio;
+/**
+ * Package private utility class for Cpio
+ *
+ * @Immutable
+ */
class CpioUtil {
/**
* Converts a byte array to a long. Halfwords can be swaped with setting
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=759397&r1=759396&r2=759397&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
Sat Mar 28 00:03:11 2009
@@ -21,6 +21,7 @@
/**
* This class provides static utility methods to work with byte streams.
*
+ * @Immutable
*/
// CheckStyle:HideUtilityClassConstructorCheck OFF (bc)
public class TarUtils {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/FallbackZipEncoding.java
Sat Mar 28 00:03:11 2009
@@ -38,6 +38,7 @@
* available.</p>
*
* <p>The methods of this class are reentrant.</p>
+ * @Immutable
*/
class FallbackZipEncoding implements ZipEncoding {
private final String charset;
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/JarMarker.java
Sat Mar 28 00:03:11 2009
@@ -22,6 +22,7 @@
/**
* If this extra field is added as the very first extra field of the
* archive, Solaris will consider it an executable jar file.
+ * @Immutable
*/
public final class JarMarker implements ZipExtraField {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/NioZipEncoding.java
Sat Mar 28 00:03:11 2009
@@ -36,6 +36,7 @@
* implementation, most notably the default ZIP encoding Cp437.</p>
*
* <p>The methods of this class are reentrant.</p>
+ * @Immutable
*/
class NioZipEncoding implements ZipEncoding {
private final Charset charset;
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipLong.java
Sat Mar 28 00:03:11 2009
@@ -20,6 +20,7 @@
/**
* Utility class that represents a four byte integer with conversion
* rules for the big endian byte order of ZIP files.
+ * @Immutable
*/
public final class ZipLong implements Cloneable {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipShort.java
Sat Mar 28 00:03:11 2009
@@ -20,7 +20,7 @@
/**
* Utility class that represents a two byte integer with conversion
* rules for the big endian byte order of ZIP files.
- *
+ * @Immutable
*/
public final class ZipShort implements Cloneable {
private static final int BYTE_MASK = 0xFF;
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/Change.java
Sat Mar 28 00:03:11 2009
@@ -22,7 +22,9 @@
import org.apache.commons.compress.archivers.ArchiveEntry;
-
+/**
+ * @Immutable
+ */
public class Change {
private final String targetFile;
private final ArchiveEntry entry;
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=759397&r1=759396&r2=759397&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
Sat Mar 28 00:03:11 2009
@@ -33,7 +33,7 @@
* appropriate methods (and call their implementation from super of course)
*
* TODO add example here
- *
+ * @Immutable
*/
public class CompressorStreamFactory {
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/IOUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/IOUtils.java?rev=759397&r1=759396&r2=759397&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/IOUtils.java
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/IOUtils.java
Sat Mar 28 00:03:11 2009
@@ -22,6 +22,10 @@
import java.io.InputStream;
import java.io.OutputStream;
+/**
+ * Utility functions
+ * @Immutable
+ */
public final class IOUtils {
/**