pcap.spi.annotation.Restricted Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020-2021 Pcap Project
 * SPDX-License-Identifier: MIT OR Apache-2.0
 */
package pcap.spi.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Restricted function.
 *
 * Calling method annotated with @{@link Restricted} will throws {@link IllegalAccessException}
 * unless you set a "pcap.restricted" property with a value other then deny. The possible values for
 * this property are:
 *
 * 

 *   deny: issues a runtime exception on each restricted call. This is the default value.
 *   
permit: allows restricted calls.
 *   
warn: like permit, but also prints a one-line warning on each restricted call.
 * 
 *
 * @since 1.3.1
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Restricted {}