io.github.classgraph

Class PackageInfo

java.lang.Object

io.github.classgraph.PackageInfo

All Implemented Interfaces:

HasName, java.lang.Comparable<PackageInfo>

public class PackageInfo
extends java.lang.Object
implements java.lang.Comparable<PackageInfo>, HasName

Holds metadata about a package encountered during a scan.

Method Summary

Modifier and Type	Method and Description
int	compareTo(PackageInfo o)
boolean	equals(java.lang.Object obj)
AnnotationInfoList	getAnnotationInfo() Get any annotations on the package-info.class file.
AnnotationInfo	getAnnotationInfo(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Get a the annotation on this package, or null if the package does not have the annotation.
AnnotationInfo	getAnnotationInfo(java.lang.String annotationName) Get a the named annotation on this package, or null if the package does not have the named annotation.
PackageInfoList	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(java.lang.String className) Get the ClassInfo object for the named class in this package, or null if the class was not found in this package.
ClassInfoList	getClassInfoRecursive() Get the ClassInfo objects for all classes that are members of this package or a sub-package.
java.lang.String	getName() The package name ("" for the root package).
PackageInfo	getParent() The parent package of this package, or null if this is the root package.
boolean	hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotation) Check if the package has the annotation.
boolean	hasAnnotation(java.lang.String annotationName) Check if the package has the named annotation.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

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

Specified by:

getName in interface HasName

Returns:

the name

getAnnotationInfo

public AnnotationInfo getAnnotationInfo(java.lang.Class<? extends java.lang.annotation.Annotation> annotation)

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

Parameters:

annotation - The annotation.

Returns:

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

getAnnotationInfo

public AnnotationInfo getAnnotationInfo(java.lang.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.

Returns:

the annotations on the package-info.class file.

hasAnnotation

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

Check if the package has the annotation.

Parameters:

annotation - The annotation.

Returns:

true if this package has the annotation.

hasAnnotation

public boolean hasAnnotation(java.lang.String annotationName)

Check if the package has the named annotation.

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.

Returns:

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

getChildren

public PackageInfoList getChildren()

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

Returns:

the child packages, or the empty list if none.

getClassInfo

public ClassInfo getClassInfo(java.lang.String className)

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

Parameters:

className - the class name

Returns:

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

getClassInfo

public ClassInfoList getClassInfo()

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

Returns:

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.

Returns:

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

compareTo

public int compareTo(PackageInfo o)

Specified by:

compareTo in interface java.lang.Comparable<PackageInfo>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object