Package org.objectweb.asm.commons

Class ClassRemapper

java.lang.Object

org.objectweb.asm.ClassVisitor

org.objectweb.asm.commons.ClassRemapper

public class ClassRemapper
extends ClassVisitor

A ClassVisitor that remaps types with a Remapper.

This visitor has several limitations. A non-exhaustive list is the following:

• it cannot remap type names in dynamically computed strings (remapping of type names in static values is supported).
• it cannot remap values derived from type names at compile time, such as
  • type name hashcodes used by some Java compilers to implement the string switch statement.
  • some compound strings used by some Java compilers to implement lambda deserialization.

Author:

Eugene Kuleshov

Field Summary

Fields

Modifier and Type	Field	Description
protected String	className	The internal name of the visited class.
protected Remapper	remapper	The remapper used to remap the types in the visited class.

Fields inherited from class org.objectweb.asm.ClassVisitor

api, cv

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClassRemapper(int api, ClassVisitor classVisitor, Remapper remapper)	Constructs a new ClassRemapper.
	ClassRemapper(ClassVisitor classVisitor, Remapper remapper)	Constructs a new ClassRemapper.

Method Summary

Modifier and Type	Method	Description
protected AnnotationVisitor	createAnnotationRemapper(String descriptor, AnnotationVisitor annotationVisitor)	Constructs a new remapper for annotations.
protected AnnotationVisitor	createAnnotationRemapper(AnnotationVisitor annotationVisitor)	Deprecated. use createAnnotationRemapper(String, AnnotationVisitor) instead.
protected FieldVisitor	createFieldRemapper(FieldVisitor fieldVisitor)	Constructs a new remapper for fields.
protected MethodVisitor	createMethodRemapper(MethodVisitor methodVisitor)	Constructs a new remapper for methods.
protected ModuleVisitor	createModuleRemapper(ModuleVisitor moduleVisitor)	Constructs a new remapper for modules.
protected RecordComponentVisitor	createRecordComponentRemapper(RecordComponentVisitor recordComponentVisitor)	Constructs a new remapper for record components.
void	visit(int version, int access, String name, String signature, String superName, String[] interfaces)
AnnotationVisitor	visitAnnotation(String descriptor, boolean visible)
void	visitAttribute(Attribute attribute)
FieldVisitor	visitField(int access, String name, String descriptor, String signature, Object value)
void	visitInnerClass(String name, String outerName, String innerName, int access)
MethodVisitor	visitMethod(int access, String name, String descriptor, String signature, String[] exceptions)
ModuleVisitor	visitModule(String name, int flags, String version)
void	visitNestHost(String nestHost)
void	visitNestMember(String nestMember)
void	visitOuterClass(String owner, String name, String descriptor)
void	visitPermittedSubclass(String permittedSubclass)
RecordComponentVisitor	visitRecordComponent(String name, String descriptor, String signature)
AnnotationVisitor	visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible)

Methods inherited from class org.objectweb.asm.ClassVisitor

visitEnd, visitSource

Methods inherited from class java.lang.Object

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

Field Detail

remapper

protected final Remapper remapper

The remapper used to remap the types in the visited class.

className

protected String className

The internal name of the visited class.

Constructor Detail

ClassRemapper

public ClassRemapper(ClassVisitor classVisitor,
                     Remapper remapper)

Constructs a new ClassRemapper. Subclasses must not use this constructor. Instead, they must use the ClassRemapper(int,ClassVisitor,Remapper) version.

Parameters:

classVisitor - the class visitor this remapper must delegate to.

remapper - the remapper to use to remap the types in the visited class.

ClassRemapper

protected ClassRemapper(int api,
                        ClassVisitor classVisitor,
                        Remapper remapper)

Constructs a new ClassRemapper.

Parameters:

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

classVisitor - the class visitor this remapper must delegate to.

remapper - the remapper to use to remap the types in the visited class.

Method Detail

visit

public void visit(int version,
                  int access,
                  String name,
                  String signature,
                  String superName,
                  String[] interfaces)

Overrides:

visit in class ClassVisitor

visitModule

