1/*
2 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23package org.graalvm.compiler.api.replacements;
24
25import java.lang.annotation.ElementType;
26import java.lang.annotation.Retention;
27import java.lang.annotation.RetentionPolicy;
28import java.lang.annotation.Target;
29
30/**
31 * A snippet is a Graal graph expressed as a Java source method. Snippets are used for lowering
32 * nodes that have runtime dependent semantics (e.g. the {@code CHECKCAST} bytecode).
33 */
34@Retention(RetentionPolicy.RUNTIME)
35@Target(ElementType.METHOD)
36public @interface Snippet {
37
38    /**
39     * Denotes a snippet parameter representing 0 or more arguments that will be bound during
40     * snippet template instantiation. During snippet template creation, its value must be an array
41     * whose length specifies the number of arguments (the contents of the array are ignored) bound
42     * to the parameter during instantiation.
43     */
44    @Retention(RetentionPolicy.RUNTIME)
45    @Target(ElementType.PARAMETER)
46    public @interface VarargsParameter {
47    }
48
49    /**
50     * Denotes a snippet parameter that will bound to a constant value during snippet template
51     * instantiation.
52     */
53    @Retention(RetentionPolicy.RUNTIME)
54    @Target(ElementType.PARAMETER)
55    public @interface ConstantParameter {
56    }
57
58    /**
59     * Denotes a snippet parameter that will bound to a non-null value during snippet template
60     * instantiation.
61     */
62    @Retention(RetentionPolicy.RUNTIME)
63    @Target(ElementType.PARAMETER)
64    public @interface NonNullParameter {
65    }
66}
67