1/*
2 * Copyright (c) 2013, 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.options;
24
25import java.lang.annotation.ElementType;
26import java.lang.annotation.Retention;
27import java.lang.annotation.RetentionPolicy;
28import java.lang.annotation.Target;
29
30/**
31 * Describes the attributes of an option whose {@link OptionKey value} is in a static field
32 * annotated by this annotation type.
33 *
34 * @see OptionDescriptor
35 */
36@Retention(RetentionPolicy.CLASS)
37@Target(ElementType.FIELD)
38public @interface Option {
39
40    /**
41     * Gets a help message for the option.
42     * <p>
43     * The first element of the array is the short help message. This part of the help message is
44     * subject to line wrapping when printed.
45     * <p>
46     * The remaining elements contain a more detailed expansion of the help message and will be
47     * printed as is in a left-aligned block (i.e. leading spaces will be preserved).
48     * <p>
49     * If there is only one element and it starts with {@code "file:"<path>}, then the help message
50     * is located in a file located by resolving {@code <path>} against the location of the package
51     * in which the option is declared. The first line in the file is the short help message as
52     * described above. The remaining lines are the help message expansion.
53     */
54    String[] help();
55
56    /**
57     * The name of the option. By default, the name of the annotated field should be used.
58     */
59    String name() default "";
60
61    /**
62     * Specifies the type of the option.
63     */
64    OptionType type() default OptionType.Debug;
65}
66