Files
MinecraftForge/src/main/java/net/minecraftforge/gametest/PrefixGameTestTemplate.java
T
sciwhiz12 c1874bb5ab Amend license header to include contributors and apply to FML subprojects (#8525)
After internal discussion, it was decided that we need to include
"contributors" to the license header. This avoids claiming that the
Java source files are under the exclusive copyright ownership of Forge
LLC, which excludes contributors that still hold copyright ownership
over their contributions (but is licensed under the LGPLv2.1 as stated
in the Forge CLA).
2022-04-13 20:42:00 -07:00

39 lines
1.4 KiB
Java

/*
* Copyright (c) Forge Development LLC and contributors
* SPDX-License-Identifier: LGPL-2.1-only
*/
package net.minecraftforge.gametest;
import net.minecraft.gametest.framework.GameTest;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* When used on a class, this sets the default state for whether
* to prefix any contained game test templates with the {@link Class#getSimpleName() simple class name} or not.
* <p>
* When used on a method, this defines whether the specific method should be prefixed with the simple class name or not.
* <p>
* If this annotation cannot be found on a game test method or its containing class, the default behavior is to prefix the class name.
* <p>
* Method annotations override any class annotations.
*
* @see GameTestHolder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface PrefixGameTestTemplate
{
/**
* Whether to prefix the game test template with the containing class' {@link Class#getSimpleName() simple name}.
* For example, true in a class named "MyTest" would result in "mytest.structure" while false would result in "structure".
* <p>
* Only applies to methods annotated with {@link GameTest}.
*/
boolean value() default true;
}