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 */ 23 package jdk.vm.ci.options; 24 25 import java.lang.annotation.*; 26 27 /** 28 * Describes the attributes of an option whose {@link OptionValue value} is in a static field 29 * annotated by this annotation type. 30 * 31 * @see OptionDescriptor 32 */ 33 @Retention(RetentionPolicy.CLASS) 34 @Target(ElementType.FIELD) 35 public @interface Option { 36 37 /** 38 * Gets a help message for the option. New lines can be embedded in the message with 39 * {@code "%n"}. 40 */ 41 String help(); 42 43 /** 44 * The name of the option. By default, the name of the annotated field should be used. 45 */ 46 String name() default ""; 47 48 /** 49 * Specifies the type of the option. 50 */ 51 OptionType type() default OptionType.Debug; 52 }