ModuleInfo (ClassGraph 4.8.65 API)

java.lang.Object
- io.github.classgraph.ModuleInfo

All Implemented Interfaces:

HasName, Comparable<ModuleInfo>
```
public class ModuleInfo
extends Object
implements Comparable<ModuleInfo>, HasName
```
Holds metadata about a package encountered during a scan.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(ModuleInfo other)`
`boolean`	`equals(Object obj)`
`AnnotationInfoList`	`getAnnotationInfo()` Get any annotations on the `package-info.class` file.
`AnnotationInfo`	`getAnnotationInfo(String annotationName)` Get a the named annotation on this module, or null if the module does not have the named annotation.
`ClassInfoList`	`getClassInfo()` Get the list of `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 module, or null if the class was not found in this module.
`URI`	`getLocation()` The module location, or null for modules whose location is unknown.
`ModuleRef`	`getModuleRef()` The `ModuleRef` for this module, or null if this module was obtained from a classpath element on the traditional classpath that contained a `module-info.class` file.
`String`	`getName()` The module name, or `""` for the unnamed module.
`PackageInfoList`	`getPackageInfo()` Get the `PackageInfo` objects for all packages that are members of this module.
`PackageInfo`	`getPackageInfo(String packageName)` Get the `PackageInfo` object for the named package in this module, or null if the package was not found in this module.
`boolean`	`hasAnnotation(String annotationName)` Check if this module has the named annotation.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getName
```
public String getName()
```
    The module name, or "" for the unnamed module.
    
    Specified by:
    
    getName in interface HasName
    
    Returns:
    
    the module name, or "" for the unnamed module.
  - getLocation
```
public URI getLocation()
```
    The module location, or null for modules whose location is unknown.
    
    Returns:
    
    the module location, or null for modules whose location is unknown.
  - getModuleRef
```
public ModuleRef getModuleRef()
```
    The ModuleRef for this module, or null if this module was obtained from a classpath element on the traditional classpath that contained a module-info.class file.
    
    Returns:
    
    the ModuleRef, or null if this module was obtained from a classpath element on the traditional classpath that contained a module-info.class file.
  - getClassInfo
```
public ClassInfo getClassInfo(String className)
```
    Get the ClassInfo object for the named class in this module, or null if the class was not found in this module.
    
    Parameters:
    
    className - the class name
    
    Returns:
    
    the ClassInfo object for the named class in this module, or null if the class was not found in this module.
  - getClassInfo
```
public ClassInfoList getClassInfo()
```
    Get the list of ClassInfo objects for all classes that are members of this package.
    
    Returns:
    
    the list of ClassInfo objects for all classes that are members of this package.
  - getPackageInfo
```
public PackageInfo getPackageInfo(String packageName)
```
    Get the PackageInfo object for the named package in this module, or null if the package was not found in this module.
    
    Parameters:
    
    packageName - the package name
    
    Returns:
    
    the PackageInfo object for the named package in this module, or null if the package was not found in this module.
  - getPackageInfo
```
public PackageInfoList getPackageInfo()
```
    Get the PackageInfo objects for all packages that are members of this module.
    
    Returns:
    
    the list of PackageInfo objects for all packages that are members of this module.
  - getAnnotationInfo
```
public AnnotationInfo getAnnotationInfo(String annotationName)
```
    Get a the named annotation on this module, or null if the module does not have the named annotation.
    
    Parameters:
    
    annotationName - The annotation name.
    
    Returns:
    
    An AnnotationInfo object representing the named annotation on this module, or null if the module does not have the named annotation.
  - getAnnotationInfo
```
public AnnotationInfoList getAnnotationInfo()
```
    Get any annotations on the package-info.class file.
    
    Returns:
    
    the list of AnnotationInfo objects for annotations on the package-info.class file.
  - hasAnnotation
```
public boolean hasAnnotation(String annotationName)
```
    Check if this module has the named annotation.
    
    Parameters:
    
    annotationName - The name of an annotation.
    
    Returns:
    
    true if this module has the named annotation.
  - compareTo
```
public int compareTo(ModuleInfo other)
```
    Specified by:
    
    compareTo in interface Comparable<ModuleInfo>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ModuleInfo

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getLocation

getModuleRef

getClassInfo

getClassInfo

getPackageInfo

getPackageInfo

getAnnotationInfo

getAnnotationInfo

hasAnnotation

compareTo

hashCode

equals

toString