net.bytebuddy.instrumentation.attribute.annotation

Enum AnnotationAppender.AnnotationVisibility

java.lang.Object

java.lang.Enum<AnnotationAppender.AnnotationVisibility>

net.bytebuddy.instrumentation.attribute.annotation.AnnotationAppender.AnnotationVisibility

All Implemented Interfaces:

Serializable, Comparable<AnnotationAppender.AnnotationVisibility>

Enclosing interface:

AnnotationAppender

public static enum AnnotationAppender.AnnotationVisibility
extends Enum<AnnotationAppender.AnnotationVisibility>

Determines if an annotation should be written to a specified target and if the annotation should be marked as being visible at runtime.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASS_FILE The annotation is preserved in the compiled class but not visible at runtime.
INVISIBLE The annotation is ignored.
RUNTIME The annotation is preserved in the compiled class and visible at runtime.

Method Summary

Modifier and Type	Method and Description
boolean	isSuppressed() Checks if this instance represents an annotation that is not to be embedded into Java byte code, i.e.
boolean	isVisible() Checks if this instance represents an annotation that is visible at runtime, i.e.
static AnnotationAppender.AnnotationVisibility	of(Annotation annotation) Finds the annotation visibility that is declared for a given annotation.
static AnnotationAppender.AnnotationVisibility	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnnotationAppender.AnnotationVisibility[]	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

RUNTIME

public static final AnnotationAppender.AnnotationVisibility RUNTIME

The annotation is preserved in the compiled class and visible at runtime.

CLASS_FILE

public static final AnnotationAppender.AnnotationVisibility CLASS_FILE

The annotation is preserved in the compiled class but not visible at runtime.

INVISIBLE

public static final AnnotationAppender.AnnotationVisibility INVISIBLE

The annotation is ignored.

Method Detail

values

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

Returns:

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

valueOf

public static AnnotationAppender.AnnotationVisibility 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

of

public static AnnotationAppender.AnnotationVisibility of(Annotation annotation)

Finds the annotation visibility that is declared for a given annotation.

Parameters:

annotation - The annotation of interest.

Returns:

The annotation visibility of a given annotation. Annotations with a non-defined visibility or an visibility of type RetentionPolicy.SOURCE will be silently ignored.

isVisible

public boolean isVisible()

Checks if this instance represents an annotation that is visible at runtime, i.e. if this instance is RUNTIME.

Returns:

true if this instance represents an annotation to be visible at runtime.

isSuppressed

public boolean isSuppressed()

Checks if this instance represents an annotation that is not to be embedded into Java byte code, i.e. if this instance is INVISIBLE.

Returns:

true if this instance represents an annotation to be suppressed from the byte code output.