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 2018/01/10 09:41:59 UTC

[1/2] commons-compress git commit: javadoc warnings

Repository: commons-compress
Updated Branches:
  refs/heads/master 3ead67802 -> 9240ae1b1


javadoc warnings


Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/5f69a4be
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/5f69a4be
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/5f69a4be

Branch: refs/heads/master
Commit: 5f69a4be525c96249ba882b5c5884fc98537631c
Parents: 3ead678
Author: Stefan Bodewig <bo...@apache.org>
Authored: Wed Jan 10 10:37:35 2018 +0100
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Wed Jan 10 10:37:35 2018 +0100

----------------------------------------------------------------------
 .../commons/compress/compressors/CompressorStreamFactory.java    | 1 +
 .../java/org/apache/commons/compress/utils/BitInputStream.java   | 4 ++++
 2 files changed, 5 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/5f69a4be/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
index 7118744..d5beab3 100644
--- a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
+++ b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java
@@ -317,6 +317,7 @@ public class CompressorStreamFactory implements CompressorStreamProvider {
 
     /**
      * @since 1.16
+     * @return the constant {@link #DEFLATE64}
      */
     public static String getDeflate64() {
         return DEFLATE64;

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/5f69a4be/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/utils/BitInputStream.java b/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
index 8105075..03d2348 100644
--- a/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
+++ b/src/main/java/org/apache/commons/compress/utils/BitInputStream.java
@@ -103,6 +103,7 @@ public class BitInputStream implements Closeable {
     /**
      * Returns the number of bits that can be read from this input
      * stream without reading from the underlying input stream at all.
+     * @return estimate of the number of bits that can be read without reading from the underlying stream
      * @since 1.16
      */
     public int bitsCached() {
@@ -113,6 +114,8 @@ public class BitInputStream implements Closeable {
      * Returns an estimate of the number of bits that can be read from
      * this input stream without blocking by the next invocation of a
      * method for this input stream.
+     * @throws IOException if the underlying stream throws one when calling available
+     * @return estimate of the number of bits that can be read without blocking
      * @since 1.16
      */
     public long bitsAvailable() throws IOException {
@@ -121,6 +124,7 @@ public class BitInputStream implements Closeable {
 
     /**
      * Drops bits until the next bits will be read from a byte boundary.
+     * @throws IOException if reading the remaining bits to the next byte boundary fails
      * @since 1.16
      */
     public void alignWithByteBoundary() throws IOException {


[2/2] commons-compress git commit: remove local variable that's no longer needed

Posted by bo...@apache.org.
remove local variable that's no longer needed


Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/9240ae1b
Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/9240ae1b
Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/9240ae1b

Branch: refs/heads/master
Commit: 9240ae1b1764232f1a3c53298dd2281b72d2466d
Parents: 5f69a4b
Author: Stefan Bodewig <bo...@apache.org>
Authored: Wed Jan 10 10:41:24 2018 +0100
Committer: Stefan Bodewig <bo...@apache.org>
Committed: Wed Jan 10 10:41:24 2018 +0100

----------------------------------------------------------------------
 .../java/org/apache/commons/compress/archivers/zip/ZipUtil.java     | 1 -
 1 file changed, 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/9240ae1b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
index 83822cf..8cc3e6a 100644
--- a/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
+++ b/src/main/java/org/apache/commons/compress/archivers/zip/ZipUtil.java
@@ -234,7 +234,6 @@ public abstract class ZipUtil {
                                                  final byte[] commentBytes) {
         final UnicodePathExtraField name = (UnicodePathExtraField)
             ze.getExtraField(UnicodePathExtraField.UPATH_ID);
-        final String originalName = ze.getName();
         final String newName = getUnicodeStringIfOriginalMatches(name,
                                                            originalNameBytes);
         if (newName != null) {