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