ohair@286: /*
ohair@286:  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package javax.annotation;
ohair@286: import java.lang.annotation.*;
ohair@286: import static java.lang.annotation.ElementType.*;
ohair@286: import static java.lang.annotation.RetentionPolicy.*;
ohair@286: 
ohair@286: /**
ohair@286:  * The Generated annotation is used to mark source code that has been generated.
ohair@286:  * It can also be used to differentiate user written code from generated code
ohair@286:  * in a single file. When used, the value element must have the name of the
ohair@286:  * code generator. The recommended convention is to use the fully qualified
ohair@286:  * name of the code generator in the value field .
ohair@286:  * For example: com.company.package.classname.
ohair@286:  * The date element is used to indicate the date the source was generated.
ohair@286:  * The date element must follow the ISO 8601 standard. For example the date
ohair@286:  * element would have the following value 2001-07-04T12:08:56.235-0700
ohair@286:  * which represents 2001-07-04 12:08:56 local time in the U.S. Pacific
ohair@286:  * Time time zone.
ohair@286:  * The comment element is a place holder for any comments that the code
ohair@286:  * generator may want to include in the generated code.
ohair@286:  *
ohair@286:  * @since Common Annotations 1.0
ohair@286:  */
ohair@286: 
ohair@286: @Documented
ohair@286: @Retention(SOURCE)
ohair@286: @Target({PACKAGE, TYPE, ANNOTATION_TYPE, METHOD, CONSTRUCTOR, FIELD,
ohair@286:         LOCAL_VARIABLE, PARAMETER})
ohair@286: public @interface Generated {
ohair@286:    /**
ohair@286:     * The value element MUST have the name of the code generator.
ohair@286:     * The recommended convention is to use the fully qualified name of the
ohair@286:     * code generator. For example: com.acme.generator.CodeGen.
ohair@286:     */
ohair@286:    String[] value();
ohair@286: 
ohair@286:    /**
ohair@286:     * Date when the source was generated.
ohair@286:     */
ohair@286:    String date() default "";
ohair@286: 
ohair@286:    /**
ohair@286:     * A place holder for any comments that the code generator may want to
ohair@286:     * include in the generated code.
ohair@286:     */
ohair@286:    String comments() default "";
ohair@286: }