Package org.objectweb.asm.util

Class CheckModuleAdapter

java.lang.Object

org.objectweb.asm.ModuleVisitor

org.objectweb.asm.util.CheckModuleAdapter

public class CheckModuleAdapter
extends ModuleVisitor

A ModuleVisitor that checks that its methods are properly used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CheckModuleAdapter.NameSet

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	classVersion	The class version number.
private final CheckModuleAdapter.NameSet	exportedPackages	The internal names of the packages exported by the visited module.
private final boolean	isOpen	Whether the visited module is open.
private final CheckModuleAdapter.NameSet	openedPackages	The internal names of the packages opened by the visited module.
private final CheckModuleAdapter.NameSet	providedServices	The internal names of the services provided by the visited module.
private final CheckModuleAdapter.NameSet	requiredModules	The fully qualified names of the dependencies of the visited module.
private final CheckModuleAdapter.NameSet	usedServices	The internal names of the services used by the visited module.
private boolean	visitEndCalled	Whether the visitEnd() method has been called.

Fields inherited from class org.objectweb.asm.ModuleVisitor

api, mv

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CheckModuleAdapter(int api, ModuleVisitor moduleVisitor, boolean isOpen)	Constructs a new CheckModuleAdapter.
	CheckModuleAdapter(ModuleVisitor moduleVisitor, boolean isOpen)	Constructs a new CheckModuleAdapter.

Method Summary

Modifier and Type	Method	Description
private void	checkVisitEndNotCalled()
void	visitEnd()	Visits the end of the module.
void	visitExport(String packaze, int access, String... modules)	Visit an exported package of the current module.
void	visitMainClass(String mainClass)	Visit the main class of the current module.
void	visitOpen(String packaze, int access, String... modules)	Visit an open package of the current module.
void	visitPackage(String packaze)	Visit a package of the current module.
void	visitProvide(String service, String... providers)	Visit an implementation of a service.
void	visitRequire(String module, int access, String version)	Visits a dependence of the current module.
void	visitUse(String service)	Visit a service used by the current module.

Methods inherited from class org.objectweb.asm.ModuleVisitor

getDelegate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

isOpen

private final boolean isOpen

Whether the visited module is open.

requiredModules

private final CheckModuleAdapter.NameSet requiredModules

The fully qualified names of the dependencies of the visited module.

exportedPackages

private final CheckModuleAdapter.NameSet exportedPackages

The internal names of the packages exported by the visited module.

openedPackages

private final CheckModuleAdapter.NameSet openedPackages

The internal names of the packages opened by the visited module.

usedServices

private final CheckModuleAdapter.NameSet usedServices

The internal names of the services used by the visited module.

providedServices

private final CheckModuleAdapter.NameSet providedServices

The internal names of the services provided by the visited module.

classVersion

int classVersion

The class version number.

visitEndCalled

private boolean visitEndCalled

Whether the visitEnd() method has been called.

Constructor Details

CheckModuleAdapter

public CheckModuleAdapter(ModuleVisitor moduleVisitor,
 boolean isOpen)

Constructs a new CheckModuleAdapter. Subclasses must not use this constructor. Instead, they must use the CheckModuleAdapter(int, ModuleVisitor, boolean) version.

Parameters:

moduleVisitor - the module visitor to which this adapter must delegate calls.

isOpen - whether the visited module is open. Open modules have their Opcodes.ACC_OPEN access flag set in ClassVisitor.visitModule(java.lang.String, int, java.lang.String).

Throws:

IllegalStateException - If a subclass calls this constructor.

CheckModuleAdapter

protected CheckModuleAdapter(int api,
 ModuleVisitor moduleVisitor,
 boolean isOpen)

Constructs a new CheckModuleAdapter.

Parameters:

api - the ASM API version implemented by this visitor. Must be one of the ASMx values in Opcodes.

moduleVisitor - the module visitor to which this adapter must delegate calls.

isOpen - whether the visited module is open. Open modules have their Opcodes.ACC_OPEN access flag set in ClassVisitor.visitModule(java.lang.String, int, java.lang.String).

Method Details

visitMainClass

public void visitMainClass(String mainClass)

Description copied from class: ModuleVisitor

Visit the main class of the current module.

Overrides:

visitMainClass in class ModuleVisitor

Parameters:

mainClass - the internal name of the main class of the current module (see Type.getInternalName()).

visitPackage

public void visitPackage(String packaze)

Description copied from class: ModuleVisitor

Visit a package of the current module.

Overrides:

visitPackage in class ModuleVisitor

Parameters:

packaze - the internal name of a package (see Type.getInternalName()).

visitRequire

public void visitRequire(String module,
 int access,
 String version)

Description copied from class: ModuleVisitor

Visits a dependence of the current module.

Overrides:

visitRequire in class ModuleVisitor

Parameters:

module - the fully qualified name (using dots) of the dependence.

access - the access flag of the dependence among ACC_TRANSITIVE, ACC_STATIC_PHASE, ACC_SYNTHETIC and ACC_MANDATED.

version - the module version at compile time, or null.

visitExport

public void visitExport(String packaze,
 int access,
 String... modules)

Description copied from class: ModuleVisitor

Visit an exported package of the current module.

Overrides:

visitExport in class ModuleVisitor

Parameters:

packaze - the internal name of the exported package (see Type.getInternalName()).

access - the access flag of the exported package, valid values are among ACC_SYNTHETIC and ACC_MANDATED.

modules - the fully qualified names (using dots) of the modules that can access the public classes of the exported package, or null.

visitOpen

public void visitOpen(String packaze,
 int access,
 String... modules)

Description copied from class: ModuleVisitor

Visit an open package of the current module.

Overrides:

visitOpen in class ModuleVisitor

Parameters:

packaze - the internal name of the opened package (see Type.getInternalName()).

access - the access flag of the opened package, valid values are among ACC_SYNTHETIC and ACC_MANDATED.

modules - the fully qualified names (using dots) of the modules that can use deep reflection to the classes of the open package, or null.

visitUse

public void visitUse(String service)

Description copied from class: ModuleVisitor

Visit a service used by the current module. The name must be the internal name of an interface or a class.

Overrides:

visitUse in class ModuleVisitor

Parameters:

service - the internal name of the service (see Type.getInternalName()).

visitProvide

public void visitProvide(String service,
 String... providers)

Description copied from class: ModuleVisitor

Visit an implementation of a service.

Overrides:

visitProvide in class ModuleVisitor

Parameters:

service - the internal name of the service (see Type.getInternalName()).

providers - the internal names (see Type.getInternalName()) of the implementations of the service (there is at least one provider).

visitEnd

public void visitEnd()

Description copied from class: ModuleVisitor

Visits the end of the module. This method, which is the last one to be called, is used to inform the visitor that everything have been visited.

Overrides:

visitEnd in class ModuleVisitor

checkVisitEndNotCalled

private void checkVisitEndNotCalled()