spotbugs-exclude-filter.xml

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

  <!-- the following serialization classes already takes care of non-serializable parts. -->
  <Match>
    <Or>
      <Class name="~.*\.DSSTPropagator\$MeanPlusShortPeriodicMapper\$DataTransferObject$" />
      <Class name="~.*\.IntegratedEphemeris\$DataTransferObject$" />
      <Class name="~.*\.KeplerianPropagator\$DataTransferObject$" />
      <Class name="~.*\.EcksteinHechlerPropagator\$DataTransferObject$" />
	  <Class name="~.*\.SigmaEigenvectorsCovarianceKey$" />
    </Or>
    <Bug pattern="SE_BAD_FIELD" />
  </Match>

  <!-- the following classes are serialized using writeReplace/readResolve with proxy classes,
       so the is no real problem about the base class not having a proper constructor.  -->
  <Match>
    <Or>
      <Class name="~.*\.AbstractAnalyticalPropagator\$BoundedPropagatorView$" />
      <Class name="~.*\.KeplerianPropagator$" />
      <Class name="~.*\.EcksteinHechlerPropagator$" />
      <Class name="~.*\.Ephemeris$" />
      <Class name="~.*\.GlobalIonosphereMapModel$" />
      <Class name="~.*\.MarshallSolarActivityFutureEstimation$" />
      <Class name="~.*\.CssiSpaceWeatherData$" />
      <Class name="~.*\.IntegratedEphemeris$" />
      <Class name="~.*\.DSSTPropagator\$MeanPlusShortPeriodicMapper$" />
      <Class name="~.*\.NumericalPropagator\$OsculatingMapper$" />
    </Or>
    <Bug pattern="SE_NO_SUITABLE_CONSTRUCTOR" />
  </Match>
  <Match>
    <Or>
      <Class name="~.*\.DSSTPropagator\$MeanPlusShortPeriodicMapper$" />
      <Class name="~.*\.AbstractGaussianContribution\$GaussianShortPeriodicCoefficients$" />
      <Class name="~.*\.DSSTThirdBody\$ThirdBodyShortPeriodicCoefficients$" />
      <Class name="~.*\.TesseralContributionContribution\$TesseralShortPeriodicCoefficients$" />
      <Class name="~.*\.ZonalContribution\$ZonalShortPeriodicCoefficients$" />
      <Class name="~.*\.FieldOfView$" />
      <Class name="~.*\.FootprintOverlapDetector$" />
      <Class name="~.*\.GeographicZoneDetector$" />
      <Class name="~.*\.SaastamoinenModel$" />
      <Class name="~.*\.EventEnablingPredicateFilter$" />
      <Class name="~.*\.FixedTransformProvider$" />
      <Class name="~.*\.InterpolatingTransformProvider$" />
      <Class name="~.*\.ShiftingTransformProvider$" />
      <Class name="~.*\.MODProvider$" />
      <Class name="~.*\.TIRFProvider$" />
      <Class name="~.*\.CartesianOrbit$" />
      <Class name="~.*\.EstimatedEarthFrameProvider$" />
      <Class name="~.*\.GNSSDate$" />
      <Class name="~.*\.GLONASSDate$" />
      <Class name="~.*\.PositionAngleDetector$" />
    </Or>
    <Bug pattern="SE_TRANSIENT_FIELD_NOT_RESTORED" />
  </Match>

  <!-- the following are in fact false positives from SpotBugs -->
  <!-- their occurrence depends on the java compiler used      -->
  <Match>
    <Class name="~.*\.NeQuickItu$"/>
    <Method name="stec" />
    <Or>
      <Local name="h1000" />
      <Local name="h2000" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.EcksteinHechlerPropagator$"/>
    <Method name="computeMeanParameters" />
    <Or>
      <Local name="epsilon" />
      <Local name="thresholdAngles" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.DTM2000$"/>
    <Method name="computation" />
    <Or>
      <Local name="zlb" />
      <Local name="zlbre" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.SDP4$"/>
    <Method name="thetaG" />
    <Or>
      <Local name="omega_E" />
      <Local name="seconds_per_day" />
      <Local name="jd_2000" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.TLEPropagator$"/>
    <Method name="computePVCoordinates" />
    <Or>
      <Local name="newtonRaphsonEpsilon" />
      <Local name="cv" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.JPLEphemeridesLoader$"/>
    <Method name="tooFarRange" />
    <Local name="fiftyDays" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.JB2006$"/>
    <Method name="getDensity" />
    <Local name="FACT1" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.JB2006$"/>
    <Method name="dTc" />
    <Local name="HP" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.OneAxisEllipsoid$"/>
    <Method name="transform" />
    <Local name="epsPhi" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.RangeTroposphericDelayModifier$"/>
    <Method name="modify" />
    <Local name="djac" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.RangeRateTroposphericDelayModifier$"/>
    <Method name="modify" />
    <Local name="djac" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.TurnAroundRangeTroposphericDelayModifier$"/>
    <Method name="modify" />
    <Or>
      <Local name="primaryDjac" />
      <Local name="secondaryDjac" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.IERSConventions\$1"/>
    <Method name="getEOPTidalCorrection" />
    <Or>
      <Local name="deciMilliS" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.IERSConventions\$1"/>
    <Method name="getXYSpXY2Function" />
    <Or>
      <Local name="fYCosOm" />
      <Local name="fYCos2FDOm" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.IERSConventions\$1"/>
    <Method name="getXYSpXY2Function" />
    <Or>
      <Local name="fST" />
      <Local name="fST3" />
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.IERSConventions\$2"/>
    <Method name="getGASTFunction" />
    <Local name="microAS" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>
  <Match>
    <Class name="~.*\.IERSConventions\$2"/>
    <Method name="getSolidPoleTide" />
    <Local name="xp0" />
    <Bug pattern="DLS_DEAD_LOCAL_STORE" />
  </Match>

  <!-- the approximate constants do belong to the models -->
  <Match>
    <Class name="~.*\.JB2006$"/>
    <Bug pattern="CNT_ROUGH_CONSTANT_VALUE" />
  </Match>
  <Match>
    <Class name="~.*\.SEMParser$"/>
    <Bug pattern="CNT_ROUGH_CONSTANT_VALUE" />
  </Match>
  <Match>
    <Class name="~.*\.Units$"/>
    <Bug pattern="CNT_ROUGH_CONSTANT_VALUE" />
  </Match>
  <Match>
    <Class name="~.*\.IonosphereKlobucharMessage$"/>
    <Bug pattern="CNT_ROUGH_CONSTANT_VALUE" />
  </Match>
  
  <!-- The following is a false positive from SpotBugs -->
  <Match>
    <Class name="~.*\.IntegratedEphemeris\$LocalProvider$"/>
    <Method name="getAdditionalState" />
    <Bug pattern="BC_VACUOUS_INSTANCEOF" />
  </Match>

  <!-- The following equality tests are intentional and needed for semantic purposes -->
  <Match>
    <Class name="org.orekit.time.TimeComponents" />
    <Method name="equals" params="java.lang.Object" returns="boolean" />
    <Bug pattern="FE_FLOATING_POINT_EQUALITY" />
  </Match>
  <Match>
    <Class name="org.orekit.orbits.KeplerianOrbit"/>
    <Or>
      <Method name ="eMeSinE" params="double,double" returns="double" />
      <Method name ="eMeSinE" params="org.hipparchus.analysis.differentiation.DerivativeStructure,org.hipparchus.analysis.differentiation.DerivativeStructure" returns="org.hipparchus.analysis.differentiation.DerivativeStructure" />
    </Or>
    <Bug pattern="FE_FLOATING_POINT_EQUALITY" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.tle.TLE" />
    <Method name="equals" params="java.lang.Object" returns="boolean" />
    <Bug pattern="FE_FLOATING_POINT_EQUALITY" />
  </Match>

  <!-- The following internal representation exposure are intentional,
       They are used to pass data back and forth between classes
    -->
  <Match>
    <Class name="org.orekit.forces.gravity.HolmesFeatherstoneAttractionModel$GradientHessian"/>
    <Or>  
      <Method name="getGradient" params="" returns="double[]" />
      <Method name="getHessian" params="" returns="double[][]" />
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.forces.gravity.HolmesFeatherstoneAttractionModel$GradientHessian"/>
    <Method name="&lt;init>"  params="double[],double[][]" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>

  <!-- The following internal representation exposure are intentional,
       They are used to pass data back and forth between classes
    -->
  <Match>
    <Class name="org.orekit.files.sinex.orbex.Data"/>
    <Or>
      <Method name="orbit" />
      <Method name="attitude" />
      <Method name="clock" />
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.files.sinex.orbex.Data"/>
    <Method name="&lt;init>"  params="org.orekit.gnss.SatInSystem,java.lang.String,java.util.List,java.util.List,java.util.List" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Class name="org.orekit.files.sinex.orbex.Description"/>
    <Or>
      <Method name="positionUnit" />
      <Method name="velocityUnit" />
      <Method name="clockCorrectionUnit" />
      <Method name="clockRateUnit" />
      <Method name="coordinateSystem" />
      <Method name="recordTypes" />
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.files.sinex.orbex.Description"/>
    <Method name="&lt;init>"  params="java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.orekit.gnss.TimeSystem,double,org.orekit.frames.Frame,java.lang.String,java.lang.String,java.util.List,java.lang.String,org.orekit.utils.units.Unit,org.orekit.utils.units.Unit,org.orekit.utils.units.Unit,org.orekit.utils.units.Unit" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Class name="org.orekit.files.sinex.orbex.Orbex"/>
    <Method name="getData" />
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Or>
      <Class name="org.orekit.files.rinex.navigation.RinexNavigationParser"/>
      <Class name="org.orekit.files.rinex.navigation.parsers.ParseInfo"/>
    </Or>
    <Method name="&lt;init>" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Class name="org.orekit.files.rinex.navigation.parsers.ephemeris.CivilianLevel1NavigationParser"/>
    <Method name="getParseInfo" />
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Or>
      <Class name="org.orekit.gnss.SEMParser"/>
      <Class name="org.orekit.gnss.YUMAParser"/>
    </Or>
    <Method name="&lt;init>" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Or>
      <Class name="org.orekit.gnss.metric.messages.rtcm.ephemeris.Rtcm1019Data"/>
      <Class name="org.orekit.gnss.metric.messages.rtcm.ephemeris.Rtcm1042Data"/>
      <Class name="org.orekit.gnss.metric.messages.rtcm.ephemeris.Rtcm1044Data"/>
      <Class name="org.orekit.gnss.metric.messages.rtcm.ephemeris.Rtcm1046Data"/>
    </Or>
    <Method name="&lt;init>"  returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Or>
      <Class name="org.orekit.gnss.metric.ntrip.NtripClient"/>
      <Class name="org.orekit.gnss.metric.ntrip.StreamMonitor"/>
    </Or>
    <Method name="&lt;init>" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Class name="org.orekit.orbits.AbstractOrbitalParameterFactory"/>
    <Or>
      <Method name="getOrbitalParametersDrivers" />
      <Method name="getFrame" />
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.orbits.AbstractOrbitalParameterFactory"/>
    <Method name="setFrame" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Or>
      <Class name="org.orekit.propagation.analytical.gnss.data.FieldBeidouCivilianNavigationMessage"/>
      <Class name="org.orekit.propagation.analytical.gnss.data.FieldBeidouLegacyNavigationMessage"/>
      <Class name="org.orekit.propagation.analytical.gnss.data.FieldCivilianNavigationMessage"/>
      <Class name="org.orekit.propagation.analytical.gnss.data.FieldGalileoNavigationMessage"/>
      <Class name="org.orekit.propagation.analytical.gnss.data.FieldGnssOrbitalElements"/>
      <Class name="org.orekit.propagation.analytical.gnss.data.FieldLegacyNavigationMessage"/>
      <Class name="org.orekit.propagation.analytical.gnss.data.FieldNavicL1NvNavigationMessage"/>
    </Or>
    <Method name="&lt;init>" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.gnss.data.FieldGnssOrbitalElements"/>
    <Or>
      <Method name="getOrbit" />
      <Method name="getADot" />
      <Method name="getDeltaN0" />
      <Method name="getDeltaN0Dot" />
      <Method name="getIDot" />
      <Method name="getOmegaDot" />
      <Method name="getCuc" />
      <Method name="getCus" />
      <Method name="getCrc" />
      <Method name="getCrs" />
      <Method name="getCic" />
      <Method name="getCis" />
      <Method name="getAf0" />
      <Method name="getAf1" />
      <Method name="getAf2" />
      <Method name="getTgd" />
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.gnss.data.FieldGalileoNavigationMessage"/>
    <Method name="getBGDE1E5a" />
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.gnss.data.GNSSOrbitalElements"/>
    <Method name="getOrbit" />
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.gnss.data.GNSSOrbitalElementsFactory"/>
    <Or>
      <Method name="getInertial" />
      <Method name="getBodyFixed" />
      <Method name="getNonKeplerianParametersDrivers" />
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.gnss.data.NonKeplerianDriversFactory"/>
    <Or>
      <Method name="getTimeDriver" />
      <Method name="getADotDriver" />
      <Method name="getDeltaN0Driver" />
      <Method name="getDeltaN0DotDriver" />
      <Method name="getIDotDriver" />
      <Method name="getOmegaDotDriver" />
      <Method name="getCucDriver" />
      <Method name="getCusDriver" />
      <Method name="getCrcDriver" />
      <Method name="getCrsDriver" />
      <Method name="getCicDriver" />
      <Method name="getCisDriver" />
      <Method name="getAf0Driver" />
      <Method name="getAf1Driver" />
      <Method name="getAf2Driver" />
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Or>
      <Class name="org.orekit.propagation.analytical.tle.FieldTLE"/>
      <Class name="org.orekit.propagation.analytical.tle.generation.LeastSquaresTleGenerationAlgorithm"/>
    </Or>
    <Method name="&lt;init>" returns="void" />
    <Bug pattern="EI_EXPOSE_REP2" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.tle.FieldTLE"/>
    <Method name="getBStar"/>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.analytical.tle.generation.TleGenerationAlgorithm"/>
    <Or>
      <Method name="getConverter"/>
      <Method name="getNonKeplerianParametersDrivers"/>
    </Or>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>
  <Match>
    <Class name="org.orekit.propagation.conversion.AbstractPropagatorBuilder"/>
    <Method name="getOrbitalParameterFactory"/>
    <Bug pattern="EI_EXPOSE_REP" />
  </Match>

  <!-- the following is an intended switch fall-through in the SP3Parser -->
  <Match>
    <Class name="~.*\.SP3Parser$"/>
    <Method name="parseHeaderLine" />
    <Bug pattern="SF_SWITCH_FALLTHROUGH" />
  </Match>

  <!-- the following is a false positive as the listFiles method is called
       on a parameter already known to be a directory (so it does not return null) -->
  <Match>
    <Class name="~.*\.DirectoryCrawler$"/>
    <Method name="feed"   params="java.util.regex.Pattern,org.orekit.data.DataLoader,java.io.File" returns="boolean" />
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE" />
  </Match>

  <!-- the following is a false positive as the inverseCrossProducts method either
        returns eatly, throws an exception or sets the omega variable to non-null  -->
  <Match>
    <Class name="~.*\.FieldAngularCoordinates$"/>
    <Method name="inverseCrossProducts" />
    <Bug pattern="NP_NULL_ON_SOME_PATH_EXCEPTION" />
  </Match>

  <!-- the following is a false positive as the Direction.next() always return non-null
       and Direction is an enumerate that can't be changed -->
  <Match>
    <Class name="~.*\.Mesh$"/>
    <Method name="getTaxicabBoundary"   params="boolean" />
    <Bug pattern="NP_NULL_PARAM_DEREF" />
  </Match>

  <!-- the following is a false positive as this should never happen
       with files embedded in Orekit -->
  <Match>
    <Class name="~.*\.IERSConventions$"/>
    <Method name="loadLoveNumbers" />
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE" />
  </Match>

  <!-- The following is intentional.
       At the construction, the mapper is not set yet However, if the attitude provider is
       changed afterwards, it must be changed in the mapper too
    -->
  <Match>
    <Class name="~.*\.IntegratedEphemeris$"/>
    <Method name="setAttitudeProvider" />
    <Bug pattern="UR_UNINIT_READ_CALLED_FROM_SUPER_CONSTRUCTOR" />
  </Match>

</FindBugsFilter>