Enum NestingKind

All Implemented Interfaces:
Serializable, Comparable<NestingKind> 
public enum NestingKind
extends Enum<NestingKind>

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();
}
Since:
1.6

Enum Constants

Enum Constant Description
ANONYMOUS

A type without a name.
LOCAL

A named type declared within a construct other than a type.
MEMBER

A type that is a named member of another type.
TOP_LEVEL

A top-level type, not contained within another type.

Methods

Modifier and Type Method Description
boolean isNested()

Does this constant correspond to a nested type element?
static NestingKind valueOf​(String name)

Returns the enum constant of this type with the specified name.
static NestingKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Methods declared in class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods declared in class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constants

TOP_LEVEL

public static final NestingKind TOP_LEVEL

A top-level type, not contained within another type.

MEMBER

public static final NestingKind MEMBER

A type that is a named member of another type.

LOCAL

public static final NestingKind LOCAL

A named type declared within a construct other than a type.

ANONYMOUS

public static final NestingKind ANONYMOUS

A type without a name.

Methods

values

public static NestingKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 

for (NestingKind c : NestingKind.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static NestingKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

isNested

public boolean isNested()

Does this constant correspond to a nested type element? A nested type element is any that is not top-level. More specifically, an inner type element is any nested type element that is not static.

Returns:
whether or not the constant is nested

© 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/en/java/javase/11/docs/api/java.compiler/javax/lang/model/element/NestingKind.html