JavaTM 2 Platform Std. Ed. v1.6.0
javax.lang.model.element
Enum NestingKind
java.lang.Object
java.lang.Enum<NestingKind>
javax.lang.model.element.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
Method Summary |
boolean |
isNested()
Does this constant correspond to a nested type element?
A nested type element is any that is not top-level. |
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. |
TOP_LEVEL
public static final NestingKind TOP_LEVEL
MEMBER
public static final NestingKind MEMBER
LOCAL
public static final NestingKind LOCAL
ANONYMOUS
public static final NestingKind ANONYMOUS
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.
An inner type element is any nested type element that
is not static.
Copyright 2003 Sun Microsystems, Inc. All rights reserved
|