// ASM: a very small and fast Java bytecode manipulation framework
// Copyright (c) 2000-2011 INRIA, France Telecom
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the copyright holders nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
package org.objectweb.asm;

A visitor to visit a Java module. The methods of this class must be called in the following order: ( visitMainClass | ( visitPackage | visitRequire | visitExport | visitOpen | visitUse | visitProvide )* ) visitEnd.
Author:Remi Forax, Eric Bruneton
/** * A visitor to visit a Java module. The methods of this class must be called in the following * order: ( {@code visitMainClass} | ( {@code visitPackage} | {@code visitRequire} | {@code * visitExport} | {@code visitOpen} | {@code visitUse} | {@code visitProvide} )* ) {@code visitEnd}. * * @author Remi Forax * @author Eric Bruneton */
public abstract class ModuleVisitor {
The ASM API version implemented by this visitor. The value of this field must be one of Opcodes.ASM6 or Opcodes.ASM7.
/** * The ASM API version implemented by this visitor. The value of this field must be one of {@link * Opcodes#ASM6} or {@link Opcodes#ASM7}. */
protected final int api;
The module visitor to which this visitor must delegate method calls. May be null.
/** The module visitor to which this visitor must delegate method calls. May be null. */
protected ModuleVisitor mv;
Constructs a new ModuleVisitor.
Params:
/** * Constructs a new {@link ModuleVisitor}. * * @param api the ASM API version implemented by this visitor. Must be one of {@link Opcodes#ASM6} * or {@link Opcodes#ASM7}. */
public ModuleVisitor(final int api) { this(api, null); }
Constructs a new ModuleVisitor.
Params:
  • api – the ASM API version implemented by this visitor. Must be one of Opcodes.ASM6 or Opcodes.ASM7.
  • moduleVisitor – the module visitor to which this visitor must delegate method calls. May be null.
/** * Constructs a new {@link ModuleVisitor}. * * @param api the ASM API version implemented by this visitor. Must be one of {@link Opcodes#ASM6} * or {@link Opcodes#ASM7}. * @param moduleVisitor the module visitor to which this visitor must delegate method calls. May * be null. */
public ModuleVisitor(final int api, final ModuleVisitor moduleVisitor) { if (api != Opcodes.ASM7 && api != Opcodes.ASM6) { throw new IllegalArgumentException("Unsupported api " + api); } this.api = api; this.mv = moduleVisitor; }
Visit the main class of the current module.
Params:
  • mainClass – the internal name of the main class of the current module.
/** * Visit the main class of the current module. * * @param mainClass the internal name of the main class of the current module. */
public void visitMainClass(final String mainClass) { if (mv != null) { mv.visitMainClass(mainClass); } }
Visit a package of the current module.
Params:
  • packaze – the internal name of a package.
/** * Visit a package of the current module. * * @param packaze the internal name of a package. */
public void visitPackage(final String packaze) { if (mv != null) { mv.visitPackage(packaze); } }
Visits a dependence of the current module.
Params:
  • 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.
/** * Visits a dependence of the current module. * * @param module the fully qualified name (using dots) of the dependence. * @param access the access flag of the dependence among {@code ACC_TRANSITIVE}, {@code * ACC_STATIC_PHASE}, {@code ACC_SYNTHETIC} and {@code ACC_MANDATED}. * @param version the module version at compile time, or {@literal null}. */
public void visitRequire(final String module, final int access, final String version) { if (mv != null) { mv.visitRequire(module, access, version); } }
Visit an exported package of the current module.
Params:
  • packaze – the internal name of the exported package.
  • 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.
/** * Visit an exported package of the current module. * * @param packaze the internal name of the exported package. * @param access the access flag of the exported package, valid values are among {@code * ACC_SYNTHETIC} and {@code ACC_MANDATED}. * @param modules the fully qualified names (using dots) of the modules that can access the public * classes of the exported package, or {@literal null}. */
public void visitExport(final String packaze, final int access, final String... modules) { if (mv != null) { mv.visitExport(packaze, access, modules); } }
Visit an open package of the current module.
Params:
  • packaze – the internal name of the opened package.
  • 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.
/** * Visit an open package of the current module. * * @param packaze the internal name of the opened package. * @param access the access flag of the opened package, valid values are among {@code * ACC_SYNTHETIC} and {@code ACC_MANDATED}. * @param modules the fully qualified names (using dots) of the modules that can use deep * reflection to the classes of the open package, or {@literal null}. */
public void visitOpen(final String packaze, final int access, final String... modules) { if (mv != null) { mv.visitOpen(packaze, access, modules); } }
Visit a service used by the current module. The name must be the internal name of an interface or a class.
Params:
  • service – the internal name of the service.
/** * Visit a service used by the current module. The name must be the internal name of an interface * or a class. * * @param service the internal name of the service. */
public void visitUse(final String service) { if (mv != null) { mv.visitUse(service); } }
Visit an implementation of a service.
Params:
  • service – the internal name of the service.
  • providers – the internal names of the implementations of the service (there is at least one provider).
/** * Visit an implementation of a service. * * @param service the internal name of the service. * @param providers the internal names of the implementations of the service (there is at least * one provider). */
public void visitProvide(final String service, final String... providers) { if (mv != null) { mv.visitProvide(service, providers); } }
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.
/** * 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. */
public void visitEnd() { if (mv != null) { mv.visitEnd(); } } }