src/conf/spotbugs/spotbugs-exclude-filter.xml

<?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 spotbugs. Their
  false positive nature has been analyzed individually and they have been
  put here to instruct spotbugs it must ignore them.
-->
<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="~.*\.jmh_generated\..*" />
  </Match>

  <!-- The following types are immutable (or effectively immutable) and are not a risk for
  exposing implementation internals. -->
  <Match>
    <Or>
      <Field type="java.lang.Class" />
      <Field type="java.net.URL" />
      <Field type="java.nio.charset.Charset" />

      <Field type="org.apache.commons.geometry.euclidean.oned.Vector1D" />
      <Field type="org.apache.commons.geometry.euclidean.oned.Vector1D$Unit" />

      <Field type="org.apache.commons.geometry.euclidean.twod.Vector2D" />
      <Field type="org.apache.commons.geometry.euclidean.twod.Vector2D$Unit" />

      <Field type="org.apache.commons.geometry.euclidean.threed.Vector3D" />
      <Field type="org.apache.commons.geometry.euclidean.threed.Vector3D$Unit" />
    </Or>
    <BugPattern name="EI_EXPOSE_REP,EI_EXPOSE_REP2"/>
  </Match>

  <Match>
    <Or>
      <Class name="org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion"/>
      <Class name="org.apache.commons.geometry.core.partitioning.BoundaryList"/>
      <Class name="~.*\.geometry\.core\.partitioning\.bsp\.AbstractBSPTree.*"/>
      <Class name="org.apache.commons.geometry.core.partitioning.bsp.RegionCutBoundary"/>

      <Class name="org.apache.commons.geometry.euclidean.internal.AbstractPathConnector$ConnectableElement"/>
      <Class name="org.apache.commons.geometry.euclidean.threed.EmbeddedTreePlaneSubset"/>
      <Class name="org.apache.commons.geometry.euclidean.threed.line.EmbeddedTreeLineSubset3D"/>
      <Class name="org.apache.commons.geometry.euclidean.threed.mesh.SimpleTriangleMesh"/>
      <Class name="org.apache.commons.geometry.euclidean.twod.RegionBSPTree2D"/>
      <Class name="org.apache.commons.geometry.euclidean.twod.path.LinePath"/>
      <Class name="org.apache.commons.geometry.euclidean.twod.EmbeddedTreeLineSubset"/>

      <Class name="org.apache.commons.geometry.enclosing.EnclosingBall"/>

      <Class name="org.apache.commons.geometry.spherical.twod.EmbeddedTreeGreatCircleSubset"/>
      <Class name="org.apache.commons.geometry.spherical.twod.RegionBSPTree2S"/>
      <Class name="org.apache.commons.geometry.spherical.twod.GreatArcPath"/>

      <Class name="org.apache.commons.geometry.hull.euclidean.twod.ConvexHull2D"/>

      <Class name="org.apache.commons.geometry.io.core.internal.SimpleTextParser"/>
      <Class name="org.apache.commons.geometry.io.core.output.StreamGeometryOutput"/>

      <Class name="org.apache.commons.geometry.io.euclidean.threed.GeometryFormat3D"/>
      <Class name="org.apache.commons.geometry.io.euclidean.threed.SimpleFacetDefinition"/>
      <Class name="org.apache.commons.geometry.io.euclidean.threed.obj.PolygonObjParser$Face"/>
      <Class name="org.apache.commons.geometry.io.euclidean.threed.stl.BinaryStlWriter"/>

      <Class name="~.*\.geometry\.examples\.jmh\..*"/>
    </Or>
    <BugPattern name="EI_EXPOSE_REP,EI_EXPOSE_REP2"/>
  </Match>

  <!--
    AbstractBucketPointMap.entrySetInstance is stateless and can be cached and reused without
    exposing implementation internals.
  -->
  <Match>
    <Class name="org.apache.commons.geometry.core.internal.AbstractBucketPointMap" />
    <Field name="entrySetInstance" />
    <BugPattern name="EI_EXPOSE_REP"/>
  </Match>
  <Match>
    <Class name="org.apache.commons.geometry.euclidean.threed.hull.ConvexHull3D" />
    <Field name="facets" />
    <BugPattern name="EI_EXPOSE_REP"/>
  </Match>
  <!-- False positive singleton identification -->
  <Match>
    <Or>
      <Class name="org.apache.commons.geometry.core.internal.SimpleTupleFormat" />
      <Class name="org.apache.commons.geometry.euclidean.threed.ConvexVolume" />
      <Class name="org.apache.commons.geometry.euclidean.twod.path.LinePath" />
      <Class name="org.apache.commons.geometry.spherical.twod.GreatArcPath" />
    </Or>
    <BugPattern name="SING_SINGLETON_HAS_NONPRIVATE_CONSTRUCTOR"/>
  </Match>
  <!-- False positive -->
  <Match>
    <Or>
      <Class name="org.apache.commons.geometry.io.core.internal.CharReadBuffer" />
      <Class name="org.apache.commons.geometry.io.euclidean.threed.SimpleFacetDefinition" />
      <Class name="org.apache.commons.geometry.io.euclidean.threed.txt.TextFacetDefinitionReader" />
    </Or>
    <BugPattern name="CT_CONSTRUCTOR_THROW"/>
  </Match>

</FindBugsFilter>