001/*
002 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package jdk.internal.jvmci.options;
024
025import java.lang.annotation.*;
026
027/**
028 * Describes the attributes of an option whose {@link OptionValue value} is in a static field
029 * annotated by this annotation type.
030 *
031 * @see OptionDescriptor
032 */
033@Retention(RetentionPolicy.CLASS)
034@Target(ElementType.FIELD)
035public @interface Option {
036
037    /**
038     * Gets a help message for the option. New lines can be embedded in the message with
039     * {@code "%n"}.
040     */
041    String help();
042
043    /**
044     * The name of the option. By default, the name of the annotated field should be used.
045     */
046    String name() default "";
047
048    /**
049     * Specifies the type of the option.
050     */
051    OptionType type() default OptionType.Debug;
052}