public ModuleVisitor visitModule(String name,
                                 int flags,
                                 String version)

Overrides:

visitModule in class ClassVisitor

visitAnnotation

public AnnotationVisitor visitAnnotation(String descriptor,
                                         boolean visible)

Overrides:

visitAnnotation in class ClassVisitor

visitTypeAnnotation

public AnnotationVisitor visitTypeAnnotation(int typeRef,
                                             TypePath typePath,
                                             String descriptor,
                                             boolean visible)

Overrides:

visitTypeAnnotation in class ClassVisitor

visitAttribute

public void visitAttribute(Attribute attribute)

Overrides:

visitAttribute in class ClassVisitor

visitRecordComponent

public RecordComponentVisitor visitRecordComponent(String name,
                                                   String descriptor,
                                                   String signature)

Overrides:

visitRecordComponent in class ClassVisitor

visitField

public FieldVisitor visitField(int access,
                               String name,
                               String descriptor,
                               String signature,
                               Object value)

Overrides:

visitField in class ClassVisitor

visitMethod

public MethodVisitor visitMethod(int access,
                                 String name,
                                 String descriptor,
                                 String signature,
                                 String[] exceptions)

Overrides:

visitMethod in class ClassVisitor

visitInnerClass

public void visitInnerClass(String name,
                            String outerName,
                            String innerName,
                            int access)

Overrides:

visitInnerClass in class ClassVisitor

visitOuterClass

public void visitOuterClass(String owner,
                            String name,
                            String descriptor)

Overrides:

visitOuterClass in class ClassVisitor

visitNestHost

public void visitNestHost(String nestHost)

Overrides:

visitNestHost in class ClassVisitor

visitNestMember

public void visitNestMember(String nestMember)

Overrides:

visitNestMember in class ClassVisitor

visitPermittedSubclass

public void visitPermittedSubclass(String permittedSubclass)

Overrides:

visitPermittedSubclass in class ClassVisitor

createFieldRemapper

protected FieldVisitor createFieldRemapper(FieldVisitor fieldVisitor)

Constructs a new remapper for fields. The default implementation of this method returns a new FieldRemapper.

Parameters:

fieldVisitor - the FieldVisitor the remapper must delegate to.

Returns:

the newly created remapper.

createMethodRemapper

protected MethodVisitor createMethodRemapper(MethodVisitor methodVisitor)

Constructs a new remapper for methods. The default implementation of this method returns a new MethodRemapper.

Parameters:

methodVisitor - the MethodVisitor the remapper must delegate to.

Returns:

the newly created remapper.

createAnnotationRemapper

@Deprecated
protected AnnotationVisitor createAnnotationRemapper(AnnotationVisitor annotationVisitor)

Deprecated.

use createAnnotationRemapper(String, AnnotationVisitor) instead.

Constructs a new remapper for annotations. The default implementation of this method returns a new AnnotationRemapper.

Parameters:

annotationVisitor - the AnnotationVisitor the remapper must delegate to.

Returns:

the newly created remapper.

createAnnotationRemapper

protected AnnotationVisitor createAnnotationRemapper(String descriptor,
                                                     AnnotationVisitor annotationVisitor)

Constructs a new remapper for annotations. The default implementation of this method returns a new AnnotationRemapper.

Parameters:

descriptor - the descriptor of the visited annotation.

annotationVisitor - the AnnotationVisitor the remapper must delegate to.

Returns:

the newly created remapper.

createModuleRemapper

protected ModuleVisitor createModuleRemapper(ModuleVisitor moduleVisitor)

Constructs a new remapper for modules. The default implementation of this method returns a new ModuleRemapper.

Parameters:

moduleVisitor - the ModuleVisitor the remapper must delegate to.

Returns:

the newly created remapper.

createRecordComponentRemapper

protected RecordComponentVisitor createRecordComponentRemapper(RecordComponentVisitor recordComponentVisitor)

Constructs a new remapper for record components. The default implementation of this method returns a new RecordComponentRemapper.

Parameters:

recordComponentVisitor - the RecordComponentVisitor the remapper must delegate to.

Returns:

the newly created remapper.