org.eclipse.persistence.internal.libraries.asm.commons

Class ClassRemapper

java.lang.Object

org.eclipse.persistence.internal.libraries.asm.ClassVisitor

org.eclipse.persistence.internal.libraries.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 and 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.eclipse.persistence.internal.libraries.asm.ClassVisitor

api, cv

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected AnnotationVisitor	createAnnotationRemapper(AnnotationVisitor annotationVisitor) Constructs a new remapper for annotations.
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) Visits the header of the class.
AnnotationVisitor	visitAnnotation(String descriptor, boolean visible) Visits an annotation of the class.
void	visitAttribute(Attribute attribute) Visits a non standard attribute of the class.
FieldVisitor	visitField(int access, String name, String descriptor, String signature, Object value) Visits a field of the class.
void	visitInnerClass(String name, String outerName, String innerName, int access) Visits information about an inner class.
MethodVisitor	visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) Visits a method of the class.
ModuleVisitor	visitModule(String name, int flags, String version) Visit the module corresponding to the class.
void	visitNestHost(String nestHost) Visits the nest host class of the class.
void	visitNestMember(String nestMember) Visits a member of the nest.
void	visitOuterClass(String owner, String name, String descriptor) Visits the enclosing class of the class.
void	visitPermittedSubclass(String permittedSubclass) Visits a permitted subclasses.
RecordComponentVisitor	visitRecordComponent(String name, String descriptor, String signature) Visits a record component of the class.
AnnotationVisitor	visitTypeAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible) Visits an annotation on a type in the class signature.

Methods inherited from class org.eclipse.persistence.internal.libraries.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 deleted 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 Opcodes.ASM4, Opcodes.ASM5, Opcodes.ASM6, Opcodes.ASM7, Opcodes.ASM8 or Opcodes.ASM9.

classVisitor - the class visitor this remapper must deleted 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)

Description copied from class: ClassVisitor

Visits the header of the class.

Overrides:

visit in class ClassVisitor

Parameters:

version - the class version. The minor version is stored in the 16 most significant bits, and the major version in the 16 least significant bits.

access - the class's access flags (see Opcodes). This parameter also indicates if the class is deprecated Opcodes.ACC_DEPRECATED or a record Opcodes.ACC_RECORD.

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

signature - the signature of this class. May be null if the class is not a generic one, and does not extend or implement generic classes or interfaces.

superName - the internal of name of the super class (see Type.getInternalName()). For interfaces, the super class is Object. May be null, but only for the Object class.

interfaces - the internal names of the class's interfaces (see Type.getInternalName()). May be null.

visitModule

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

Description copied from class: ClassVisitor

Visit the module corresponding to the class.

Overrides:

visitModule in class ClassVisitor

Parameters:

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

flags - the module access flags, among ACC_OPEN, ACC_SYNTHETIC and ACC_MANDATED.

version - the module version, or null.

Returns:

a visitor to visit the module values, or null if this visitor is not interested in visiting this module.

visitAnnotation

public AnnotationVisitor visitAnnotation(String descriptor,
                                         boolean visible)

Description copied from class: ClassVisitor

Visits an annotation of the class.

Overrides:

visitAnnotation in class ClassVisitor

Parameters:

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

visitTypeAnnotation

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

Description copied from class: ClassVisitor

Visits an annotation on a type in the class signature.

Overrides:

visitTypeAnnotation in class ClassVisitor

Parameters:

typeRef - a reference to the annotated type. The sort of this type reference must be TypeReference.CLASS_TYPE_PARAMETER, TypeReference.CLASS_TYPE_PARAMETER_BOUND or TypeReference.CLASS_EXTENDS. See TypeReference.

typePath - the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.

descriptor - the class descriptor of the annotation class.

visible - true if the annotation is visible at runtime.

Returns:

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

visitAttribute

public void visitAttribute(Attribute attribute)

Description copied from class: ClassVisitor

Visits a non standard attribute of the class.

Overrides:

visitAttribute in class ClassVisitor

Parameters:

attribute - an attribute.

visitRecordComponent

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

