Author: bodewig Date: Sun Mar 10 16:37:16 2013 New Revision: 1454874 URL: http://svn.apache.org/r1454874 Log: Add a bunch of since markers
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.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/TarConstants.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/X5455_ExtendedTimestamp.java commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.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/ZipFile.java commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetPerformer.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/jar/JarArchiveEntry.java URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java?rev=1454874&r1=1454873&r2=1454874&view=diff ============================================================================== --- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java (original) +++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java Sun Mar 10 16:37:16 2013 @@ -57,7 +57,7 @@ public class JarArchiveEntry extends Zip * This method is not implemented and won't ever be. * The JVM equivalent has a different name {@link java.util.jar.JarEntry#getAttributes()} * - * @deprecated Do not use; always returns null + * @deprecated since 1.5, do not use; always returns null * @return Always returns null. */ @Deprecated @@ -70,7 +70,7 @@ public class JarArchiveEntry extends Zip * * @return Always returns null in the current implementation * - * @deprecated Not currently implemented + * @deprecated since 1.5, not currently implemented */ @Deprecated public Certificate[] getCertificates() { 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=1454874&r1=1454873&r2=1454874&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 Sun Mar 10 16:37:16 2013 @@ -238,7 +238,7 @@ public class TarArchiveEntry implements /** * Construct an entry with a name and a link flag. - * +s * * @param name the entry name * @param linkFlag the entry link flag. * @param preserveLeadingSlashes whether to allow leading slashes 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=1454874&r1=1454873&r2=1454874&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 Sun Mar 10 16:37:16 2013 @@ -70,6 +70,7 @@ public interface TarConstants { /** * Offset of the checksum field within header record. + * @since 1.5 */ int CHKSUM_OFFSET = 148; 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=1454874&r1=1454873&r2=1454874&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 Sun Mar 10 16:37:16 2013 @@ -64,6 +64,7 @@ public class UnsupportedZipFeatureExcept * feature. * * @param reason the feature that is not supported + * @since 1.5 */ public UnsupportedZipFeatureException(Feature reason) { super("unsupported feature " + reason + " used in archive."); Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java?rev=1454874&r1=1454873&r2=1454874&view=diff ============================================================================== --- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java (original) +++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java Sun Mar 10 16:37:16 2013 @@ -79,6 +79,7 @@ import java.util.zip.ZipException; * Flags Byte info bits (refers to local header!) * (ModTime) Long time of last modification (UTC/GMT) * </pre> + * @since 1.5 */ public class X5455_ExtendedTimestamp implements ZipExtraField, Cloneable, Serializable { private static final ZipShort HEADER_ID = new ZipShort(0x5455); @@ -557,4 +558,4 @@ public class X5455_ExtendedTimestamp imp return hc; } -} \ No newline at end of file +} Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java?rev=1454874&r1=1454873&r2=1454874&view=diff ============================================================================== --- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java (original) +++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/X7875_NewUnix.java Sun Mar 10 16:37:16 2013 @@ -42,6 +42,7 @@ import static org.apache.commons.compres * GIDSize 1 byte Size of GID field * GID Variable GID for this entry (little endian) * </pre> + * @since 1.5 */ public class X7875_NewUnix implements ZipExtraField, Cloneable, Serializable { private static final ZipShort HEADER_ID = new ZipShort(0x7875); 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=1454874&r1=1454873&r2=1454874&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 Sun Mar 10 16:37:16 2013 @@ -272,6 +272,7 @@ public class ZipArchiveEntry extends jav * in which case the entry's content contains the target path * for the symlink. * + * @since 1.5 * @return true if the entry represents a unix symlink, false otherwise. */ public boolean isUnixSymlink() { 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=1454874&r1=1454873&r2=1454874&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 Sun Mar 10 16:37:16 2013 @@ -364,6 +364,7 @@ public class ZipFile { * @param entry ZipArchiveEntry object that represents the symbolic link * @return entry's content as a String * @throws IOException problem with content's input stream + * @since 1.5 */ public String getUnixSymlink(ZipArchiveEntry entry) throws IOException { if (entry != null && entry.isUnixSymlink()) { Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java?rev=1454874&r1=1454873&r2=1454874&view=diff ============================================================================== --- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java (original) +++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java Sun Mar 10 16:37:16 2013 @@ -92,6 +92,7 @@ public abstract class ZipUtil { * * @return the reversed array (mutated in-place, but also returned for * convenience). + * @since 1.5 */ public static byte[] reverse(final byte[] array) { final int z = array.length - 1; // position of last element @@ -146,6 +147,7 @@ public abstract class ZipUtil { * * @param b byte to convert to int * @return int representation of the provided byte + * @since 1.5 */ public static int signedByteToUnsignedInt(byte b) { if (b >= 0) { @@ -161,6 +163,7 @@ public abstract class ZipUtil { * @param i integer to convert to byte * @return byte representation of the provided int * @throws IllegalArgumentException if the provided integer is not inside the range [0,255]. + * @since 1.5 */ public static byte unsignedIntToSignedByte(int i) { if (i > 255 || i < 0) { Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetPerformer.java URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetPerformer.java?rev=1454874&r1=1454873&r2=1454874&view=diff ============================================================================== --- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetPerformer.java (original) +++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/changes/ChangeSetPerformer.java Sun Mar 10 16:37:16 2013 @@ -86,6 +86,7 @@ public class ChangeSetPerformer { * @throws IOException * if an read/write error occurs * @return the results of this operation + * @since 1.5 */ public ChangeSetResults perform(ZipFile in, ArchiveOutputStream out) throws IOException { 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=1454874&r1=1454873&r2=1454874&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 Sun Mar 10 16:37:16 2013 @@ -88,6 +88,7 @@ public final class IOUtils { * @return the requested byte array * @throws NullPointerException if the input is null * @throws IOException if an I/O error occurs + * @since 1.5 */ public static byte[] toByteArray(final InputStream input) throws IOException { final ByteArrayOutputStream output = new ByteArrayOutputStream();