org.jboss.weld.environment.deployment.discovery.jandex

Class JandexClassFileInfo

java.lang.Object

org.jboss.weld.environment.deployment.discovery.jandex.JandexClassFileInfo

All Implemented Interfaces:

ClassFileInfo

public class JandexClassFileInfo
extends java.lang.Object
implements ClassFileInfo

A Java class representation backed by Jandex.

Author:

Martin Kouba, Matej Briškár

Constructor Summary

Constructors

Constructor and Description
JandexClassFileInfo(java.lang.String className, IndexView index, ComputingCache<DotName,java.util.Set<java.lang.String>> annotationClassAnnotationsCache, java.lang.ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
boolean	containsAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Indicates whether this class contains an annotation of the specified annotation type.
java.lang.String	getClassName() Returns the name of this class.
int	getModifiers() Returns the class access and property modifiers, as defined in http://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.1-200-E.1
java.lang.String	getSuperclassName() Returns the name of this class's superclass or java.lang.Object if this class does not have a superclass.
boolean	hasCdiConstructor() Indicates whether this class has a CDI constructor.
boolean	isAnnotationDeclared(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Indicates whether an annotation of the specified annotation type is directly present on this class.
boolean	isAssignableFrom(java.lang.Class<?> fromClass) Indicates whether this class is either the same as, or is a superclass of the specified class.
boolean	isAssignableTo(java.lang.Class<?> toClass) Indicates whether this class is either the same as, or is a subclass of the specified class.
boolean	isTopLevelClass() Indicates whether this class is a top-level class or an inner class.
boolean	isVetoed() Indicates whether this class is vetoed from CDI processing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JandexClassFileInfo

public JandexClassFileInfo(java.lang.String className,
                           IndexView index,
                           ComputingCache<DotName,java.util.Set<java.lang.String>> annotationClassAnnotationsCache,
                           java.lang.ClassLoader classLoader)

Method Detail

getClassName

public java.lang.String getClassName()

Description copied from interface: ClassFileInfo

Returns the name of this class.

Specified by:

getClassName in interface ClassFileInfo

Returns:

the FQCN of the class represented by this class file

isAnnotationDeclared

public boolean isAnnotationDeclared(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Description copied from interface: ClassFileInfo

Indicates whether an annotation of the specified annotation type is directly present on this class.

Specified by:

isAnnotationDeclared in interface ClassFileInfo

Parameters:

annotation - the specified annotation type

Returns:

true if an annotation of a specified type is directly present on this class, false otherwise

containsAnnotation

public boolean containsAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

Description copied from interface: ClassFileInfo

Indicates whether this class contains an annotation of the specified annotation type. A class is said to contain the annotation if any of these applies:

• The annotation or an annotation annotated with the annotation is present on the class
• The annotation or an annotation annotated with the annotation, which is annotated with Inherited, is present on a direct or indirect superclass of the given class
• The annotation or an annotation annotated with the annotation is present on a field or method declared by the given class or any direct or indirect superclass of the given class
• The annotation or an annotation annotated with the annotation is present on a parameter of a method declared by the given class or any direct or indirect superclass of the given class
• The annotation or an annotation annotated with the annotation is present on a constructor declared by the given class
• The annotation or an annotation annotated with the annotation is present on a parameter of a constructor declared by the given class

Specified by:

containsAnnotation in interface ClassFileInfo

Parameters:

annotation - the specified annotation type

Returns:

true if the class contains the annotation, false otherwise

getModifiers

public int getModifiers()

Description copied from interface: ClassFileInfo

Returns the class access and property modifiers, as defined in http://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.1-200-E.1

Specified by:

getModifiers in interface ClassFileInfo

Returns:

class access and property modifiers

hasCdiConstructor

public boolean hasCdiConstructor()

Description copied from interface: ClassFileInfo

Indicates whether this class has a CDI constructor.

Specified by:

hasCdiConstructor in interface ClassFileInfo

Returns:

true if this class has a constructor annotated with Inject or a no-arg constructor, false otherwise

isAssignableFrom

public boolean isAssignableFrom(java.lang.Class<?> fromClass)

Description copied from interface: ClassFileInfo

Indicates whether this class is either the same as, or is a superclass of the specified class.

Specified by:

isAssignableFrom in interface ClassFileInfo

Parameters:

fromClass - the specified class

Returns:

true if this class is either the same as, or is a superclass of the specified class, false otherwise

isAssignableTo

public boolean isAssignableTo(java.lang.Class<?> toClass)

Description copied from interface: ClassFileInfo

Indicates whether this class is either the same as, or is a subclass of the specified class.

Specified by:

isAssignableTo in interface ClassFileInfo

Parameters:

toClass - the specified class

Returns:

true if this class is either the same as, or is a subclass of the specified class, false otherwise

isVetoed

public boolean isVetoed()

Description copied from interface: ClassFileInfo

Indicates whether this class is vetoed from CDI processing.

Specified by:

isVetoed in interface ClassFileInfo

Returns:

true if the Vetoed annotation is present on this class or the class's package, false otherwise

isTopLevelClass

public boolean isTopLevelClass()

Description copied from interface: ClassFileInfo

Indicates whether this class is a top-level class or an inner class.

Specified by:

isTopLevelClass in interface ClassFileInfo

Returns:

true if this class is a top-level class, false otherwise

getSuperclassName

public java.lang.String getSuperclassName()

Description copied from interface: ClassFileInfo

Returns the name of this class's superclass or java.lang.Object if this class does not have a superclass.

Specified by:

getSuperclassName in interface ClassFileInfo

Returns:

the FQCN of the superclass of this class or java.lang.Object if this class does not have a superclass

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object