extras/japi/java/jvpp-registry/io/fd/vpp/jvpp/coverity/SuppressFBWarnings.java

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.vpp.jvpp.coverity;
  18
  19 import java.lang.annotation.Retention;
  20 import java.lang.annotation.RetentionPolicy;
  21
  22 /**
  23  * Used to suppress FindBugs warnings found by Coverity. <br>
  24  * We don't want extra dependency, so we define our own annotation version.
  25  *
  26  * @see <a href="https://sourceforge.net/p/findbugs/feature-requests/298/#5e88"/>Findbugs sourceforge</a>
  27  */
  28 @Retention(RetentionPolicy.CLASS)
  29 public @interface SuppressFBWarnings {
  30     /**
  31      * The set of FindBugs warnings that are to be suppressed in annotated element. The value can be a bug category,
  32      * kind or pattern.
  33      */
  34     String[] value() default {};
  35
  36     /**
  37      * Optional documentation of the reason why the warning is suppressed
  38      */
  39     String justification() default "";
  40 }