com.diffblue.cover.annotations.InTestsMockStatic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cover-annotations Show documentation

Annotations for end users to enable fine-grained control of Diffblue Cover.

There is a newer version: 1.3.0

/*
 * Copyright 2024 Diffblue Limited.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  https://www.apache.org/licenses/LICENSE-2.0
 *
 * or in the "license" file accompanying this file. This file 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.
 */
package com.diffblue.cover.annotations;

import static com.diffblue.cover.annotations.MockDecision.RECOMMENDED;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.CLASS;

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Indicates whether tests of the annotated item should mock static methods of the classes
 * identified by {@link #value()}. Without annotation then mocking is assumed to be {@link
 * MockDecision#ALLOWED}, but with annotation then the decision defaults to {@link
 * MockDecision#RECOMMENDED}. The decision can be overridden with an explicit {@link #decision()}
 * value.
 *
 * @since Diffblue Cover 2024.04.02
 */
@Retention(CLASS)
@Repeatable(InTestsMockStatic.Repeatable.class)
public @interface InTestsMockStatic {

  /** Collects multiple {@link InTestsMockStatic} annotations. */
  @Retention(CLASS)
  @Target({PACKAGE, TYPE, METHOD})
  @interface Repeatable {

    /**
     * @return the repeated {@link InTestsMockStatic} annotations.
     */
    InTestsMockStatic[] value();
  }

  /**
   * @return the classes to mock (or not).
   */
  Class[] value();

  /**
   * @return the mocking decision to apply.
   */
  MockDecision decision() default RECOMMENDED;
}