diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/javax/lang/model/element/NestingKind.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/classes/javax/lang/model/element/NestingKind.java Sat Dec 01 00:00:00 2007 +0000 @@ -0,0 +1,99 @@ +/* + * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, + * CA 95054 USA or visit www.sun.com if you need additional information or + * have any questions. + */ + +package javax.lang.model.element; + +/** + * The nesting kind of a type element. + * Type elements come in four varieties: + * top-level, member, local, and anonymous. + * Nesting kind is a non-standard term used here to denote this + * classification. + * + *

Note that it is possible additional nesting kinds will be added + * in future versions of the platform. + * + *

Example: The classes below are annotated with their nesting kind. + *

+ *
+ * import java.lang.annotation.*;
+ * import static java.lang.annotation.RetentionPolicy.*;
+ * import javax.lang.model.element.*;
+ * import static javax.lang.model.element.NestingKind.*;
+ *
+ * @Nesting(TOP_LEVEL)
+ * public class NestingExamples {
+ *     @Nesting(MEMBER)
+ *     static class MemberClass1{}
+ *
+ *     @Nesting(MEMBER)
+ *     class MemberClass2{}
+ *
+ *     public static void main(String... argv) {
+ *         @Nesting(LOCAL)
+ *         class LocalClass{};
+ *
+ *         Class<?>[] classes = {
+ *             NestingExamples.class,
+ *             MemberClass1.class,
+ *             MemberClass2.class,
+ *             LocalClass.class
+ *         };
+ *
+ *         for(Class<?> clazz : classes) {
+ *             System.out.format("%s is %s%n",
+ *                               clazz.getName(),
+ *                               clazz.getAnnotation(Nesting.class).value());
+ *         }
+ *     }
+ * }
+ *
+ * @Retention(RUNTIME)
+ * @interface Nesting {
+ *     NestingKind value();
+ * }
+ * 
+ * + * @author Joseph D. Darcy + * @author Scott Seligman + * @author Peter von der Ahé + * @since 1.6 + */ +public enum NestingKind { + TOP_LEVEL, + MEMBER, + LOCAL, + ANONYMOUS; + + /** + * Does this constant correspond to a nested type element? + * A nested type element is any that is not top-level. + * An inner type element is any nested type element that + * is not {@linkplain Modifier#STATIC static}. + */ + public boolean isNested() { + return this != TOP_LEVEL; + } +}