silence Sonar where we intentionally break its rules

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

Branch: refs/heads/master
Commit: 19e1b02f754a9b7bc969eb17bd52cc36a85c4d74
Parents: 14fbf3a
Author: Stefan Bodewig <bode...@apache.org>
Authored: Sat Jun 24 18:46:30 2017 +0200
Committer: Stefan Bodewig <bode...@apache.org>
Committed: Sat Jun 24 18:46:30 2017 +0200

----------------------------------------------------------------------
 .../commons/compress/archivers/dump/DumpArchiveEntry.java    | 5 +++--
 .../commons/compress/archivers/dump/TapeInputStream.java     | 6 +++---
 .../commons/compress/archivers/jar/JarArchiveEntry.java      | 2 +-
 .../commons/compress/archivers/tar/TarArchiveEntry.java      | 2 +-
 .../compress/archivers/zip/X5455_ExtendedTimestamp.java      | 4 ++--
 .../archivers/zip/Zip64ExtendedInformationExtraField.java    | 8 ++++----
 .../compress/archivers/zip/ZipArchiveInputStream.java        | 2 +-
 .../commons/compress/compressors/brotli/BrotliUtils.java     | 4 ++--
 .../compressors/lz4/BlockLZ4CompressorInputStream.java       | 4 ++--
 .../parallel/FileBasedScatterGatherBackingStore.java         | 2 +-
 10 files changed, 20 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
 
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
index c38cfda..84069a0 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/dump/DumpArchiveEntry.java
@@ -417,8 +417,9 @@ public class DumpArchiveEntry implements ArchiveEntry {
             return false;
         }
 
