Top Description Inners Fields Constructors Methods
org.jboss.jandex

public final Class ModuleInfo

extends Object
Class Inheritance
Imports
java.util.Collection, .Collections, .List

Represents a module descriptor entry in an index.

Thread-Safety

This class is immutable and can be shared between threads without safe publication.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static class
public static class
public static class

Field Summary

Modifier and TypeField and Description
private List<ModuleInfo.ExportedPackageInfo>
private final short
private DotName
pack-priv static final int
private final ClassInfo
private final DotName
private static final int
private List<ModuleInfo.OpenedPackageInfo>
private List<DotName>
private List<ModuleInfo.ProvidedServiceInfo>
private List<ModuleInfo.RequiredModuleInfo>
private List<DotName>
private final String

Constructor Summary

AccessConstructor and Description
pack-priv
ModuleInfo(ClassInfo moduleInfoClass, DotName name, short flags, String version)

Method Summary

Modifier and TypeMethod and Description
public final AnnotationInstance
public final Collection<AnnotationInstance>
public final List<AnnotationInstance>
public List<ModuleInfo.ExportedPackageInfo>
pack-priv List<ModuleInfo.ExportedPackageInfo>
public short

Returns:

the access flags
flags
()

Returns the access flags for this class.

public final boolean
public boolean
public DotName
public ClassInfo
public DotName

Returns:

the name of the class
name
()

Returns the name of the class

public List<ModuleInfo.OpenedPackageInfo>
pack-priv List<ModuleInfo.OpenedPackageInfo>
public List<DotName>
pack-priv List<DotName>
public List<ModuleInfo.ProvidedServiceInfo>
pack-priv List<ModuleInfo.ProvidedServiceInfo>
public List<ModuleInfo.RequiredModuleInfo>
pack-priv List<ModuleInfo.RequiredModuleInfo>
pack-priv void
pack-priv void
setMainClass(DotName mainClass)

pack-priv void
pack-priv void
pack-priv void
pack-priv void
pack-priv void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public List<DotName>
uses()

pack-priv List<DotName>
public String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

exportsback to summary
private List<ModuleInfo.ExportedPackageInfo> exports
flagsback to summary
private final short flags
mainClassback to summary
private DotName mainClass
MODULEback to summary
pack-priv static final int MODULE
moduleInfoClassback to summary
private final ClassInfo moduleInfoClass
nameback to summary
private final DotName name
OPENback to summary
private static final int OPEN
opensback to summary
private List<ModuleInfo.OpenedPackageInfo> opens
packagesback to summary
private List<DotName> packages
providesback to summary
private List<ModuleInfo.ProvidedServiceInfo> provides
requiresback to summary
private List<ModuleInfo.RequiredModuleInfo> requires
usesback to summary
private List<DotName> uses
versionback to summary
private final String version

Constructor Detail

ModuleInfoback to summary
pack-priv ModuleInfo(ClassInfo moduleInfoClass, DotName name, short flags, String version)

Method Detail

annotationback to summary
public final AnnotationInstance annotation(DotName name)
annotationsback to summary
public final Collection<AnnotationInstance> annotations()
annotationsWithRepeatableback to summary
public final List<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index)
exportsback to summary
public List<ModuleInfo.ExportedPackageInfo> exports()
exportsListback to summary
pack-priv List<ModuleInfo.ExportedPackageInfo> exportsList()
flagsback to summary
public short flags()

Returns the access flags for this class. The standard java.lang.reflect.Modifier can be used to decode the value.

Returns:short

the access flags

hasAnnotationback to summary
public final boolean hasAnnotation(DotName name)
isOpenback to summary
public boolean isOpen()
mainClassback to summary
public DotName mainClass()
moduleInfoClassback to summary
public ClassInfo moduleInfoClass()
nameback to summary
public DotName name()

Returns the name of the class

Returns:DotName

the name of the class

