com.fasterxml.classmate

Enum AnnotationInclusion

java.lang.Object

java.lang.Enum<AnnotationInclusion>

com.fasterxml.classmate.AnnotationInclusion

All Implemented Interfaces:

Serializable, Comparable<AnnotationInclusion>

public enum AnnotationInclusion
extends Enum<AnnotationInclusion>

Enumeration that defines different settings for handling behavior of individual annotations

Enum Constant Summary

Enum Constants

Enum Constant and Description
DONT_INCLUDE Value that indicates that annotation is to be ignored, not included in resolved bean information.
INCLUDE_AND_INHERIT Value that indicates that annotation is to be included in results; and values from overridden members are also inherited if not overridden by members of subtypes.
INCLUDE_AND_INHERIT_IF_INHERITED Value that indicates that annotation is to be included in results, and values from overridden members are inherited only if the annotation is marked with the Inherited annotation.
INCLUDE_BUT_DONT_INHERIT Value that indicates that annotation is to be included in results, but only if directly associated with included member (or attached mix-in); will not inherit from supertypes.

Method Summary

Methods

Modifier and Type	Method and Description
static AnnotationInclusion	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnnotationInclusion[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DONT_INCLUDE

public static final AnnotationInclusion DONT_INCLUDE

Value that indicates that annotation is to be ignored, not included in resolved bean information. Applicable to all member types.

INCLUDE_BUT_DONT_INHERIT

public static final AnnotationInclusion INCLUDE_BUT_DONT_INHERIT

Value that indicates that annotation is to be included in results, but only if directly associated with included member (or attached mix-in); will not inherit from supertypes. Applicable only to member methods; if used with other members will mean basic inclusion.

INCLUDE_AND_INHERIT_IF_INHERITED

public static final AnnotationInclusion INCLUDE_AND_INHERIT_IF_INHERITED

Value that indicates that annotation is to be included in results, and values from overridden members are inherited only if the annotation is marked with the Inherited annotation. Applicable only to member methods; if used with other members will mean basic inclusion.

INCLUDE_AND_INHERIT

public static final AnnotationInclusion INCLUDE_AND_INHERIT

Value that indicates that annotation is to be included in results; and values from overridden members are also inherited if not overridden by members of subtypes. Note that inheritance only matters with member methods; for other types it just means "include".

Method Detail

values

public static AnnotationInclusion[] 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 (AnnotationInclusion c : AnnotationInclusion.values())
    System.out.println(c);

Returns:

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

valueOf

public static AnnotationInclusion 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