org.kohsuke.accmod.restrictions.suppressions.SuppressRestrictedWarnings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of access-modifier-suppressions Show documentation

This module allows you to enable suppressions for turning off warnings about Restricted APIs. !!!WARNING!!! Classes are marked as @Restricted for a reason and this module should not be used lightly! It implies that the author does not intend for them to be used outside their defined scope and as such they may be changed/modified/removed at any stage without warning. A simple upgrade of the dependency may break your module. Use at your own risk. You should try to not use @Restricted classes in the first place, but if you _must_ use them, this is a less-brutal approach than just disabling the access-modifier-checker entirely

The newest version!

/*
 * The MIT License
 *
 * Copyright (c) 2018, Steve Arch
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.kohsuke.accmod.restrictions.suppressions;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.kohsuke.accmod.Restricted;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Indicates that certain classes annotated with {@link Restricted} annotations should be skipped during the
 * access-modifier-check.
 *
 * Warning! Classes are markes as {@link Restricted} for a reason! Do not use these suppressions lightly.
 * Use at your own risk
 *
 * @author Steve Arch
 */
@Retention(RUNTIME)
@Documented
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE})
public @interface SuppressRestrictedWarnings {
    /**
     * The classes that are marked as {@link Restricted} that should be skipped from the scan.
     */
    Class[] value();
}