sdks/java/build-tools/src/main/resources/beam/suppressions.xml

<?xml version="1.0"?>
<!--
  Licensed 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. See accompanying LICENSE file.
-->
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
  <suppress checks="JavadocPackage" files=".*[\\\/]src[\\\/]test[\\\/].*"/>
  <suppress checks="JavadocPackage" files=".*[\\\/]maven-archetypes[\\\/].*"/>
  <suppress checks="JavadocPackage" files=".*[\\\/]examples[\\\/].*"/>
  
  <suppress checks="JavadocMethod" files=".*Test\.java"/>
  <suppress checks="JavadocMethod" files=".*[\\\/]src[\\\/]test[\\\/].*"/>
  <suppress checks="JavadocMethod" files=".*[\\\/]examples[\\\/].*"/>

  <!-- suppress all checks in the generated directories -->
  <suppress checks=".*" files=".+[\\\/]generated[\\\/].+\.java" />
  <suppress checks=".*" files=".+[\\\/]generated-src[\\\/].+\.java" />
  <suppress checks=".*" files=".+[\\\/]generated-sources[\\\/].+\.java" />
  <suppress checks=".*" files=".+[\\\/]generated-test-sources[\\\/].+\.java" />

  <!-- Suppression on JavadocMethod violations.

       The goal is to remove all the following suppressions, once they are addressed.

       Tracking JIRA:BEAM-6446
  -->

  <!-- sdk -->
  <suppress checks="JavadocMethod" files=".*sdk.*Experimental\.java" lines="48,112"/>
  <suppress checks="JavadocMethod" files=".*sdk.*DefaultCoder\.java" lines="54"/>
  <suppress checks="JavadocMethod" files=".*sdk.*OffsetRangeTracker\.java" lines="83"/>
  <suppress checks="JavadocMethod" files=".*sdk.*Default\.java" lines="40"/>
  <suppress checks="JavadocMethod" files=".*sdk.*Description\.java" lines="34"/>
  <suppress checks="JavadocMethod" files=".*sdk.*TransformHierarchy\.java" lines="144"/>
  <suppress checks="JavadocMethod" files=".*sdk.*Cast\.java" lines="332,391"/>
  <suppress checks="JavadocMethod" files=".*sdk.*DoFn\.java" lines="444"/>
  <suppress checks="JavadocMethod" files=".*sdk.*CoGbkResult\.java" lines="72"/>
  <suppress checks="JavadocMethod" files=".*sdk.*extensions.*Audience\.java" lines="32"/>
  <suppress checks="JavadocMethod" files=".*sdk.*sql.*BeamSetOperatorsTransforms\.java" lines="59"/>
  <suppress checks="JavadocMethod" files=".*sdk.*nexmark.*GeneratorConfig\.java" lines="89"/>
  <suppress checks="JavadocMethod" files=".*sdk.*gcp.*BigQueryUtils\.java" lines="212"/>
  <suppress checks="JavadocMethod" files=".*sdk.*transforms.*DoFn\.java" lines="443"/>

  <!--  runner/core  -->
  <suppress checks="JavadocMethod" files=".*runners.*core.*PipelineTranslation\.java" lines="54"/>
  <suppress checks="JavadocMethod" files=".*runners.*core.*TriggerTranslation\.java" lines="238"/>
  <suppress checks="JavadocMethod" files=".*runners.*core.*WindowingStrategyTranslation\.java" lines="357"/>
  <suppress checks="JavadocMethod" files=".*runners.*core.*ReduceFnRunner\.java" lines="206,677"/>
  <suppress checks="JavadocMethod" files=".*runners.*core.*MetricsTranslation\.java" lines="39,76"/>
  <suppress checks="JavadocMethod" files=".*runners.*core.*TriggerStateMachines\.java" lines="32"/>
  <suppress checks="JavadocMethod" files=".*runners.*core.*SplittableParDoViaKeyedWorkItems\.java" lines="329"/>

  <!-- Fn harness -->
  <suppress checks="JavadocMethod" files=".*harness.*FnHarness\.java" lines="126"/>
  <suppress checks="JavadocMethod" files=".*harness.*BeamFnLoggingClient\.java" lines="104"/>
  <suppress checks="JavadocMethod" files=".*harness.*FnApiStateAccessor\.java" lines="76"/>

  <!-- Misc -->
  <suppress checks="JavadocMethod" files=".*io.*JmsIO\.java" lines="117"/>
  <suppress checks="JavadocMethod" files=".*runners.*nexmark.*GeneratorConfig\.java" lines="89"/>
  <suppress checks="JavadocMethod" files=".*runners.*spark.*SparkUnboundedSource\.java" lines="82"/>
  <suppress checks="JavadocMethod" files=".*runners.*dataflow.*CustomSources\.java" lines="62"/>
  <!-- End of Suppression on JavadocMethod violations. -->

  <!-- Guava use exceptions -->
  <!-- Non-vendored guava imports are allowed for files that depend on libraries that expose guava in its public API -->
  <suppress id="ForbidNonVendoredGuava" files=".*kinesis.*KinesisIO\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*kinesis.*KinesisProducerMock\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*bigtable.*VendoredListenableFutureAdapter\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*bigtable.*VendoredListenableFutureAdapter\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*bigtable.*BigtableServiceImplTest\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*sql.*BeamValuesRel\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*sql.*BeamEnumerableConverterTest\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*zetasql.*TableScanConverter\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*zetasql.*ExpressionConverter\.java" />
  <suppress id="ForbidNonVendoredGuava" files=".*zetasql.*ZetaSQLPlannerImpl\.java" />

  <!-- Flink -->
  <!-- Checkstyle does not correctly detect package files across multiple source directories. -->
  <suppress checks="JavadocPackage" files=".*runners.flink.*CoderTypeSerializer\.java"/>
  <suppress checks="JavadocPackage" files=".*runners.flink.*EncodedTypeSerializer\.java"/>

</suppressions>