Add SpotBugs exclusion filter

Author: garydgregory

pom.xml

@@ -142,6 +142,13 @@ limitations under the License.
             <resourceExcludes>NOTICE.txt,LICENSE.txt,**/pom.properties,**/sha512.properties</resourceExcludes>
           </configuration>
         </plugin>        
+        <plugin>
+          <groupId>com.github.spotbugs</groupId>
+          <artifactId>spotbugs-maven-plugin</artifactId>
+          <configuration>
+            <excludeFilterFile>${basedir}/src/conf/spotbugs-exclude-filter.xml</excludeFilterFile>
+          </configuration>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>

src/conf/spotbugs-exclude-filter.xml

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<FindBugsFilter xmlns="https://github.com/spotbugs/filter/3.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="https://github.com/spotbugs/filter/3.0.0 https://raw.githubusercontent.com/spotbugs/spotbugs/3.1.0/spotbugs/etc/findbugsfilter.xsd">
+  <Match>
+    <!-- Deprecated, binary compatibility. -->
+    <Bug pattern="SS_SHOULD_BE_STATIC" />
+    <Class name="org.apache.commons.codec.binary.BaseNCodec" />
+    <Field name="PAD" />
+  </Match>
+  <Match>
+    <!-- By design -->
+    <Bug pattern="SF_SWITCH_NO_DEFAULT" />
+    <Class name="org.apache.commons.codec.digest.MurmurHash2" />
+  </Match>
+  <Match>
+    <!-- By design -->
+    <Bug pattern="SF_SWITCH_NO_DEFAULT" />
+    <Class name="org.apache.commons.codec.digest.MurmurHash3" />
+  </Match>
+  <Match>
+    <!-- By design -->
+    <Bug pattern="SF_SWITCH_NO_DEFAULT" />
+    <Class name="org.apache.commons.codec.digest.MurmurHash3$IncrementalHash32" />
+  </Match>
+  <Match>
+    <!-- By design -->
+    <Bug pattern="SF_SWITCH_NO_DEFAULT" />
+    <Class name="org.apache.commons.codec.digest.MurmurHash3$IncrementalHash32x86" />
+  </Match>
+  <Match>
+    <!-- By design -->
+    <Bug pattern="SF_SWITCH_NO_DEFAULT" />
+    <Class name="org.apache.commons.codec.digest.PureJavaCrc32" />
+  </Match>
+  <Match>
+    <!-- By design -->
+    <Bug pattern="SF_SWITCH_NO_DEFAULT" />
+    <Class name="org.apache.commons.codec.digest.PureJavaCrc32C" />
+  </Match>
+  <Match>
+    <!-- TODO ? / By design -->
+    <Bug pattern="SF_SWITCH_FALLTHROUGH" />
+  </Match>  
+  <Match>
+    <!-- TODO ? -->
+    <Bug pattern="CT_CONSTRUCTOR_THROW" />
+  </Match>
+  <Match>
+    <!-- TODO ? -->
+    <Bug pattern="ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT" />
+    <Class name="org.apache.commons.codec.digest.Blake3" />
+    <Method name="packInt" />
+  </Match>
+  <Match>
+    <!-- TODO ? -->
+    <Bug pattern="EI_EXPOSE_REP2" />
+    <Class name="org.apache.commons.codec.language.DoubleMetaphone$DoubleMetaphoneResult" />
+    <Method name="&lt;init&gt;" />
+  </Match>
+  <Match>
+    <!-- TODO ? -->
+    <Bug pattern="EI_EXPOSE_REP" />
+    <Class name="org.apache.commons.codec.language.bm.Languages" />
+    <Method name="getLanguages" />
+  </Match>
+  <Match>
+    <!-- Seems like an FP since the return type is a CharSequence. -->
+    <Bug pattern="EI_EXPOSE_REP" />
+    <Class name="org.apache.commons.codec.language.bm.Rule$Phoneme" />
+    <Method name="getPhonemeText" />
+  </Match>
+  <Match>
+    <!-- TODO ? -->
+    <Bug pattern="EI_EXPOSE_REP" />
+    <Class name="org.apache.commons.codec.language.bm.Rule$PhonemeList" />
+    <Method name="getPhonemes" />
+  </Match>
+  <Match>
+    <!-- TODO ? -->
+    <Bug pattern="EI_EXPOSE_REP2" />
+    <Class name="org.apache.commons.codec.language.bm.Rule$PhonemeList" />
+    <Method name="&lt;init&gt;" />
+  </Match>
+</FindBugsFilter>