checkstyle-suppressions.xml

<?xml version="1.0"?>
<!--

    Copyright (c) 2016, 2023 Oracle and/or its affiliates.

    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.

-->

<!DOCTYPE suppressions PUBLIC
        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
        "http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">

<suppressions>
    <!-- to do comment suppression for to do project -->
    <suppress checks="TodoComment"
            files="examples/todo-app/.*"/>

    <suppress checks="FileLength"
            files="config/config/src/main/java/io/helidon/config/Config.java|integrations/cdi/jpa-cdi/src/main/java/io/helidon/integrations/cdi/jpa/JpaExtension\.java|security/providers/oidc-common/src/main/java/io/helidon/security/providers/oidc/common/OidcConfig\.java"
            lines="1"/>

    <!-- Java comments with AsciiDoc tag:: and end:: in import section incorrectly flagged
         as unacceptable blank lines within a package's imports. -->
    <suppress checks="ImportOrder"
            files="examples/guides/se-restful-webservice/src/main/java/io/helidon/guides/se/restfulwebservice/Main.java"/>
    <suppress checks="ImportOrder"
            files="examples/guides/se-restful-webservice/src/main/java/io/helidon/guides/se/restfulwebservice/GreetService.java"/>
    <suppress checks="NoWhitespaceBefore|SeparatorWrap"
            files="examples/guides/mp-restful-webservice/src/main/java/io/helidon/guides/mp/restfulwebservice/GreetApplication.java"/>
    <!--
     The following files are work taken over from other projects,
        where we want to keep the author tag untouched
    -->
    <!-- Common HTTP project -->
    <suppress id="Javadoc.javadocNoAuthor"
            files="common/http/Preconditions\.java|common/http/Ascii\.java|common/http/CharMatcher\.java"/>
    <!-- Webserver project -->
    <suppress id="Javadoc.javadocNoAuthor"
            files="webserver/UriComponent\.java"/>

    <!-- Building a Graph involves a lot of instanceof checks and state manipulation.  -->
    <suppress checks="MethodLength"
              files="HelidonReactiveStreamsEngine\.java"/>

    <!-- PKCS#1 private keys - required for OCI Instance Principal Authentication -->
    <suppress checks="IllegalImport"
            files="DerUtils\.java"/>

    <!-- Metrics Prometheus output generation depends on numerous settings -->
    <suppress checks="ParameterNumber"
            files="MetricImpl\.java"/>

    <!-- Java comments, import order and style of the files should be generated by OpenApi Tools. -->
    <suppress checks="ConstantName"
              files="examples/openapi-tools/"/>
    <suppress checks="ImportOrder"
              files="examples/openapi-tools/"/>
    <suppress checks="JavadocMethod"
              files="examples/openapi-tools/"/>
    <suppress checks="JavadocStyle"
              files="examples/openapi-tools/"/>
    <suppress checks="JavadocVariable"
              files="examples/openapi-tools/"/>
    <suppress checks="RegexpSinglelineJava"
              files="examples/openapi-tools/"/>
    <suppress checks="MissingJavadocMethod"
              files="examples/openapi-tools/"/>
    <suppress checks="MissingJavadocType"
              files="examples/openapi-tools/"/>
    <suppress checks="NewlineAtEndOfFile"
              files="examples/openapi-tools/"/>
    <suppress checks="HideUtilityClassConstructor"
              files="examples/openapi-tools/"/>

</suppressions>