<?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>
    <Class name="org.apache.commons.text.ExtendedMessageFormat" />
    <Bug code="UR" />
  </Match>
  <Match>
    <Class name="org.apache.commons.text.ExtendedMessageFormat" />
    <!-- False positives -->
    <!--  [lines 225-227] SF_SWITCH_FALLTHROUGH -->
    <!--  [lines 424-426] SF_SWITCH_FALLTHROUGH -->
    <Bug pattern="SF_SWITCH_FALLTHROUGH" />
  </Match>
  <Match>
    <!-- False positives in regard to Locale property exposing inner implementation
    details of class. However, Locale is not mutable and therefore safe in this context. -->
    <Class name="org.apache.commons.text.similarity.FuzzyScore" />
    <Bug code="EI,EI2" />
  </Match>
  <Match>
    <Class name="org.apache.commons.text.StrTokenizer" />
    <Method name="clone" />
    <Bug code="CN" />
  </Match>
  <Match>
    <Class name="org.apache.commons.text.StringTokenizer" />
    <Method name="clone" />
    <Bug code="CN" />
  </Match>
  <!-- BiFunctionStringLookup#lookup catches NPE to return null -->
  <Match>
    <Class name="org.apache.commons.text.lookup.BiFunctionStringLookup" />
    <Method name="lookup" />
    <Bug pattern="DCN_NULLPOINTER_EXCEPTION" />
  </Match>
  <!-- FunctionStringLookup#lookup catches NPE to return null -->
  <Match>
    <Class name="org.apache.commons.text.lookup.FunctionStringLookup" />
    <Method name="lookup" />
    <Bug pattern="DCN_NULLPOINTER_EXCEPTION" />
  </Match>
  <!-- https://github.com/spotbugs/spotbugs/issues/2710 -->
  <Match>
    <Class name="~.*" />
    <Bug pattern="CT_CONSTRUCTOR_THROW" />
  </Match>
  <!-- Can't make ctor private until next major release -->
  <Match>
    <Class name="org.apache.commons.text.similarity.LevenshteinDetailedDistance" />
    <Bug pattern="SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR" />
  </Match>
  <!-- Can't make ctor private until next major release -->
  <Match>
    <Class name="org.apache.commons.text.similarity.LevenshteinDistance" />
    <Bug pattern="SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR" />
  </Match>
  <!-- RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT false positive: Exceptions can be thrown -->
  <Match>
    <Class name="org.apache.commons.text.TextStringBuilder" />
    <Method name="insert" />
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT" />
  </Match>
</FindBugsFilter>
