Generated.java revision 4082:3b47c6cb966e
1/* 2 * Copyright (c) 2005, 2017, 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. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25package javax.annotation.processing; 26 27import java.lang.annotation.*; 28import static java.lang.annotation.ElementType.*; 29import static java.lang.annotation.RetentionPolicy.*; 30 31/** 32 * The Generated annotation is used to mark source code that has been generated. 33 * It can also be used to differentiate user written code from generated code in 34 * a single file. 35 * 36 * <h3>Examples:</h3> 37 * <pre> 38 * @Generated("com.example.Generator") 39 * </pre> 40 * <pre> 41 * @Generated(value="com.example.Generator", date= "2017-07-04T12:08:56.235-0700") 42 * </pre> 43 * <pre> 44 * @Generated(value="com.example.Generator", date= "2017-07-04T12:08:56.235-0700", 45 * comments= "comment 1") 46 * </pre> 47 * 48 * @since 9 49 */ 50@Documented 51@Retention(SOURCE) 52@Target({PACKAGE, TYPE, METHOD, CONSTRUCTOR, FIELD, 53 LOCAL_VARIABLE, PARAMETER}) 54public @interface Generated { 55 56 /** 57 * The value element MUST have the name of the code generator. The 58 * name is the fully qualified name of the code generator. 59 * 60 * @return The name of the code generator 61 */ 62 String[] value(); 63 64 /** 65 * Date when the source was generated. The date element must follow the ISO 66 * 8601 standard. For example the date element would have the following 67 * value 2017-07-04T12:08:56.235-0700 which represents 2017-07-04 12:08:56 68 * local time in the U.S. Pacific Time time zone. 69 * 70 * @return The date the source was generated 71 */ 72 String date() default ""; 73 74 /** 75 * A place holder for any comments that the code generator may want to 76 * include in the generated code. 77 * 78 * @return Comments that the code generated included 79 */ 80 String comments() default ""; 81} 82