Description copied from class: ClassVisitor

Visits a record component of the class.

Overrides:

visitRecordComponent in class ClassVisitor

Parameters:

name - the record component name.

descriptor - the record component descriptor (see Type).

signature - the record component signature. May be null if the record component type does not use generic types.

Returns:

a visitor to visit this record component annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

visitField

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

Description copied from class: ClassVisitor

Visits a field of the class.

Overrides:

visitField in class ClassVisitor

Parameters:

access - the field's access flags (see Opcodes). This parameter also indicates if the field is synthetic and/or deprecated.

name - the field's name.

descriptor - the field's descriptor (see Type).

signature - the field's signature. May be null if the field's type does not use generic types.

value - the field's initial value. This parameter, which may be null if the field does not have an initial value, must be an Integer, a Float, a Long, a Double or a String (for int, float, long or String fields respectively). This parameter is only used for static fields. Its value is ignored for non static fields, which must be initialized through bytecode instructions in constructors or methods.

Returns:

a visitor to visit field annotations and attributes, or null if this class visitor is not interested in visiting these annotations and attributes.

visitMethod

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

Description copied from class: ClassVisitor

Visits a method of the class. This method must return a new MethodVisitor instance (or null) each time it is called, i.e., it should not return a previously returned visitor.

Overrides:

visitMethod in class ClassVisitor

Parameters:

access - the method's access flags (see Opcodes). This parameter also indicates if the method is synthetic and/or deprecated.

name - the method's name.

descriptor - the method's descriptor (see Type).

signature - the method's signature. May be null if the method parameters, return type and exceptions do not use generic types.

exceptions - the internal names of the method's exception classes (see Type.getInternalName()). May be null.

Returns:

an object to visit the byte code of the method, or null if this class visitor is not interested in visiting the code of this method.

visitInnerClass

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

Description copied from class: ClassVisitor

Visits information about an inner class. This inner class is not necessarily a member of the class being visited.

Overrides:

visitInnerClass in class ClassVisitor

Parameters:

name - the internal name of an inner class (see Type.getInternalName()).

outerName - the internal name of the class to which the inner class belongs (see Type.getInternalName()). May be null for not member classes.

innerName - the (simple) name of the inner class inside its enclosing class. May be null for anonymous inner classes.

access - the access flags of the inner class as originally declared in the enclosing class.

visitOuterClass

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

Description copied from class: ClassVisitor

Visits the enclosing class of the class. This method must be called only if the class has an enclosing class.

Overrides:

visitOuterClass in class ClassVisitor

Parameters:

owner - internal name of the enclosing class of the class.

name - the name of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.

descriptor - the descriptor of the method that contains the class, or null if the class is not enclosed in a method of its enclosing class.

visitNestHost

public void visitNestHost(String nestHost)

Description copied from class: ClassVisitor

Visits the nest host class of the class. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only once and only if the visited class is a non-host member of a nest. A class is implicitly its own nest, so it's invalid to call this method with the visited class name as argument.

Overrides:

visitNestHost in class ClassVisitor

Parameters:

nestHost - the internal name of the host class of the nest.

visitNestMember

public void visitNestMember(String nestMember)

Description copied from class: ClassVisitor

Visits a member of the nest. A nest is a set of classes of the same package that share access to their private members. One of these classes, called the host, lists the other members of the nest, which in turn should link to the host of their nest. This method must be called only if the visited class is the host of a nest. A nest host is implicitly a member of its own nest, so it's invalid to call this method with the visited class name as argument.

Overrides:

visitNestMember in class ClassVisitor

Parameters:

nestMember - the internal name of a nest member.

visitPermittedSubclass

public void visitPermittedSubclass(String permittedSubclass)

Description copied from class: ClassVisitor

Visits a permitted subclasses. A permitted subclass is one of the allowed subclasses of the current class.

Overrides:

visitPermittedSubclass in class ClassVisitor

Parameters:

permittedSubclass - the internal name of a permitted subclass.

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

protected AnnotationVisitor createAnnotationRemapper(AnnotationVisitor annotationVisitor)

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.

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.