org.kite9.framework.model
Interface ProjectModel

All Known Implementing Classes:

ProjectModelImpl

public interface ProjectModel

Returns information about the java project which can only be ascertained by bytecode scanning the project structure.

Author:

moffatr

Method Summary

Set<AnnotationHandle>	getAnnotationReferences(String className) Returns the annotations that refer to this class
Set<MemberHandle>	getCalledBy(MemberHandle m) Returns a set of methods a given method is called by, within the project scope
List<MemberHandle>	getCalls(MemberHandle m) Returns a list of all the methods that a given method calls, within the model scope
Set<String>	getClassesInPackage(String packageName) Returns the classNames within the package.
Set<String>	getClassesWithAnnotation(String annotationName) Returns all the classes within the project having a given annotation
Set<String>	getDependedOnClasses(String className) Gets the classes in the model that depend on this class
Set<PackageHandle>	getDependedOnPackages(PackageHandle packageName) Gets the classes in the model that depend on this class
Set<String>	getDependsOnClasses(String className) Gets the immediate (i.e.
Set<PackageHandle>	getDependsOnPackages(PackageHandle packageName) Gets the immediate (i.e.
Set<MemberHandle>	getMembersWithAnnotation(String annotationName) Returns fields and methods defined within the project with a given annotation
Set<String>	getSubclasses(String className) Returns the subclasses defined within the project scope, of a given class.
boolean	withinModel(String className) Returns true if the class is within the scanned part of the project

Method Detail

getCalls

List<MemberHandle> getCalls(MemberHandle m)

Returns a list of all the methods that a given method calls, within the model scope

getCalledBy

Set<MemberHandle> getCalledBy(MemberHandle m)

Returns a set of methods a given method is called by, within the project scope

getSubclasses

Set<String> getSubclasses(String className)

Returns the subclasses defined within the project scope, of a given class.

getClassesWithAnnotation

Set<String> getClassesWithAnnotation(String annotationName)

Returns all the classes within the project having a given annotation

getMembersWithAnnotation

Set<MemberHandle> getMembersWithAnnotation(String annotationName)

Returns fields and methods defined within the project with a given annotation

getDependsOnClasses

Set<String> getDependsOnClasses(String className)

Gets the immediate (i.e. non-transitive) dependencies of a given class, defined within the project scope.

getDependedOnClasses

Set<String> getDependedOnClasses(String className)

Gets the classes in the model that depend on this class

getDependsOnPackages

Set<PackageHandle> getDependsOnPackages(PackageHandle packageName)

Gets the immediate (i.e. non-transitive) dependencies of a given package, defined within the project scope.

getDependedOnPackages

Set<PackageHandle> getDependedOnPackages(PackageHandle packageName)

Gets the classes in the model that depend on this class

withinModel

boolean withinModel(String className)

Returns true if the class is within the scanned part of the project

getClassesInPackage

Set<String> getClassesInPackage(String packageName)

Returns the classNames within the package.

getAnnotationReferences

Set<AnnotationHandle> getAnnotationReferences(String className)

Returns the annotations that refer to this class