You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2015/08/12 05:24:07 UTC
svn commit: r1695419 [1/2] - in
/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress:
archivers/ archivers/ar/ archivers/arj/ archivers/cpio/ archivers/dump/
archivers/sevenz/ archivers/tar/ archivers/zip/ compressors/bzip2/ compres...
Author: bodewig
Date: Wed Aug 12 03:24:07 2015
New Revision: 1695419
URL: http://svn.apache.org/r1695419
Log:
lots of useless javadoc tags to make site build work on Java8
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java
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/arj/ArjArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.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/dump/DumpArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.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/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/ExtraFieldUtils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.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/Zip64ExtendedInformationExtraField.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/archivers/zip/ZipArchiveOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.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/ZipMethod.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/compressors/bzip2/BZip2CompressorInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorOutputStream.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
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/ArchiveUtils.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/utils/CRC32VerifyingInputStream.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/ArchiveOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/ArchiveOutputStream.java Wed Aug 12 03:24:07 2015
@@ -60,14 +60,14 @@ public abstract class ArchiveOutputStrea
* {@link #closeArchiveEntry()} to complete the process.
*
* @param entry describes the entry
- * @throws IOException
+ * @throws IOException if an I/O error occurs
*/
public abstract void putArchiveEntry(ArchiveEntry entry) throws IOException;
/**
* Closes the archive entry, writing any trailer information that may
* be required.
- * @throws IOException
+ * @throws IOException if an I/O error occurs
*/
public abstract void closeArchiveEntry() throws IOException;
@@ -82,11 +82,11 @@ public abstract class ArchiveOutputStrea
/**
* Create an archive entry using the inputFile and entryName provided.
*
- * @param inputFile
- * @param entryName
+ * @param inputFile the file to create the entry from
+ * @param entryName name to use for the entry
* @return the ArchiveEntry set up with details from the file
*
- * @throws IOException
+ * @throws IOException if an I/O error occurs
*/
public abstract ArchiveEntry createArchiveEntry(File inputFile, String entryName) throws IOException;
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=1695419&r1=1695418&r2=1695419&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 Aug 12 03:24:07 2015
@@ -108,6 +108,8 @@ public class ArArchiveEntry implements A
/**
* Create a new instance using the attributes of the given file
+ * @param inputFile the file to create an entry from
+ * @param entryName the name of the entry
*/
public ArArchiveEntry(File inputFile, String entryName) {
// TODO sort out mode
@@ -137,6 +139,7 @@ public class ArArchiveEntry implements A
/**
* Last modified time in seconds since the epoch.
+ * @return the last modified date
*/
public long getLastModified() {
return lastModified;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveEntry.java Wed Aug 12 03:24:07 2015
@@ -64,7 +64,10 @@ public class ArjArchiveEntry implements
return localFileHeader.originalSize;
}
- /** True if the entry refers to a directory */
+ /** True if the entry refers to a directory.
+ *
+ * @return True if the entry refers to a directory
+ */
public boolean isDirectory() {
return localFileHeader.fileType == LocalFileHeader.FileTypes.DIRECTORY;
}
@@ -81,6 +84,8 @@ public class ArjArchiveEntry implements
* regardless of timezone if the archive has been created on a
* non-Unix system and a time taking the current timezone into
* account if the archive has beeen created on Unix.</p>
+ *
+ * @return the last modified date
*/
public Date getLastModifiedDate() {
long ts = isHostOsUnix() ? localFileHeader.dateTimeModified * 1000l
@@ -92,6 +97,8 @@ public class ArjArchiveEntry implements
* File mode of this entry.
*
* <p>The format depends on the host os that created the entry.</p>
+ *
+ * @return the file mode
*/
public int getMode() {
return localFileHeader.fileAccessMode;
@@ -101,6 +108,8 @@ public class ArjArchiveEntry implements
* File mode of this entry as Unix stat value.
*
* <p>Will only be non-zero of the host os was UNIX.
+ *
+ * @return the Unix mode
*/
public int getUnixMode() {
return isHostOsUnix() ? getMode() : 0;
@@ -109,6 +118,7 @@ public class ArjArchiveEntry implements
/**
* The operating system the archive has been created on.
* @see HostOs
+ * @return the host OS code
*/
public int getHostOs() {
return localFileHeader.hostOS;
@@ -117,6 +127,8 @@ public class ArjArchiveEntry implements
/**
* Is the operating system the archive has been created on one
* that is considered a UNIX OS by arj?
+ * @return whether the operating system the archive has been
+ * created on is considered a UNIX OS by arj
*/
public boolean isHostOsUnix() {
return getHostOs() == HostOs.UNIX || getHostOs() == HostOs.NEXT;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/arj/ArjArchiveInputStream.java Wed Aug 12 03:24:07 2015
@@ -53,7 +53,7 @@ public class ArjArchiveInputStream exten
* @param inputStream the underlying stream, whose ownership is taken
* @param charsetName the charset used for file names and comments
* in the archive. May be {@code null} to use the platform default.
- * @throws ArchiveException
+ * @throws ArchiveException if an exception occurs while reading
*/
public ArjArchiveInputStream(final InputStream inputStream,
final String charsetName) throws ArchiveException {
@@ -76,7 +76,7 @@ public class ArjArchiveInputStream exten
* Constructs the ArjInputStream, taking ownership of the inputStream that is passed in,
* and using the CP437 character encoding.
* @param inputStream the underlying stream, whose ownership is taken
- * @throws ArchiveException
+ * @throws ArchiveException if an exception occurs while reading
*/
public ArjArchiveInputStream(final InputStream inputStream)
throws ArchiveException {
@@ -298,6 +298,7 @@ public class ArjArchiveInputStream exten
/**
* Gets the archive's recorded name.
+ * @return the archive's name
*/
public String getArchiveName() {
return mainHeader.name;
@@ -305,6 +306,7 @@ public class ArjArchiveInputStream exten
/**
* Gets the archive's comment.
+ * @return the archive's comment
*/
public String getArchiveComment() {
return mainHeader.comment;
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=1695419&r1=1695418&r2=1695419&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 Aug 12 03:24:07 2015
@@ -519,6 +519,9 @@ public class CpioArchiveInputStream exte
* Octal Binary value:
*
* 070707 - MAGIC_OLD_BINARY (held as a short) = 0x71C7 or 0xC771
+ * @param signature data to match
+ * @param length length of data
+ * @return whether the buffer seems to contain CPIO data
*/
public static boolean matches(byte[] signature, int length) {
if (length < 6) {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java Wed Aug 12 03:24:07 2015
@@ -227,10 +227,10 @@ public class DumpArchiveEntry implements
/**
* Constructor taking name, inode and type.
*
- * @param name
- * @param simpleName
- * @param ino
- * @param type
+ * @param name the name
+ * @param simpleName the simple name
+ * @param ino the ino
+ * @param type the type
*/
protected DumpArchiveEntry(String name, String simpleName, int ino,
TYPE type) {
@@ -242,12 +242,6 @@ public class DumpArchiveEntry implements
}
/**
- * Constructor taking tape buffer.
- * @param buffer
- * @param offset
- */
-
- /**
* Returns the path of the entry.
* @return the path of the entry.
*/
@@ -257,6 +251,7 @@ public class DumpArchiveEntry implements
/**
* Sets the path of the entry.
+ * @param simpleName the simple name
*/
protected void setSimpleName(String simpleName) {
this.simpleName = simpleName;
@@ -264,6 +259,7 @@ public class DumpArchiveEntry implements
/**
* Returns the ino of the entry.
+ * @return the ino
*/
public int getIno() {
return header.getIno();
@@ -271,6 +267,7 @@ public class DumpArchiveEntry implements
/**
* Return the number of hard links to the entry.
+ * @return the number of hard links
*/
public int getNlink() {
return nlink;
@@ -278,6 +275,7 @@ public class DumpArchiveEntry implements
/**
* Set the number of hard links.
+ * @param nlink the number of hard links
*/
public void setNlink(int nlink) {
this.nlink = nlink;
@@ -285,6 +283,7 @@ public class DumpArchiveEntry implements
/**
* Get file creation time.
+ * @return the creation time
*/
public Date getCreationTime() {
return new Date(ctime);
@@ -292,6 +291,7 @@ public class DumpArchiveEntry implements
/**
* Set the file creation time.
+ * @param ctime the creation time
*/
public void setCreationTime(Date ctime) {
this.ctime = ctime.getTime();
@@ -299,6 +299,7 @@ public class DumpArchiveEntry implements
/**
* Return the generation of the file.
+ * @return the generation
*/
public int getGeneration() {
return generation;
@@ -306,6 +307,7 @@ public class DumpArchiveEntry implements
/**
* Set the generation of the file.
+ * @param generation the generation
*/
public void setGeneration(int generation) {
this.generation = generation;
@@ -313,6 +315,7 @@ public class DumpArchiveEntry implements
/**
* Has this file been deleted? (On valid on incremental dumps.)
+ * @return whether the file has been deleted
*/
public boolean isDeleted() {
return isDeleted;
@@ -320,6 +323,7 @@ public class DumpArchiveEntry implements
/**
* Set whether this file has been deleted.
+ * @param isDeleted whether the file has been deleted
*/
public void setDeleted(boolean isDeleted) {
this.isDeleted = isDeleted;
@@ -327,6 +331,7 @@ public class DumpArchiveEntry implements
/**
* Return the offset within the archive
+ * @return the offset
*/
public long getOffset() {
return offset;
@@ -334,6 +339,7 @@ public class DumpArchiveEntry implements
/**
* Set the offset within the archive.
+ * @param offset the offset
*/
public void setOffset(long offset) {
this.offset = offset;
@@ -341,6 +347,7 @@ public class DumpArchiveEntry implements
/**
* Return the tape volume where this file is located.
+ * @return the volume
*/
public int getVolume() {
return volume;
@@ -348,6 +355,7 @@ public class DumpArchiveEntry implements
/**
* Set the tape volume.
+ * @param volume the volume
*/
public void setVolume(int volume) {
this.volume = volume;
@@ -355,6 +363,7 @@ public class DumpArchiveEntry implements
/**
* Return the type of the tape segment header.
+ * @return the segment header
*/
public DumpArchiveConstants.SEGMENT_TYPE getHeaderType() {
return header.getType();
@@ -362,6 +371,7 @@ public class DumpArchiveEntry implements
/**
* Return the number of records in this segment.
+ * @return the number of records
*/
public int getHeaderCount() {
return header.getCount();
@@ -369,6 +379,7 @@ public class DumpArchiveEntry implements
/**
* Return the number of sparse records in this segment.
+ * @return the number of sparse records
*/
public int getHeaderHoles() {
return header.getHoles();
@@ -376,22 +387,18 @@ public class DumpArchiveEntry implements
/**
* Is this a sparse record?
+ * @param idx index of the record to check
+ * @return whether this is a sparse record
*/
public boolean isSparseRecord(int idx) {
return (header.getCdata(idx) & 0x01) == 0;
}
- /**
- * @see java.lang.Object#hashCode()
- */
@Override
public int hashCode() {
return ino;
}
- /**
- * @see java.lang.Object#equals(Object o)
- */
@Override
public boolean equals(Object o) {
if (o == this) {
@@ -418,9 +425,6 @@ public class DumpArchiveEntry implements
return true;
}
- /**
- * @see java.lang.Object#toString()
- */
@Override
public String toString() {
return getName();
@@ -430,8 +434,7 @@ public class DumpArchiveEntry implements
* Populate the dump archive entry and tape segment header with
* the contents of the buffer.
*
- * @param buffer
- * @throws Exception
+ * @param buffer buffer to read content from
*/
static DumpArchiveEntry parse(byte[] buffer) {
DumpArchiveEntry entry = new DumpArchiveEntry();
@@ -574,6 +577,7 @@ public class DumpArchiveEntry implements
/**
* Sets the name of the entry.
+ * @param name the name
*/
public final void setName(String name) {
this.originalName = name;
@@ -588,12 +592,17 @@ public class DumpArchiveEntry implements
this.name = name;
}
+ /**
+ * The last modified date.
+ * @return the last modified date
+ */
public Date getLastModifiedDate() {
return new Date(mtime);
}
/**
* Is this a directory?
+ * @return whether this is a directory
*/
public boolean isDirectory() {
return type == TYPE.DIRECTORY;
@@ -601,6 +610,7 @@ public class DumpArchiveEntry implements
/**
* Is this a regular file?
+ * @return whether this is a regular file
*/
public boolean isFile() {
return type == TYPE.FILE;
@@ -608,6 +618,7 @@ public class DumpArchiveEntry implements
/**
* Is this a network device?
+ * @return whether this is a socket
*/
public boolean isSocket() {
return type == TYPE.SOCKET;
@@ -615,6 +626,7 @@ public class DumpArchiveEntry implements
/**
* Is this a character device?
+ * @return whether this is a character device
*/
public boolean isChrDev() {
return type == TYPE.CHRDEV;
@@ -622,6 +634,7 @@ public class DumpArchiveEntry implements
/**
* Is this a block device?
+ * @return whether this is a block device
*/
public boolean isBlkDev() {
return type == TYPE.BLKDEV;
@@ -629,6 +642,7 @@ public class DumpArchiveEntry implements
/**
* Is this a fifo/pipe?
+ * @return whether this is a fifo
*/
public boolean isFifo() {
return type == TYPE.FIFO;
@@ -636,6 +650,7 @@ public class DumpArchiveEntry implements
/**
* Get the type of the entry.
+ * @return the type
*/
public TYPE getType() {
return type;
@@ -643,6 +658,7 @@ public class DumpArchiveEntry implements
/**
* Set the type of the entry.
+ * @param type the type
*/
public void setType(TYPE type) {
this.type = type;
@@ -650,6 +666,7 @@ public class DumpArchiveEntry implements
/**
* Return the access permissions on the entry.
+ * @return the access permissions
*/
public int getMode() {
return mode;
@@ -657,6 +674,7 @@ public class DumpArchiveEntry implements
/**
* Set the access permissions on the entry.
+ * @param mode the access permissions
*/
public void setMode(int mode) {
this.mode = mode & 07777;
@@ -665,6 +683,7 @@ public class DumpArchiveEntry implements
/**
* Returns the permissions on the entry.
+ * @return the permissions
*/
public Set<PERMISSION> getPermissions() {
return permissions;
@@ -672,6 +691,7 @@ public class DumpArchiveEntry implements
/**
* Returns the size of the entry.
+ * @return the size
*/
public long getSize() {
return isDirectory() ? SIZE_UNKNOWN : size;
@@ -686,6 +706,7 @@ public class DumpArchiveEntry implements
/**
* Set the size of the entry.
+ * @param size the size
*/
public void setSize(long size) {
this.size = size;
@@ -693,6 +714,7 @@ public class DumpArchiveEntry implements
/**
* Set the time the file was last modified.
+ * @param mtime the last modified time
*/
public void setLastModifiedDate(Date mtime) {
this.mtime = mtime.getTime();
@@ -700,6 +722,7 @@ public class DumpArchiveEntry implements
/**
* Returns the time the file was last accessed.
+ * @return the access time
*/
public Date getAccessTime() {
return new Date(atime);
@@ -707,6 +730,7 @@ public class DumpArchiveEntry implements
/**
* Set the time the file was last accessed.
+ * @param atime the access time
*/
public void setAccessTime(Date atime) {
this.atime = atime.getTime();
@@ -714,6 +738,7 @@ public class DumpArchiveEntry implements
/**
* Return the user id.
+ * @return the user id
*/
public int getUserId() {
return uid;
@@ -721,6 +746,7 @@ public class DumpArchiveEntry implements
/**
* Set the user id.
+ * @param uid the user id
*/
public void setUserId(int uid) {
this.uid = uid;
@@ -728,6 +754,7 @@ public class DumpArchiveEntry implements
/**
* Return the group id
+ * @return the group id
*/
public int getGroupId() {
return gid;
@@ -735,6 +762,7 @@ public class DumpArchiveEntry implements
/**
* Set the group id.
+ * @param gid the group id
*/
public void setGroupId(int gid) {
this.gid = gid;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveInputStream.java Wed Aug 12 03:24:07 2015
@@ -83,8 +83,8 @@ public class DumpArchiveInputStream exte
* Constructor using the platform's default encoding for file
* names.
*
- * @param is
- * @throws ArchiveException
+ * @param is stream to read from
+ * @throws ArchiveException on error
*/
public DumpArchiveInputStream(InputStream is) throws ArchiveException {
this(is, null);
@@ -93,10 +93,11 @@ public class DumpArchiveInputStream exte
/**
* Constructor.
*
- * @param is
+ * @param is stream to read from
* @param encoding the encoding to use for file names, use null
* for the platform's default encoding
* @since 1.6
+ * @throws ArchiveException on error
*/
public DumpArchiveInputStream(InputStream is, String encoding)
throws ArchiveException {
@@ -160,6 +161,7 @@ public class DumpArchiveInputStream exte
/**
* Return the archive summary information.
+ * @return the summary
*/
public DumpArchiveSummary getSummary() {
return summary;
@@ -215,14 +217,13 @@ public class DumpArchiveInputStream exte
/**
* Read the next entry.
+ * @return the next entry
+ * @throws IOException on error
*/
public DumpArchiveEntry getNextDumpEntry() throws IOException {
return getNextEntry();
}
- /**
- * Read the next entry.
- */
@Override
public DumpArchiveEntry getNextEntry() throws IOException {
DumpArchiveEntry entry = null;
@@ -536,6 +537,9 @@ public class DumpArchiveInputStream exte
* Look at the first few bytes of the file to decide if it's a dump
* archive. With 32 bytes we can look at the magic value, with a full
* 1k we can verify the checksum.
+ * @param buffer data to match
+ * @param length length of data
+ * @return whether the buffer seems to contain dump data
*/
public static boolean matches(byte[] buffer, int length) {
// do we have enough of the header?
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveSummary.java Wed Aug 12 03:24:07 2015
@@ -69,6 +69,7 @@ public class DumpArchiveSummary {
/**
* Set dump date.
+ * @param dumpDate the dump date
*/
public void setDumpDate(Date dumpDate) {
this.dumpDate = dumpDate.getTime();
@@ -84,6 +85,7 @@ public class DumpArchiveSummary {
/**
* Set previous dump date.
+ * @param previousDumpDate the previous dump dat
*/
public void setPreviousDumpDate(Date previousDumpDate) {
this.previousDumpDate = previousDumpDate.getTime();
@@ -99,6 +101,7 @@ public class DumpArchiveSummary {
/**
* Set volume (tape) number.
+ * @param volume the volume number
*/
public void setVolume(int volume) {
this.volume = volume;
@@ -118,6 +121,7 @@ public class DumpArchiveSummary {
/**
* Set level.
+ * @param level the level
*/
public void setLevel(int level) {
this.level = level;
@@ -134,7 +138,7 @@ public class DumpArchiveSummary {
/**
* Set dump label.
- * @param label
+ * @param label the label
*/
public void setLabel(String label) {
this.label = label;
@@ -150,6 +154,7 @@ public class DumpArchiveSummary {
/**
* Set the last mountpoint.
+ * @param filesystem the last mountpoint
*/
public void setFilesystem(String filesystem) {
this.filesys = filesystem;
@@ -165,7 +170,7 @@ public class DumpArchiveSummary {
/**
* Set the device name.
- * @param devname
+ * @param devname the device name
*/
public void setDevname(String devname) {
this.devname = devname;
@@ -173,7 +178,7 @@ public class DumpArchiveSummary {
/**
* Get the hostname of the system where the dump was performed.
- * @return hostname
+ * @return hostname the host name
*/
public String getHostname() {
return hostname;
@@ -181,6 +186,7 @@ public class DumpArchiveSummary {
/**
* Set the hostname.
+ * @param hostname the host name
*/
public void setHostname(String hostname) {
this.hostname = hostname;
@@ -196,7 +202,7 @@ public class DumpArchiveSummary {
/**
* Set the miscellaneous flags.
- * @param flags
+ * @param flags flags
*/
public void setFlags(int flags) {
this.flags = flags;
@@ -212,7 +218,7 @@ public class DumpArchiveSummary {
/**
* Set the inode of the first record.
- * @param firstrec
+ * @param firstrec the first record
*/
public void setFirstRecord(int firstrec) {
this.firstrec = firstrec;
@@ -229,6 +235,7 @@ public class DumpArchiveSummary {
/**
* Set the number of records per tape block.
+ * @param ntrec the number of records per tape block
*/
public void setNTRec(int ntrec) {
this.ntrec = ntrec;
@@ -278,9 +285,6 @@ public class DumpArchiveSummary {
return (flags & 0x8000) == 0x8000;
}
- /**
- * @see java.lang.Object#hashCode()
- */
@Override
public int hashCode() {
int hash = 17;
@@ -302,9 +306,6 @@ public class DumpArchiveSummary {
return hash;
}
- /**
- * @see java.lang.Object#equals(Object)
- */
@Override
public boolean equals(Object o) {
if (this == o) {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZArchiveEntry.java Wed Aug 12 03:24:07 2015
@@ -124,6 +124,7 @@ public class SevenZArchiveEntry implemen
/**
* Returns whether this entry has got a creation date at all.
+ * @return whether the entry has got a creation date
*/
public boolean getHasCreationDate() {
return hasCreationDate;
@@ -131,6 +132,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets whether this entry has got a creation date at all.
+ * @param hasCreationDate whether the entry has got a creation date
*/
public void setHasCreationDate(boolean hasCreationDate) {
this.hasCreationDate = hasCreationDate;
@@ -140,6 +142,7 @@ public class SevenZArchiveEntry implemen
* Gets the creation date.
* @throws UnsupportedOperationException if the entry hasn't got a
* creation date.
+ * @return the creation date
*/
public Date getCreationDate() {
if (hasCreationDate) {
@@ -153,6 +156,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the creation date using NTFS time (100 nanosecond units
* since 1 January 1601)
+ * @param ntfsCreationDate the creation date
*/
public void setCreationDate(long ntfsCreationDate) {
this.creationDate = ntfsCreationDate;
@@ -160,6 +164,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the creation date,
+ * @param creationDate the creation date
*/
public void setCreationDate(Date creationDate) {
hasCreationDate = creationDate != null;
@@ -170,6 +175,7 @@ public class SevenZArchiveEntry implemen
/**
* Returns whether this entry has got a last modified date at all.
+ * @return whether this entry has got a last modified date at all
*/
public boolean getHasLastModifiedDate() {
return hasLastModifiedDate;
@@ -177,6 +183,8 @@ public class SevenZArchiveEntry implemen
/**
* Sets whether this entry has got a last modified date at all.
+ * @param hasLastModifiedDate whether this entry has got a last
+ * modified date at all
*/
public void setHasLastModifiedDate(boolean hasLastModifiedDate) {
this.hasLastModifiedDate = hasLastModifiedDate;
@@ -186,6 +194,7 @@ public class SevenZArchiveEntry implemen
* Gets the last modified date.
* @throws UnsupportedOperationException if the entry hasn't got a
* last modified date.
+ * @return the last modified date
*/
public Date getLastModifiedDate() {
if (hasLastModifiedDate) {
@@ -199,6 +208,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the last modified date using NTFS time (100 nanosecond
* units since 1 January 1601)
+ * @param ntfsLastModifiedDate the last modified date
*/
public void setLastModifiedDate(long ntfsLastModifiedDate) {
this.lastModifiedDate = ntfsLastModifiedDate;
@@ -206,6 +216,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the last modified date,
+ * @param lastModifiedDate the last modified date
*/
public void setLastModifiedDate(Date lastModifiedDate) {
hasLastModifiedDate = lastModifiedDate != null;
@@ -216,6 +227,7 @@ public class SevenZArchiveEntry implemen
/**
* Returns whether this entry has got an access date at all.
+ * @return whether this entry has got an access date at all.
*/
public boolean getHasAccessDate() {
return hasAccessDate;
@@ -223,6 +235,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets whether this entry has got an access date at all.
+ * @param hasAcessDate whether this entry has got an access date at all.
*/
public void setHasAccessDate(boolean hasAcessDate) {
this.hasAccessDate = hasAcessDate;
@@ -232,6 +245,7 @@ public class SevenZArchiveEntry implemen
* Gets the access date.
* @throws UnsupportedOperationException if the entry hasn't got a
* access date.
+ * @return the access date
*/
public Date getAccessDate() {
if (hasAccessDate) {
@@ -245,6 +259,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the access date using NTFS time (100 nanosecond units
* since 1 January 1601)
+ * @param ntfsAccessDate the access date
*/
public void setAccessDate(long ntfsAccessDate) {
this.accessDate = ntfsAccessDate;
@@ -252,6 +267,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the access date,
+ * @param accessDate the access date
*/
public void setAccessDate(Date accessDate) {
hasAccessDate = accessDate != null;
@@ -262,6 +278,7 @@ public class SevenZArchiveEntry implemen
/**
* Returns whether this entry has windows attributes.
+ * @return whether this entry has windows attributes.
*/
public boolean getHasWindowsAttributes() {
return hasWindowsAttributes;
@@ -269,6 +286,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets whether this entry has windows attributes.
+ * @param hasWindowsAttributes whether this entry has windows attributes.
*/
public void setHasWindowsAttributes(boolean hasWindowsAttributes) {
this.hasWindowsAttributes = hasWindowsAttributes;
@@ -276,6 +294,7 @@ public class SevenZArchiveEntry implemen
/**
* Gets the windows attributes.
+ * @return the windows attributes
*/
public int getWindowsAttributes() {
return windowsAttributes;
@@ -283,6 +302,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the windows attributes.
+ * @param windowsAttributes the windows attributes
*/
public void setWindowsAttributes(int windowsAttributes) {
this.windowsAttributes = windowsAttributes;
@@ -291,7 +311,8 @@ public class SevenZArchiveEntry implemen
/**
* Returns whether this entry has got a crc.
*
- * In general entries without streams don't have a CRC either.
+ * <p>In general entries without streams don't have a CRC either.</p>
+ * @return whether this entry has got a crc.
*/
public boolean getHasCrc() {
return hasCrc;
@@ -299,6 +320,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets whether this entry has got a crc.
+ * @param hasCrc whether this entry has got a crc.
*/
public void setHasCrc(boolean hasCrc) {
this.hasCrc = hasCrc;
@@ -307,6 +329,7 @@ public class SevenZArchiveEntry implemen
/**
* Gets the CRC.
* @deprecated use getCrcValue instead.
+ * @return the CRC
*/
@Deprecated
public int getCrc() {
@@ -316,6 +339,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the CRC.
* @deprecated use setCrcValue instead.
+ * @param crc the CRC
*/
@Deprecated
public void setCrc(int crc) {
@@ -325,6 +349,7 @@ public class SevenZArchiveEntry implemen
/**
* Gets the CRC.
* @since Compress 1.7
+ * @return the CRC
*/
public long getCrcValue() {
return crc;
@@ -333,6 +358,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the CRC.
* @since Compress 1.7
+ * @param crc the CRC
*/
public void setCrcValue(long crc) {
this.crc = crc;
@@ -341,6 +367,7 @@ public class SevenZArchiveEntry implemen
/**
* Gets the compressed CRC.
* @deprecated use getCompressedCrcValue instead.
+ * @return the compressed CRC
*/
@Deprecated
int getCompressedCrc() {
@@ -350,6 +377,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the compressed CRC.
* @deprecated use setCompressedCrcValue instead.
+ * @param crc the CRC
*/
@Deprecated
void setCompressedCrc(int crc) {
@@ -359,6 +387,7 @@ public class SevenZArchiveEntry implemen
/**
* Gets the compressed CRC.
* @since Compress 1.7
+ * @return the CRC
*/
long getCompressedCrcValue() {
return compressedCrc;
@@ -367,6 +396,7 @@ public class SevenZArchiveEntry implemen
/**
* Sets the compressed CRC.
* @since Compress 1.7
+ * @param crc the CRC
*/
void setCompressedCrcValue(long crc) {
this.compressedCrc = crc;
@@ -419,6 +449,7 @@ public class SevenZArchiveEntry implemen
* <p>The methods will be consulted in iteration order to create
* the final output.</p>
*
+ * @param methods the methods to use for the content
* @since 1.8
*/
public void setContentMethods(Iterable<? extends SevenZMethodConfiguration> methods) {
@@ -445,6 +476,7 @@ public class SevenZArchiveEntry implemen
* the final output.</p>
*
* @since 1.8
+ * @return the methods to use for the content
*/
public Iterable<? extends SevenZMethodConfiguration> getContentMethods() {
return contentMethods;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZMethodConfiguration.java Wed Aug 12 03:24:07 2015
@@ -64,6 +64,7 @@ public class SevenZMethodConfiguration {
/**
* The specified method.
+ * @return the method
*/
public SevenZMethod getMethod() {
return method;
@@ -71,6 +72,7 @@ public class SevenZMethodConfiguration {
/**
* The specified options.
+ * @return the options
*/
public Object getOptions() {
return options;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZOutputFile.java Wed Aug 12 03:24:07 2015
@@ -77,6 +77,7 @@ public class SevenZOutputFile implements
*
* <p>This is a short form for passing a single-element iterable
* to {@link #setContentMethods}.</p>
+ * @param method the default compression method
*/
public void setContentCompression(SevenZMethod method) {
setContentMethods(Collections.singletonList(new SevenZMethodConfiguration(method)));
@@ -94,6 +95,7 @@ public class SevenZOutputFile implements
* the final output.</p>
*
* @since 1.8
+ * @param methods the default (compression) methods
*/
public void setContentMethods(Iterable<? extends SevenZMethodConfiguration> methods) {
this.contentMethods = reverse(methods);
@@ -102,7 +104,7 @@ public class SevenZOutputFile implements
/**
* Closes the archive, calling {@link #finish} if necessary.
*
- * @throws IOException
+ * @throws IOException on error
*/
public void close() throws IOException {
if (!finished) {
@@ -114,11 +116,11 @@ public class SevenZOutputFile implements
/**
* Create an archive entry using the inputFile and entryName provided.
*
- * @param inputFile
- * @param entryName
+ * @param inputFile file to create an entry from
+ * @param entryName the name to use
* @return the ArchiveEntry set up with details from the file
*
- * @throws IOException
+ * @throws IOException on error
*/
public SevenZArchiveEntry createArchiveEntry(final File inputFile,
final String entryName) throws IOException {
@@ -136,7 +138,7 @@ public class SevenZOutputFile implements
* {@link #closeArchiveEntry()} to complete the process.
*
* @param archiveEntry describes the entry
- * @throws IOException
+ * @throws IOException on error
*/
public void putArchiveEntry(final ArchiveEntry archiveEntry) throws IOException {
final SevenZArchiveEntry entry = (SevenZArchiveEntry) archiveEntry;
@@ -145,7 +147,7 @@ public class SevenZOutputFile implements
/**
* Closes the archive entry.
- * @throws IOException
+ * @throws IOException on error
*/
public void closeArchiveEntry() throws IOException {
if (currentOutputStream != null) {
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -318,6 +318,7 @@ public class TarArchiveEntry implements
* @param encoding encoding to use for file names
* @since 1.4
* @throws IllegalArgumentException if any of the numeric fields have an invalid format
+ * @throws IOException on error
*/
public TarArchiveEntry(byte[] headerBuf, ZipEncoding encoding)
throws IOException {
@@ -425,7 +426,7 @@ public class TarArchiveEntry implements
*
* @return This entry's user id.
* @deprecated use #getLongUserId instead as user ids can be
- * bigger than {@link Integer.MAX_INT}
+ * bigger than {@link Integer#MAX_VALUE}
*/
@Deprecated
public int getUserId() {
@@ -466,7 +467,7 @@ public class TarArchiveEntry implements
*
* @return This entry's group id.
* @deprecated use #getLongGroupId instead as group ids can be
- * bigger than {@link Integer.MAX_INT}
+ * bigger than {@link Integer#MAX_VALUE}
*/
@Deprecated
public int getGroupId() {
@@ -790,6 +791,7 @@ public class TarArchiveEntry implements
* Check if this is a "normal file"
*
* @since 1.2
+ * @return whether this is a "normal file"
*/
public boolean isFile() {
if (file != null) {
@@ -805,6 +807,7 @@ public class TarArchiveEntry implements
* Check if this is a symbolic link entry.
*
* @since 1.2
+ * @return whether this is a symbolic link
*/
public boolean isSymbolicLink() {
return linkFlag == LF_SYMLINK;
@@ -814,6 +817,7 @@ public class TarArchiveEntry implements
* Check if this is a link entry.
*
* @since 1.2
+ * @return whether this is a link entry
*/
public boolean isLink() {
return linkFlag == LF_LINK;
@@ -823,6 +827,7 @@ public class TarArchiveEntry implements
* Check if this is a character device entry.
*
* @since 1.2
+ * @return whether this is a character device
*/
public boolean isCharacterDevice() {
return linkFlag == LF_CHR;
@@ -832,6 +837,7 @@ public class TarArchiveEntry implements
* Check if this is a block device entry.
*
* @since 1.2
+ * @return whether this is a block device
*/
public boolean isBlockDevice() {
return linkFlag == LF_BLK;
@@ -841,6 +847,7 @@ public class TarArchiveEntry implements
* Check if this is a FIFO (pipe) entry.
*
* @since 1.2
+ * @return whether this is a FIFO entry
*/
public boolean isFIFO() {
return linkFlag == LF_FIFO;
@@ -896,6 +903,7 @@ public class TarArchiveEntry implements
* extension for numeric fields if their value doesn't fit in the
* maximum size of standard tar archives
* @since 1.4
+ * @throws IOException on error
*/
public void writeEntryHeader(byte[] outbuf, ZipEncoding encoding,
boolean starMode) throws IOException {
@@ -981,6 +989,7 @@ public class TarArchiveEntry implements
* @since 1.4
* @throws IllegalArgumentException if any of the numeric fields
* have an invalid format
+ * @throws IOException on error
*/
public void parseTarHeader(byte[] header, ZipEncoding encoding)
throws IOException {
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=1695419&r1=1695418&r2=1695419&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 Aug 12 03:24:07 2015
@@ -189,6 +189,7 @@ public class TarArchiveOutputStream exte
/**
* Whether to add a PAX extension header for non-ASCII file names.
* @since 1.4
+ * @param b whether to add a PAX extension header for non-ASCII file names.
*/
public void setAddPaxHeadersForNonAsciiNames(boolean b) {
addPaxHeadersForNonAsciiNames = b;
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -280,6 +280,7 @@ public class TarUtils {
* @param encoding name of the encoding to use for file names
* @since 1.4
* @return The entry name.
+ * @throws IOException on error
*/
public static String parseName(byte[] buffer, final int offset,
final int length,
@@ -345,6 +346,7 @@ public class TarUtils {
* @param encoding name of the encoding to use for file names
* @since 1.4
* @return The updated offset, i.e. offset + length
+ * @throws IOException on error
*/
public static int formatNameBytes(String name, byte[] buf, final int offset,
final int length,
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -312,6 +312,7 @@ public class ExtraFieldUtils {
/**
* Key of the action to take.
+ * @return the key
*/
public int getKey() { return key; }
}
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/GeneralPurposeBit.java Wed Aug 12 03:24:07 2015
@@ -81,6 +81,7 @@ public final class GeneralPurposeBit imp
/**
* whether the current entry uses UTF8 for file name and comment.
+ * @return whether the current entry uses UTF8 for file name and comment.
*/
public boolean usesUTF8ForNames() {
return languageEncodingFlag;
@@ -88,6 +89,7 @@ public final class GeneralPurposeBit imp
/**
* whether the current entry will use UTF8 for file name and comment.
+ * @param b whether the current entry will use UTF8 for file name and comment.
*/
public void useUTF8ForNames(boolean b) {
languageEncodingFlag = b;
@@ -95,6 +97,8 @@ public final class GeneralPurposeBit imp
/**
* whether the current entry uses the data descriptor to store CRC
+ * and size information.
+ * @return whether the current entry uses the data descriptor to store CRC
* and size information
*/
public boolean usesDataDescriptor() {
@@ -103,6 +107,8 @@ public final class GeneralPurposeBit imp
/**
* whether the current entry will use the data descriptor to store
+ * CRC and size information.
+ * @param b whether the current entry will use the data descriptor to store
* CRC and size information
*/
public void useDataDescriptor(boolean b) {
@@ -110,28 +116,32 @@ public final class GeneralPurposeBit imp
}
/**
- * whether the current entry is encrypted
+ * whether the current entry is encrypted.
+ * @return whether the current entry is encrypted
*/
public boolean usesEncryption() {
return encryptionFlag;
}
/**
- * whether the current entry will be encrypted
+ * whether the current entry will be encrypted.
+ * @param b whether the current entry will be encrypted
*/
public void useEncryption(boolean b) {
encryptionFlag = b;
}
/**
- * whether the current entry is encrypted using strong encryption
+ * whether the current entry is encrypted using strong encryption.
+ * @return whether the current entry is encrypted using strong encryption
*/
public boolean usesStrongEncryption() {
return encryptionFlag && strongEncryptionFlag;
}
/**
- * whether the current entry will be encrypted using strong encryption
+ * whether the current entry will be encrypted using strong encryption.
+ * @param b whether the current entry will be encrypted using strong encryption
*/
public void useStrongEncryption(boolean b) {
strongEncryptionFlag = b;
@@ -156,6 +166,7 @@ public final class GeneralPurposeBit imp
/**
* Encodes the set bits in a form suitable for ZIP archives.
+ * @return the encoded general purpose bits
*/
public byte[] encode() {
byte[] result = new byte[2];
@@ -188,6 +199,7 @@ public final class GeneralPurposeBit imp
*
* @param data local file header or a central directory entry.
* @param offset offset at which the general purpose bit starts
+ * @return parsed flags
*/
public static GeneralPurposeBit parse(final byte[] data, final int offset) {
final int generalPurposeFlag = ZipShort.getValue(data, offset);
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ScatterZipOutputStream.java Wed Aug 12 03:24:07 2015
@@ -133,7 +133,7 @@ public class ScatterZipOutputStream impl
*
* @param file The file to offload compressed data into.
* @return A ScatterZipOutputStream that is ready for use.
- * @throws FileNotFoundException
+ * @throws FileNotFoundException if the file cannot be found
*/
public static ScatterZipOutputStream fileBased(File file) throws FileNotFoundException {
return fileBased(file, Deflater.DEFAULT_COMPRESSION);
@@ -145,7 +145,7 @@ public class ScatterZipOutputStream impl
* @param file The file to offload compressed data into.
* @param compressionLevel The compression level to use, @see #Deflater
* @return A ScatterZipOutputStream that is ready for use.
- * @throws FileNotFoundException
+ * @throws FileNotFoundException if the file cannot be found
*/
public static ScatterZipOutputStream fileBased(File file, int compressionLevel) throws FileNotFoundException {
ScatterGatherBackingStore bs = new FileBasedScatterGatherBackingStore(file);
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -74,6 +74,7 @@ public class UnsupportedZipFeatureExcept
/**
* The unsupported feature that has been used.
+ * @return The unsupported feature that has been used.
*/
public Feature getFeature() {
return reason;
@@ -81,6 +82,7 @@ public class UnsupportedZipFeatureExcept
/**
* The entry using the unsupported feature.
+ * @return The entry using the unsupported feature.
*/
public ZipArchiveEntry getEntry() {
return entry;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java Wed Aug 12 03:24:07 2015
@@ -88,6 +88,8 @@ public class Zip64ExtendedInformationExt
*
* @param size the entry's original size
* @param compressedSize the entry's compressed size
+ * @param relativeHeaderOffset the entry's offset
+ * @param diskStart the disk start
*
* @throws IllegalArgumentException if size or compressedSize is null
*/
@@ -205,6 +207,12 @@ public class Zip64ExtendedInformationExt
* field are optional and must only be present if their corresponding
* entry inside the central directory contains the correct magic
* value.</p>
+ *
+ * @param hasUncompressedSize flag to read from central directory
+ * @param hasCompressedSize flag to read from central directory
+ * @param hasRelativeHeaderOffset flag to read from central directory
+ * @param hasDiskStart flag to read from central directory
+ * @throws ZipException on error
*/
public void reparseCentralDirectoryData(boolean hasUncompressedSize,
boolean hasCompressedSize,
@@ -248,6 +256,7 @@ public class Zip64ExtendedInformationExt
/**
* The uncompressed size stored in this extra field.
+ * @return The uncompressed size stored in this extra field.
*/
public ZipEightByteInteger getSize() {
return size;
@@ -255,6 +264,7 @@ public class Zip64ExtendedInformationExt
/**
* The uncompressed size stored in this extra field.
+ * @param size The uncompressed size stored in this extra field.
*/
public void setSize(ZipEightByteInteger size) {
this.size = size;
@@ -262,6 +272,7 @@ public class Zip64ExtendedInformationExt
/**
* The compressed size stored in this extra field.
+ * @return The compressed size stored in this extra field.
*/
public ZipEightByteInteger getCompressedSize() {
return compressedSize;
@@ -269,6 +280,7 @@ public class Zip64ExtendedInformationExt
/**
* The uncompressed size stored in this extra field.
+ * @param compressedSize The uncompressed size stored in this extra field.
*/
public void setCompressedSize(ZipEightByteInteger compressedSize) {
this.compressedSize = compressedSize;
@@ -276,6 +288,7 @@ public class Zip64ExtendedInformationExt
/**
* The relative header offset stored in this extra field.
+ * @return The relative header offset stored in this extra field.
*/
public ZipEightByteInteger getRelativeHeaderOffset() {
return relativeHeaderOffset;
@@ -283,6 +296,7 @@ public class Zip64ExtendedInformationExt
/**
* The relative header offset stored in this extra field.
+ * @param rho The relative header offset stored in this extra field.
*/
public void setRelativeHeaderOffset(ZipEightByteInteger rho) {
relativeHeaderOffset = rho;
@@ -290,6 +304,7 @@ public class Zip64ExtendedInformationExt
/**
* The disk start number stored in this extra field.
+ * @return The disk start number stored in this extra field.
*/
public ZipLong getDiskStartNumber() {
return diskStart;
@@ -297,6 +312,7 @@ public class Zip64ExtendedInformationExt
/**
* The disk start number stored in this extra field.
+ * @param ds The disk start number stored in this extra field.
*/
public void setDiskStartNumber(ZipLong ds) {
diskStart = ds;
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -159,6 +159,8 @@ public class ZipArchiveEntry extends jav
* the file is a directory. If the file is not a directory a
* potential trailing forward slash will be stripped from the
* entry name.</p>
+ * @param inputFile file to create the entry from
+ * @param entryName name of the entry
*/
public ZipArchiveEntry(File inputFile, String entryName) {
this(inputFile.isDirectory() && !entryName.endsWith("/") ?
@@ -493,6 +495,7 @@ public class ZipArchiveEntry extends jav
/**
* Looks up an extra field by its header id.
*
+ * @param type the header id
* @return null if no such field exists.
*/
public ZipExtraField getExtraField(ZipShort type) {
@@ -551,6 +554,7 @@ public class ZipArchiveEntry extends jav
/**
* Sets the central directory part of extra fields.
+ * @param b an array of bytes to be parsed into extra fields
*/
public void setCentralDirectoryExtra(byte[] b) {
try {
@@ -659,6 +663,7 @@ public class ZipArchiveEntry extends jav
* <p>This method will return null if this instance has not been
* read from an archive.</p>
*
+ * @return the raw name bytes
* @since 1.2
*/
public byte[] getRawName() {
@@ -686,6 +691,7 @@ public class ZipArchiveEntry extends jav
/**
* The "general purpose bit" field.
+ * @return the general purpose bit
* @since 1.1
*/
public GeneralPurposeBit getGeneralPurposeBit() {
@@ -694,6 +700,7 @@ public class ZipArchiveEntry extends jav
/**
* The "general purpose bit" field.
+ * @param b the general purpose bit
* @since 1.1
*/
public void setGeneralPurposeBit(GeneralPurposeBit b) {
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=1695419&r1=1695418&r2=1695419&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 Aug 12 03:24:07 2015
@@ -167,6 +167,8 @@ public class ZipArchiveInputStream exten
}
/**
+ * Create an instance using the specified encoding
+ * @param inputStream the stream to wrap
* @param encoding the encoding to use for file names, use null
* for the platform's default encoding
* @since 1.5
@@ -176,6 +178,8 @@ public class ZipArchiveInputStream exten
}
/**
+ * Create an instance using the specified encoding
+ * @param inputStream the stream to wrap
* @param encoding the encoding to use for file names, use null
* for the platform's default encoding
* @param useUnicodeExtraFields whether to use InfoZIP Unicode
@@ -186,6 +190,8 @@ public class ZipArchiveInputStream exten
}
/**
+ * Create an instance using the specified encoding
+ * @param inputStream the stream to wrap
* @param encoding the encoding to use for file names, use null
* for the platform's default encoding
* @param useUnicodeExtraFields whether to use InfoZIP Unicode
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=1695419&r1=1695418&r2=1695419&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 Aug 12 03:24:07 2015
@@ -349,6 +349,9 @@ public class ZipArchiveOutputStream exte
* encoding is UTF-8.
*
* <p>Defaults to true.</p>
+ *
+ * @param b whether to set the language encoding flag if the file
+ * name encoding is UTF-8
*/
public void setUseLanguageEncodingFlag(boolean b) {
useUTF8Flag = b && ZipEncodingHelper.isUTF8(encoding);
@@ -358,6 +361,8 @@ public class ZipArchiveOutputStream exte
* Whether to create Unicode Extra Fields.
*
* <p>Defaults to NEVER.</p>
+ *
+ * @param b whether to create Unicode Extra Fields.
*/
public void setCreateUnicodeExtraFields(UnicodeExtraFieldPolicy b) {
createUnicodeExtraFields = b;
@@ -368,6 +373,10 @@ public class ZipArchiveOutputStream exte
* the file name cannot be encoded using the specified encoding.
*
* <p>Defaults to false.</p>
+ *
+ * @param b whether to fall back to UTF and the language encoding
+ * flag if the file name cannot be encoded using the specified
+ * encoding.
*/
public void setFallbackToUTF8(boolean b) {
fallbackToUTF8 = b;
@@ -416,6 +425,7 @@ public class ZipArchiveOutputStream exte
* case the default is {@link Zip64Mode#Never Never}.</p>
*
* @since 1.3
+ * @param mode Whether Zip64 extensions will be used.
*/
public void setUseZip64(Zip64Mode mode) {
zip64Mode = mode;
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipEncoding.java Wed Aug 12 03:24:07 2015
@@ -71,14 +71,14 @@ public interface ZipEncoding {
* beginning of the encoded result, the byte buffer has a
* backing array and the limit of the byte buffer points
* to the end of the encoded result.
- * @throws IOException
+ * @throws IOException on error
*/
ByteBuffer encode(String name) throws IOException;
/**
* @param data The byte values to decode.
* @return The decoded string.
- * @throws IOException
+ * @throws IOException on error
*/
String decode(byte [] data) throws IOException;
}
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -340,6 +340,8 @@ public class ZipFile implements Closeabl
* <p>May return false if it is set up to use encryption or a
* compression method that hasn't been implemented yet.</p>
* @since 1.1
+ * @param ze the entry
+ * @return whether this class is able to read the given entry.
*/
public boolean canReadEntryData(ZipArchiveEntry ze) {
return ZipUtil.canHandleEntryData(ze);
@@ -371,6 +373,7 @@ public class ZipFile implements Closeabl
*
* @param target The zipArchiveOutputStream to write the entries to
* @param predicate A predicate that selects which entries to write
+ * @throws IOException on error
*/
public void copyRawEntries(ZipArchiveOutputStream target, ZipArchiveEntryPredicate predicate)
throws IOException {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/zip/ZipMethod.java Wed Aug 12 03:24:07 2015
@@ -206,6 +206,9 @@ public enum ZipMethod {
/**
* returns the {@link ZipMethod} for the given code or null if the
* method is not known.
+ * @param code the code
+ * @return the {@link ZipMethod} for the given code or null if the
+ * method is not known.
*/
public static ZipMethod getMethodByCode(int code) {
return codeToEnum.get(code);
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -211,6 +211,8 @@ public abstract class ZipUtil {
/**
* Converts DOS time to Java time (number of milliseconds since
* epoch).
+ * @param dosTime time to convert
+ * @return converted time
*/
public static long dosToJavaTime(long dosTime) {
Calendar cal = Calendar.getInstance();
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=1695419&r1=1695418&r2=1695419&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 Aug 12 03:24:07 2015
@@ -100,6 +100,7 @@ public class BZip2CompressorInputStream
* read from the specified stream. This doesn't suppprt decompressing
* concatenated .bz2 files.
*
+ * @param in the InputStream from which this object should be created
* @throws IOException
* if the stream content is malformed or an I/O error occurs.
* @throws NullPointerException
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/deflate/DeflateCompressorOutputStream.java Wed Aug 12 03:24:07 2015
@@ -34,6 +34,8 @@ public class DeflateCompressorOutputStre
/**
* Creates a Deflate compressed output stream with the default parameters.
+ * @param outputStream the stream to wrap
+ * @throws IOException on error
*/
public DeflateCompressorOutputStream(OutputStream outputStream) throws IOException {
this(outputStream, new DeflateParameters());
@@ -41,6 +43,9 @@ public class DeflateCompressorOutputStre
/**
* Creates a Deflate compressed output stream with the specified parameters.
+ * @param outputStream the stream to wrap
+ * @param parameters the deflate parameters to apply
+ * @throws IOException on error
*/
public DeflateCompressorOutputStream(OutputStream outputStream,
DeflateParameters parameters) throws IOException {
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorInputStream.java Wed Aug 12 03:24:07 2015
@@ -50,6 +50,8 @@ public class Pack200CompressorInputStrea
*
* <p>When reading from a file the File-arg constructor may
* provide better performance.</p>
+ *
+ * @param in the InputStream from which this object should be created
*/
public Pack200CompressorInputStream(final InputStream in)
throws IOException {
@@ -62,6 +64,9 @@ public class Pack200CompressorInputStrea
*
* <p>When reading from a file the File-arg constructor may
* provide better performance.</p>
+ *
+ * @param in the InputStream from which this object should be created
+ * @param mode the strategy to use
*/
public Pack200CompressorInputStream(final InputStream in,
final Pack200Strategy mode)
@@ -75,6 +80,9 @@ public class Pack200CompressorInputStrea
*
* <p>When reading from a file the File-arg constructor may
* provide better performance.</p>
+ *
+ * @param in the InputStream from which this object should be created
+ * @param props Pack200 properties to use
*/
public Pack200CompressorInputStream(final InputStream in,
final Map<String, String> props)
@@ -88,6 +96,10 @@ public class Pack200CompressorInputStrea
*
* <p>When reading from a file the File-arg constructor may
* provide better performance.</p>
+ *
+ * @param in the InputStream from which this object should be created
+ * @param mode the strategy to use
+ * @param props Pack200 properties to use
*/
public Pack200CompressorInputStream(final InputStream in,
final Pack200Strategy mode,
@@ -99,6 +111,8 @@ public class Pack200CompressorInputStrea
/**
* Decompresses the given file, caching the decompressed data in
* memory.
+ *
+ * @param f the file to decompress
*/
public Pack200CompressorInputStream(final File f) throws IOException {
this(f, Pack200Strategy.IN_MEMORY);
@@ -107,6 +121,9 @@ public class Pack200CompressorInputStrea
/**
* Decompresses the given file using the given strategy to cache
* the results.
+ *
+ * @param f the file to decompress
+ * @param mode the strategy to use
*/
public Pack200CompressorInputStream(final File f, final Pack200Strategy mode)
throws IOException {
@@ -116,6 +133,9 @@ public class Pack200CompressorInputStrea
/**
* Decompresses the given file, caching the decompressed data in
* memory and using the given properties.
+ *
+ * @param f the file to decompress
+ * @param props Pack200 properties to use
*/
public Pack200CompressorInputStream(final File f,
final Map<String, String> props)
@@ -126,6 +146,10 @@ public class Pack200CompressorInputStrea
/**
* Decompresses the given file using the given strategy to cache
* the results and the given properties.
+ *
+ * @param f the file to decompress
+ * @param mode the strategy to use
+ * @param props Pack200 properties to use
*/
public Pack200CompressorInputStream(final File f, final Pack200Strategy mode,
final Map<String, String> props)
Modified: commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorOutputStream.java
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorOutputStream.java?rev=1695419&r1=1695418&r2=1695419&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorOutputStream.java (original)
+++ commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/compressors/pack200/Pack200CompressorOutputStream.java Wed Aug 12 03:24:07 2015
@@ -43,6 +43,8 @@ public class Pack200CompressorOutputStre
/**
* Compresses the given stream, caching the compressed data in
* memory.
+ *
+ * @param out the stream to write to
*/
public Pack200CompressorOutputStream(final OutputStream out)
throws IOException {
@@ -52,6 +54,9 @@ public class Pack200CompressorOutputStre
/**
* Compresses the given stream using the given strategy to cache
* the results.
+ *
+ * @param out the stream to write to
+ * @param mode the strategy to use
*/
public Pack200CompressorOutputStream(final OutputStream out,
final Pack200Strategy mode)
@@ -62,6 +67,9 @@ public class Pack200CompressorOutputStre
/**
* Compresses the given stream, caching the compressed data in
* memory and using the given properties.
+ *
+ * @param out the stream to write to
+ * @param props Pack200 properties to use
*/
public Pack200CompressorOutputStream(final OutputStream out,
final Map<String, String> props)
@@ -72,6 +80,10 @@ public class Pack200CompressorOutputStre
/**
* Compresses the given stream using the given strategy to cache
* the results and the given properties.
+ *
+ * @param out the stream to write to
+ * @param mode the strategy to use
+ * @param props Pack200 properties to use
*/
public Pack200CompressorOutputStream(final OutputStream out,
final Pack200Strategy mode,
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -34,7 +34,9 @@ public class XZCompressorOutputStream ex
/**
* Creates a new XZ compressor using the default LZMA2 options.
- * This is equivalent to <code>XZCompressorOutputStream(6)</code>.
+ * This is equivalent to <code>XZCompressorOutputStream(outputStream, 6)</code>.
+ * @param outputStream the stream to wrap
+ * @throws IOException on error
*/
public XZCompressorOutputStream(OutputStream outputStream)
throws IOException {
@@ -53,6 +55,9 @@ public class XZCompressorOutputStream ex
* Unless the uncompressed size of the file exceeds 8 MiB,
* 16 MiB, or 32 MiB, it is waste of memory to use the
* presets 7, 8, or 9, respectively.
+ * @param outputStream the stream to wrap
+ * @param preset the preset
+ * @throws IOException on error
*/
public XZCompressorOutputStream(OutputStream outputStream, int preset)
throws IOException {
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=1695419&r1=1695418&r2=1695419&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 Wed Aug 12 03:24:07 2015
@@ -94,6 +94,7 @@ public class XZUtils {
/**
* Are the classes required to support XZ compression available?
* @since 1.5
+ * @return true if the classes required to support XZ compression are available
*/
public static boolean isXZCompressionAvailable() {
final CachedAvailability cachedResult = cachedXZAvailability;