spotbugs-filter.xml

<?xml version="1.0" encoding="UTF-8"?>

<FindBugsFilter xmlns="https://github.com/spotbugs/filter/3.0.0">

  <Match>
    <Class name="~com\.io7m\.blackthorne\..+\$InitShim"/>
    <Bug pattern="PME_POOR_MANS_ENUM"/>
  </Match>

  <Match>
    <Class name="~com\.io7m\.blackthorne\..+\$Builder"/>
    <Or>
      <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
      <Bug pattern="ITC_INHERITANCE_TYPE_CHECKING"/>
      <Bug pattern="PRMC_POSSIBLY_REDUNDANT_METHOD_CALLS"/>
      <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD"/>
    </Or>
  </Match>

  <!-- Function.identity() doesn't allow for variance. -->
  <Match>
    <Class name="com.io7m.blackthorne.core.Blackthorne"/>
    <Method name="widen"/>
    <Bug pattern="FII_USE_FUNCTION_IDENTITY"/>
  </Match>

  <!-- Safe. -->
  <Match>
    <Class name="com.io7m.blackthorne.core.internal.BTStackHandler"/>
    <Bug pattern="FORMAT_STRING_MANIPULATION"/>
  </Match>

  <!-- Used to assist with type inference. -->
  <Match>
    <Class name="com.io7m.blackthorne.core.internal.BTContentHandler"/>
    <Method name="builder"/>
    <Bug pattern="UP_UNUSED_PARAMETER"/>
  </Match>

  <!-- This class is entirely convenience methods. -->
  <Match>
    <Class name="com.io7m.blackthorne.core.Blackthorne"/>
    <Bug pattern="OPM_OVERLY_PERMISSIVE_METHOD"/>
  </Match>

  <!-- Simply wrong. -->
  <Match>
    <Class
      name="com.io7m.blackthorne.core.internal.BTStackHandler$StackElement"/>
    <Bug pattern="FCBL_FIELD_COULD_BE_LOCAL"/>
  </Match>

  <Match>
    <Or>
      <Class name="com.io7m.blackthorne.core.BTParseError"/>
      <Class name="com.io7m.blackthorne.core.BTQualifiedName"/>
    </Or>
  </Match>

  <Match>
    <Method name="builder"/>
    <Bug pattern="OPM_OVERLY_PERMISSIVE_METHOD"/>
  </Match>

  <!-- JXE prevents XXE issues. -->
  <Match>
    <Class name="com.io7m.blackthorne.core.Blackthorne"/>
    <Bug pattern="XXE_XMLREADER"/>
  </Match>

  <!-- Don't serialize exceptions. Deal with it. -->
  <Match>
    <Class name="com.io7m.blackthorne.core.BTException"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- The interface exists to be implemented. -->
  <Match>
    <Class name="com.io7m.blackthorne.core.BTException"/>
    <Bug pattern="SCII_SPOILED_CHILD_INTERFACE_IMPLEMENTOR"/>
  </Match>

  <Match>
    <Or>
      <Bug pattern="OPM_OVERLY_PERMISSIVE_METHOD"/>
      <Bug pattern="OCP_OVERLY_CONCRETE_PARAMETER"/>
      <Bug pattern="IMC_IMMATURE_CLASS_NO_TOSTRING"/>
      <Bug pattern="WEM_WEAK_EXCEPTION_MESSAGING"/>
      <Bug pattern="CRLF_INJECTION_LOGS"/>
      <Bug pattern="AI_ANNOTATION_ISSUES_NEEDS_NULLABLE"/>
    </Or>
  </Match>

</FindBugsFilter>