1 /*
2 * Copyright (c) 2005, 2010, 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
31 * include classes, interfaces, methods, constructors, and fields.
32 * The interfaces in this package do not model the structure of a
33 * program inside a method body; for example there is no
34 * representation of a {@code for} loop or {@code try}-{@code finally}
35 * block. However, the interfaces can model some structures only
36 * appearing inside method bodies, such as local variables and
37 * anonymous classes.
38 *
39 * <p>When used in the context of annotation processing, an accurate
40 * model of the element being represented must be returned. As this
41 * is a language model, the source code provides the fiducial
42 * (reference) representation of the construct in question rather than
43 * a representation in an executable output like a class file.
44 * Executable output may serve as the basis for creating a modeling
45 * element. However, the process of translating source code to
46 * executable output may not permit recovering some aspects of the
47 * source code representation. For example, annotations with
48 * {@linkplain java.lang.annotation.RetentionPolicy#SOURCE source}
49 * {@linkplain java.lang.annotation.Retention retention} cannot be
50 * recovered from class files and class files might not be able to
51 * provide source position information. The {@linkplain
52 * javax.lang.model.element.Modifier modifiers} on an element may
53 * differ in some cases including
54 *
55 * <ul>
56 * <li> {@code strictfp} on a class or interface
57 * <li> {@code final} on a parameter
58 * <li> {@code protected}, {@code private}, and {@code static} on classes and interfaces
59 * </ul>
60 *
61 * Additionally, synthetic constructs in a class file, such as
62 * accessor methods used in implementing nested classes and bridge
63 * methods used in implementing covariant returns, are translation
64 * artifacts outside of this model.
65 *
66 * <p>During annotation processing, operating on incomplete or
67 * erroneous programs is necessary; however, there are fewer
68 * guarantees about the nature of the resulting model. If the source
69 * code is not syntactically well-formed or has some other
70 * irrecoverable error that could not be removed by the generation of
71 * new types, a model may or may not be provided as a quality of
72 * implementation issue.
73 * If a program is syntactically valid but erroneous in some other
|
1 /*
2 * Copyright (c) 2005, 2012, 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
31 * include classes, interfaces, methods, constructors, and fields.
32 * The interfaces in this package do not model the structure of a
33 * program inside a method body; for example there is no
34 * representation of a {@code for} loop or {@code try}-{@code finally}
35 * block. However, the interfaces can model some structures only
36 * appearing inside method bodies, such as local variables and
37 * anonymous classes.
38 *
39 * <p>When used in the context of annotation processing, an accurate
40 * model of the element being represented must be returned. As this
41 * is a language model, the source code provides the fiducial
42 * (reference) representation of the construct in question rather than
43 * a representation in an executable output like a class file.
44 * Executable output may serve as the basis for creating a modeling
45 * element. However, the process of translating source code to
46 * executable output may not permit recovering some aspects of the
47 * source code representation. For example, annotations with
48 * {@linkplain java.lang.annotation.RetentionPolicy#SOURCE source}
49 * {@linkplain java.lang.annotation.Retention retention} cannot be
50 * recovered from class files and class files might not be able to
51 * provide source position information.
52 *
53 * Names of parameters may not be recoverable from class files.
54 *
55 * The {@linkplain javax.lang.model.element.Modifier modifiers} on an
56 * element may differ in some cases including:
57 *
58 * <ul>
59 * <li> {@code strictfp} on a class or interface
60 * <li> {@code final} on a parameter
61 * <li> {@code protected}, {@code private}, and {@code static} on classes and interfaces
62 * </ul>
63 *
64 * Additionally, synthetic constructs in a class file, such as
65 * accessor methods used in implementing nested classes and bridge
66 * methods used in implementing covariant returns, are translation
67 * artifacts outside of this model.
68 *
69 * <p>During annotation processing, operating on incomplete or
70 * erroneous programs is necessary; however, there are fewer
71 * guarantees about the nature of the resulting model. If the source
72 * code is not syntactically well-formed or has some other
73 * irrecoverable error that could not be removed by the generation of
74 * new types, a model may or may not be provided as a quality of
75 * implementation issue.
76 * If a program is syntactically valid but erroneous in some other
|