org.quickperf.annotation.DisableQuickPerf Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quick-perf-core Show documentation

The newest version!

/*
 * 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.
 *
 * Copyright 2019-2021 the original author or authors.
 */

package org.quickperf.annotation;

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

/**
 * The DisableQuickPerf annotation disables all QuickPerf annotations on every scope (test, method, global).
 *
 * 


 * Example:
 *  *      @DisableQuickPerf
 *      @DisableSameSelectTypesWithDifferentParamValues
 *      public void execute() {
 *          ...
 *      }
 * 
 *
 * @see FunctionalIteration
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
public @interface DisableQuickPerf {

    /**
     * To comment on the reason why QuickPerf annotations are disabled.
     * @return the reason why QuickPerf annotations are disabled
     */
    String comment() default "";

}