Package io.github.classgraph

Class PackageInfo

java.lang.Object

io.github.classgraph.PackageInfo

All Implemented Interfaces:

Comparable<PackageInfo>

public class PackageInfo
extends Object
implements Comparable<PackageInfo>

Holds metadata about a package encountered during a scan.

Method Summary

Modifier and Type	Method	Description
int	compareTo(PackageInfo o)
boolean	equals(Object o)
AnnotationInfoList	getAnnotationInfo()	Get any annotations on the package-info.class file.
AnnotationInfo	getAnnotationInfo(String annotationName)	Get a the named annotation on this package, or null if the package does not have the named annotation.
List<PackageInfo>	getChildren()	The child packages of this package, or the empty list if none.
ClassInfoList	getClassInfo()	Get the ClassInfo objects for all classes that are members of this package.
ClassInfo	getClassInfo(String className)	Get the ClassInfo object for the named class in this package, or null if the class was not found in this module.
ClassInfoList	getClassInfoRecursive()	Get the ClassInfo objects for all classes that are members of this package or a sub-package.
String	getName()	The package name ("" for the root package).
static PackageInfo	getPackage(String packageName, Map<String,PackageInfo> packageNameToPackageInfo)	Get the PackageInfo object for the named package, also creating PackageInfo objects for any needed parent packages.
PackageInfo	getParent()	The parent package of this package, or null if this is the root package.
boolean	hasAnnotation(String annotationName)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public String getName()

The package name ("" for the root package).

getAnnotationInfo

public AnnotationInfo getAnnotationInfo(String annotationName)

Get a the named annotation on this package, or null if the package does not have the named annotation.

Parameters:

annotationName - The annotation name.

Returns:

An AnnotationInfo object representing the named annotation on this package, or null if the package does not have the named annotation.

getAnnotationInfo

public AnnotationInfoList getAnnotationInfo()

Get any annotations on the package-info.class file.

hasAnnotation

public boolean hasAnnotation(String annotationName)

Parameters:

annotationName - The name of an annotation.

Returns:

true if this package has the named annotation.

getParent

public PackageInfo getParent()

The parent package of this package, or null if this is the root package.

getChildren

public List<PackageInfo> getChildren()

The child packages of this package, or the empty list if none.

getClassInfo

public ClassInfo getClassInfo(String className)

Get the ClassInfo object for the named class in this package, or null if the class was not found in this module.

getClassInfo

public ClassInfoList getClassInfo()

Get the ClassInfo objects for all classes that are members of this package.

getClassInfoRecursive

public ClassInfoList getClassInfoRecursive()

Get the ClassInfo objects for all classes that are members of this package or a sub-package.

getPackage

public static PackageInfo getPackage(String packageName,
                                     Map<String,PackageInfo> packageNameToPackageInfo)

Get the PackageInfo object for the named package, also creating PackageInfo objects for any needed parent packages.

compareTo

public int compareTo(PackageInfo o)

Specified by:

compareTo in interface Comparable<PackageInfo>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object