/*
 * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package compiler.lib.ir_framework;

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

/**
 * This annotation is used to identify Setup methods. These can be used to compute arbitrary arguments for a test
 * method (see {@link Test}), as well as to set field values. A test method can use a setup method, by specifying
 * it in a {@link Arguments} annotation. A setup method can optionally take a {@link SetupInfo} as an argument. The
 * arguments for the test methods are returned as a new object array.
 *
 * Examples on how to use test methods can be found in {@link ir_framework.examples.SetupExample} and also as part of the
 * internal testing in the package {@link ir_framework.tests}.
 *
 * @see Arguments
 * @see Setup
 * @see SetupInfo
 * @see Test
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface Setup {
}