Package edu.umd.cs.findbugs.ba

Interface XClass

All Superinterfaces:

AccessibleEntity, AnnotatedObject, java.lang.Comparable<ClassDescriptor>

All Known Implementing Classes:

ClassInfo

public interface XClass
extends java.lang.Comparable<ClassDescriptor>, AccessibleEntity, AnnotatedObject

Interface for object representing information about a class.

Author:

David Hovemeyer

Method Summary

Modifier and Type	Method	Description
XField	findField(java.lang.String name, java.lang.String signature, boolean isStatic)	Find an XField matching given parameters.
XMethod	findMatchingMethod(MethodDescriptor descriptor)	Find XMethod matching the name and signature of the supplied method MethodDescriptor.
XMethod	findMethod(MethodDescriptor descriptor)	Find XMethod matching given MethodDescriptor.
XMethod	findMethod(java.lang.String methodName, java.lang.String methodSig, boolean isStatic)	Find an XMethod matching given parameters.
AnnotationValue	getAnnotation(ClassDescriptor desc)
java.util.Collection<ClassDescriptor>	getAnnotationDescriptors()
java.util.Set<ClassDescriptor>	getCalledClassDescriptors()
ClassDescriptor	getImmediateEnclosingClass()	Get the ClassDescriptor of the immediate enclosing class, or null if this XClass is not a nested or inner class.
ClassDescriptor[]	getInterfaceDescriptorList()	Get ClassDescriptors of interfaces directly implemented by this class.
java.lang.String	getSource()
java.lang.String	getSourceSignature()
ClassDescriptor	getSuperclassDescriptor()	Get ClassDescriptor of this class's immediate superclass.
java.util.List<? extends XField>	getXFields()
java.util.List<? extends XMethod>	getXMethods()
boolean	hasStubs()
boolean	isAbstract()
boolean	isInterface()
boolean	usesConcurrency()

Methods inherited from interface edu.umd.cs.findbugs.ba.AccessibleEntity

getAccessFlags, getClassDescriptor, isDeprecated, isFinal, isPrivate, isProtected, isPublic, isStatic, isSynthetic

Methods inherited from interface edu.umd.cs.findbugs.classfile.analysis.AnnotatedObject

getAnnotations, getClassDescriptor, getContainingScope, getElementType, isSynthetic

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getSuperclassDescriptor

@CheckForNull
ClassDescriptor getSuperclassDescriptor()

Get ClassDescriptor of this class's immediate superclass.

Returns:

ClassDescriptor of this class's immediate superclass, or null if this class has no immediate superclass

getInterfaceDescriptorList

ClassDescriptor[] getInterfaceDescriptorList()

Get ClassDescriptors of interfaces directly implemented by this class.

Returns:

ClassDescriptors of interfaces directly implemented by this class

getImmediateEnclosingClass

ClassDescriptor getImmediateEnclosingClass()

Get the ClassDescriptor of the immediate enclosing class, or null if this XClass is not a nested or inner class.

Returns:

the ClassDescriptor of the immediate enclosing class, or null if this XClass is not a nested or inner class

isInterface

boolean isInterface()

Returns:

true if the class is an interface, false otherwise

isAbstract

boolean isAbstract()

Returns:

true if the class is an abstract

getSource

@CheckForNull
java.lang.String getSource()

Returns:

the Source attribute

getAnnotationDescriptors

java.util.Collection<ClassDescriptor> getAnnotationDescriptors()

Specified by:

getAnnotationDescriptors in interface AnnotatedObject

getAnnotation

AnnotationValue getAnnotation(ClassDescriptor desc)

Specified by:

getAnnotation in interface AnnotatedObject

findMethod

XMethod findMethod(java.lang.String methodName,
                   java.lang.String methodSig,
                   boolean isStatic)

Find an XMethod matching given parameters.

Parameters:

methodName - name of the method

methodSig - signature of the method

isStatic - true if the method is static, false if not

Returns:

matching XMethod, or null if there is no matching XMethod

findMethod

XMethod findMethod(MethodDescriptor descriptor)

Find XMethod matching given MethodDescriptor.

Parameters:

descriptor - a MethodDescriptor

Returns:

matching XMethod, or null if there is no matching method

findMatchingMethod

XMethod findMatchingMethod(MethodDescriptor descriptor)

Find XMethod matching the name and signature of the supplied method MethodDescriptor. The class descriptor of the argument is ignored.

Parameters:

descriptor - a MethodDescriptor

Returns:

matching XMethod, or null if there is no matching method

findField

XField findField(java.lang.String name,
                 java.lang.String signature,
                 boolean isStatic)

Find an XField matching given parameters.

Parameters:

name - name of the field

signature - signature of the field

isStatic - true if field is static, false if not

Returns:

XField, or null if there is no matching XField

getXFields

java.util.List<? extends XField> getXFields()

getXMethods

java.util.List<? extends XMethod> getXMethods()

getSourceSignature

java.lang.String getSourceSignature()

usesConcurrency

boolean usesConcurrency()

hasStubs

boolean hasStubs()

getCalledClassDescriptors

java.util.Set<ClassDescriptor> getCalledClassDescriptors()

Returns:

Returns the called class descriptors.