-        if ((summary == null && rhs.summary != null)
-            || (summary != null && !summary.equals(rhs.summary))) {
+        // summary is always null right now, but this may change some day
+        if ((summary == null && rhs.summary != null) // NOSONAR
+            || (summary != null && !summary.equals(rhs.summary))) { // NOSONAR
             return false;
         }
 

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java 
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
index 64579b6..e82db2d 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/dump/TapeInputStream.java
@@ -129,7 +129,7 @@ class TapeInputStream extends FilterInputStream {
             if (readOffset == blockSize) {
                 try {
                     readBlock(true);
-                } catch (ShortFileException sfe) {
+                } catch (ShortFileException sfe) { // NOSONAR
                     return -1;
                 }
             }
@@ -180,7 +180,7 @@ class TapeInputStream extends FilterInputStream {
             if (readOffset == blockSize) {
                 try {
                     readBlock((len - bytes) < blockSize);
-                } catch (ShortFileException sfe) {
+                } catch (ShortFileException sfe) { // NOSONAR
                     return -1;
                 }
             }
@@ -228,7 +228,7 @@ class TapeInputStream extends FilterInputStream {
         if (readOffset == blockSize) {
             try {
                 readBlock(true);
-            } catch (ShortFileException sfe) {
+            } catch (ShortFileException sfe) { // NOSONAR
                 return null;
             }
         }

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java 
b/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
index 835c840..f0c05f0 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/jar/JarArchiveEntry.java
@@ -74,7 +74,7 @@ public class JarArchiveEntry extends ZipArchiveEntry {
      */
     @Deprecated
     public Certificate[] getCertificates() {
-        if (certificates != null) { // never true currently
+        if (certificates != null) { // never true currently // NOSONAR
             final Certificate[] certs = new Certificate[certificates.length];
             System.arraycopy(certificates, 0, certs, 0, certs.length);
             return certs;

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java 
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
index 1d572d0..849532c 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/tar/TarArchiveEntry.java
@@ -1142,7 +1142,7 @@ public class TarArchiveEntry implements ArchiveEntry, 
TarConstants {
             isExtended = TarUtils.parseBoolean(header, offset);
             offset += ISEXTENDEDLEN_GNU;
             realSize = TarUtils.parseOctal(header, offset, REALSIZELEN_GNU);
-            offset += REALSIZELEN_GNU;
+            offset += REALSIZELEN_GNU; // NOSONAR - assignment as documentation
             break;
         }
         case FORMAT_XSTAR: {

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
 
b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
index 4c7746c..90bd750 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/zip/X5455_ExtendedTimestamp.java
@@ -187,7 +187,7 @@ public class X5455_ExtendedTimestamp implements 
ZipExtraField, Cloneable, Serial
         if (bit2_createTimePresent && createTime != null) {
             data[0] |= CREATE_TIME_BIT;
             System.arraycopy(createTime.getBytes(), 0, data, pos, 4);
-            pos += 4;
+            pos += 4; // NOSONAR - assignment as documentation
         }
         return data;
     }
@@ -237,7 +237,7 @@ public class X5455_ExtendedTimestamp implements 
ZipExtraField, Cloneable, Serial
         }
         if (bit2_createTimePresent && offset + 4 <= len) {
             createTime = new ZipLong(data, offset);
-            offset += 4;
+            offset += 4; // NOSONAR - assignment as documentation
         }
     }
 

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
 
b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
index 9913547..ee2025c 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/zip/Zip64ExtendedInformationExtraField.java
@@ -144,7 +144,7 @@ public class Zip64ExtendedInformationExtraField implements 
ZipExtraField {
         }
         if (diskStart != null) {
             System.arraycopy(diskStart.getBytes(), 0, data, off, WORD);
-            off += WORD;
+            off += WORD; // NOSONAR - assignment as documentation
         }
         return data;
     }
@@ -174,8 +174,8 @@ public class Zip64ExtendedInformationExtraField implements 
ZipExtraField {
         }
         if (remaining >= WORD) {
             diskStart = new ZipLong(buffer, offset);
-            offset += WORD;
-            remaining -= WORD;
+            offset += WORD; // NOSONAR - assignment as documentation
+            remaining -= WORD; // NOSONAR - assignment as documentation
         }
     }
 
@@ -256,7 +256,7 @@ public class Zip64ExtendedInformationExtraField implements 
ZipExtraField {
             }
             if (hasDiskStart) {
                 diskStart = new ZipLong(rawCentralDirectoryData, offset);
-                offset += WORD;
+                offset += WORD; // NOSONAR - assignment as documentation
             }
         }
     }

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
 
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
index 7fda989..eef8990 100644
--- 
a/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/archivers/zip/ZipArchiveInputStream.java
@@ -292,7 +292,7 @@ public class ZipArchiveInputStream extends 
ArchiveInputStream {
         off += SHORT;
 
         final int extraLen = ZipShort.getValue(lfhBuf, off);
-        off += SHORT;
+        off += SHORT; // NOSONAR - assignment as documentation
 
         final byte[] fileName = new byte[fileNameLen];
         readFully(fileName);

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java 
b/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
index 251d98d..bb22390 100644
--- 
a/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
+++ 
b/src/main/java/org/apache/commons/compress/compressors/brotli/BrotliUtils.java
@@ -35,7 +35,7 @@ public class BrotliUtils {
         cachedBrotliAvailability = CachedAvailability.DONT_CACHE;
         try {
             Class.forName("org.osgi.framework.BundleEvent");
-        } catch (final Exception ex) {
+        } catch (final Exception ex) { // NOSONAR
             setCacheBrotliAvailablity(true);
         }
     }
@@ -61,7 +61,7 @@ public class BrotliUtils {
         try {
             Class.forName("org.brotli.dec.BrotliInputStream");
             return true;
-        } catch (NoClassDefFoundError | Exception error) {
+        } catch (NoClassDefFoundError | Exception error) { // NOSONAR
             return false;
         }
     }

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorInputStream.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorInputStream.java
 
b/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorInputStream.java
index f0903a4..a52dc60 100644
--- 
a/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorInputStream.java
+++ 
b/src/main/java/org/apache/commons/compress/compressors/lz4/BlockLZ4CompressorInputStream.java
@@ -64,7 +64,7 @@ public class BlockLZ4CompressorInputStream extends 
AbstractLZ77CompressorInputSt
         switch (state) {
         case EOF:
             return -1;
-        case NO_BLOCK:
+        case NO_BLOCK: // NOSONAR - fallthrough intended
             readSizes();
             /*FALLTHROUGH*/
         case IN_LITERAL:
@@ -73,7 +73,7 @@ public class BlockLZ4CompressorInputStream extends 
AbstractLZ77CompressorInputSt
                 state = State.LOOKING_FOR_BACK_REFERENCE;
             }
             return litLen > 0 ? litLen : read(b, off, len);
-        case LOOKING_FOR_BACK_REFERENCE:
+        case LOOKING_FOR_BACK_REFERENCE: // NOSONAR - fallthrough intended
             if (!initializeBackReference()) {
                 state = State.EOF;
                 return -1;

http://git-wip-us.apache.org/repos/asf/commons-compress/blob/19e1b02f/src/main/java/org/apache/commons/compress/parallel/FileBasedScatterGatherBackingStore.java
----------------------------------------------------------------------
diff --git 
a/src/main/java/org/apache/commons/compress/parallel/FileBasedScatterGatherBackingStore.java
 
b/src/main/java/org/apache/commons/compress/parallel/FileBasedScatterGatherBackingStore.java
index ce6ac07..92b447f 100644
--- 
a/src/main/java/org/apache/commons/compress/parallel/FileBasedScatterGatherBackingStore.java
+++ 
b/src/main/java/org/apache/commons/compress/parallel/FileBasedScatterGatherBackingStore.java
@@ -42,7 +42,7 @@ public class FileBasedScatterGatherBackingStore implements 
ScatterGatherBackingS
             throw ex;
         } catch (IOException ex) {
             // must convert exception to stay backwards compatible with 
Compress 1.10 to 1.13
-            throw new RuntimeException(ex);
+            throw new RuntimeException(ex); // NOSONAR
         }
     }
 

Reply via email to