<?xml version="1.0"?>
<!--
   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

       http://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.
-->

<!--
  This file contains some false positive bugs detected by findbugs. Their
  false positive nature has been analyzed individually and they have been
  put here to instruct findbugs it must ignore them.
-->
<FindBugsFilter>

  <!--  explicit return of a null value for type Boolean is intended -->
  <Match>
    <Class name="org.apache.commons.collections4.MapUtils" />
    <Method name="getBoolean" params="java.util.Map, java.lang.Object" returns="java.lang.Boolean" />
    <Bug pattern="NP_BOOLEAN_RETURN_NULL" />
  </Match>

  <!--  Flat3Map and its inner classes use intentional switch fall-through. The missing  -->
  <!--  default clause is safe and omitted for better readability.                       -->
  <Match>
    <Or>
      <Class name="~.*\.Flat3Map$" />
      <Class name="~.*\.Flat3Map\$\w+Iterator$" />
    </Or>
    <Or>
	  <Bug pattern="SF_SWITCH_FALLTHROUGH" />
	  <Bug pattern="SF_SWITCH_NO_DEFAULT" />
    </Or>
  </Match>

  <!-- TreeBidiMap implements equals by delegating to another method for re-usability -->
  <Match>
    <Or>
      <Class name="org.apache.commons.collections4.bidimap.TreeBidiMap" />
      <Class name="org.apache.commons.collections4.bidimap.TreeBidiMap$Inverse" />
    </Or>
    <Bug pattern="EQ_UNUSUAL" />
  </Match>

  <!-- Access to field inverse is 100% synchronized, findbugs may be inaccurate for this check -->
  <Match>
    <Class name="org.apache.commons.collections4.bidimap.UnmodifiableBidiMap" />
    <Bug pattern="IS2_INCONSISTENT_SYNC" />
  </Match>

  <!-- The compare method in ComparatorChain has to handle a corner-case for Integer.MIN_VALUE -->
  <Match>
    <Class name="org.apache.commons.collections4.comparators.ComparatorChain" />
    <Method name="compare" params="java.lang.Object, java.lang.Object" returns="int" />
    <Bug pattern="RV_CHECK_COMPARETO_FOR_SPECIFIC_RETURN_VALUE" />
  </Match>

  <!-- The ObjectArrayIterator does iterate over an array, thus we do not want to copy it -->
  <Match>
    <Class name="org.apache.commons.collections4.iterators.ObjectArrayIterator" />
    <Or>
      <Bug pattern="EI_EXPOSE_REP" />
      <Bug pattern="EI_EXPOSE_REP2" />
    </Or>
  </Match>

  <!-- The constructor has a boolean argument which controls whether the array shall be copied or not -->
  <Match>
    <Class name="org.apache.commons.collections4.keyvalue.MultiKey" />
    <Method name="&lt;init&gt;" params="java.lang.Object[], boolean" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>

  <!-- The unread field is used to make a hard reference to ensure the value will not be gc'ed -->
  <Match>
    <Class name="org.apache.commons.collections4.map.AbstractReferenceMap$ReferenceBaseIterator" />
    <Bug pattern="URF_UNREAD_FIELD" />
  </Match>

</FindBugsFilter>
