Annotation Type Generated
@Documented @Retention(value=SOURCE) @Target(value={PACKAGE,TYPE,ANNOTATION_TYPE,METHOD,CONSTRUCTOR,FIELD,LOCAL_VARIABLE,PARAMETER}) public @interface Generated
The Generated annotation is used to mark source code that has been generated. It can also be used to differentiate user written code from generated code in a single file. When used, the value element must have the name of the code generator. The recommended convention is to use the fully qualified name of the code generator in the value field .
For example: com.company.package.classname. The date element is used to indicate the date the source was generated. The date element must follow the ISO 8601 standard. For example the date element would have the following value 2001-07-04T12:08:56.235-0700 which represents 2001-07-04 12:08:56 local time in the U.S. Pacific Time time zone.
The comment element is a place holder for any comments that the code generator may want to include in the generated code.
- Since:
- Common Annotations 1.0
Required Elements
Modifier and Type | Required Element and Description |
---|---|
String[] |
value The value element MUST have the name of the code generator. |
Optional Elements
Modifier and Type | Optional Element and Description |
---|---|
String |
comments A place holder for any comments that the code generator may want to include in the generated code. |
String |
date Date when the source was generated. |
Elements
value
public abstract String[] value
The value element MUST have the name of the code generator. The recommended convention is to use the fully qualified name of the code generator. For example: com.acme.generator.CodeGen.
date
public abstract String date
Date when the source was generated.
- Default:
- ""
comments
public abstract String comments
A place holder for any comments that the code generator may want to include in the generated code.
- Default:
- ""
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html