opensback to summary
public List<ModuleInfo.OpenedPackageInfo> opens()
opensListback to summary
pack-priv List<ModuleInfo.OpenedPackageInfo> opensList()
packagesback to summary
public List<DotName> packages()
packagesListback to summary
pack-priv List<DotName> packagesList()
providesback to summary
public List<ModuleInfo.ProvidedServiceInfo> provides()
providesListback to summary
pack-priv List<ModuleInfo.ProvidedServiceInfo> providesList()
requiresback to summary
public List<ModuleInfo.RequiredModuleInfo> requires()
requiresListback to summary
pack-priv List<ModuleInfo.RequiredModuleInfo> requiresList()
setExportsback to summary
pack-priv void setExports(List<ModuleInfo.ExportedPackageInfo> exports)
setMainClassback to summary
pack-priv void setMainClass(DotName mainClass)
setOpensback to summary
pack-priv void setOpens(List<ModuleInfo.OpenedPackageInfo> opens)
setPackagesback to summary
pack-priv void setPackages(List<DotName> packages)
setProvidesback to summary
pack-priv void setProvides(List<ModuleInfo.ProvidedServiceInfo> provides)
setRequiresback to summary
pack-priv void setRequires(List<ModuleInfo.RequiredModuleInfo> requires)
setUsesback to summary
pack-priv void setUses(List<DotName> uses)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

usesback to summary
public List<DotName> uses()
usesListback to summary
pack-priv List<DotName> usesList()
versionback to summary
public String version()
org.jboss.jandex back to summary

public final Class ModuleInfo.ExportedPackageInfo

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final int
private final DotName
private final List<DotName>

Constructor Summary

AccessConstructor and Description
pack-priv
ExportedPackageInfo(DotName source, int flags, List<DotName> targets)

Method Summary

Modifier and TypeMethod and Description
public int
public boolean
public DotName
public List<DotName>
pack-priv List<DotName>
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

flagsback to summary
private final int flags
sourceback to summary
private final DotName source
targetsback to summary
private final List<DotName> targets

Constructor Detail

ExportedPackageInfoback to summary
pack-priv ExportedPackageInfo(DotName source, int flags, List<DotName> targets)

Method Detail

flagsback to summary
public int flags()
isQualifiedback to summary
public boolean isQualified()
sourceback to summary
public DotName source()
targetsback to summary
public List<DotName> targets()
targetsListback to summary
pack-priv List<DotName> targetsList()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.jboss.jandex back to summary

public final Class ModuleInfo.OpenedPackageInfo

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final int
private final DotName
private final List<DotName>

Constructor Summary

AccessConstructor and Description
pack-priv
OpenedPackageInfo(DotName source, int flags, List<DotName> targets)

Method Summary

Modifier and TypeMethod and Description
public int
public boolean
public DotName
public List<DotName>
pack-priv List<DotName>
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

flagsback to summary
private final int flags
sourceback to summary
private final DotName source
targetsback to summary
private final List<DotName> targets

Constructor Detail

OpenedPackageInfoback to summary
pack-priv OpenedPackageInfo(DotName source, int flags, List<DotName> targets)

Method Detail

flagsback to summary
public int flags()
isQualifiedback to summary
public boolean isQualified()
sourceback to summary
public DotName source()
targetsback to summary
public List<DotName> targets()
targetsListback to summary
pack-priv List<DotName> targetsList()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.jboss.jandex back to summary

public final Class ModuleInfo.ProvidedServiceInfo

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final List<DotName>
private final DotName

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public List<DotName>
pack-priv List<DotName>
public DotName
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

providersback to summary
private final List<DotName> providers
serviceback to summary
private final DotName service

Constructor Detail

ProvidedServiceInfoback to summary
pack-priv ProvidedServiceInfo(DotName name, List<DotName> providers)

Method Detail

providersback to summary
public List<DotName> providers()
providersListback to summary
pack-priv List<DotName> providersList()
serviceback to summary
public DotName service()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.jboss.jandex back to summary

public final Class ModuleInfo.RequiredModuleInfo

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final int
private final DotName
private static final int
private static final int
private final String

Constructor Summary

AccessConstructor and Description
pack-priv
RequiredModuleInfo(DotName name, int flags, String version)

Method Summary

Modifier and TypeMethod and Description
public int
public boolean
public boolean
public DotName
name()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

flagsback to summary
private final int flags
nameback to summary
private final DotName name
STATICback to summary
private static final int STATIC
TRANSITIVEback to summary
private static final int TRANSITIVE
versionback to summary
private final String version

Constructor Detail

RequiredModuleInfoback to summary
pack-priv RequiredModuleInfo(DotName name, int flags, String version)

Method Detail

flagsback to summary
public int flags()
isStaticback to summary
public boolean isStatic()
isTransitiveback to summary
public boolean isTransitive()
nameback to summary
public DotName name()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
versionback to summary
public String version()