Module org.eclipse.persistence.asm
Class ClassRemapper
java.lang.Object
org.eclipse.persistence.internal.libraries.asm.ClassVisitor
org.eclipse.persistence.internal.libraries.asm.commons.ClassRemapper
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
The internal name of the visited class.protected final 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
ConstructorsModifierConstructorDescriptionprotected
ClassRemapper
(int api, ClassVisitor classVisitor, Remapper remapper) Constructs a newClassRemapper
.ClassRemapper
(ClassVisitor classVisitor, Remapper remapper) Constructs a newClassRemapper
. -
Method Summary
Modifier and TypeMethodDescriptionprotected AnnotationVisitor
createAnnotationRemapper
(String descriptor, AnnotationVisitor annotationVisitor) Constructs a new remapper for annotations.protected AnnotationVisitor
createAnnotationRemapper
(AnnotationVisitor annotationVisitor) Deprecated.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.visitAnnotation
(String descriptor, boolean visible) Visits an annotation of the class.void
visitAttribute
(Attribute attribute) Visits a non standard attribute of the class.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.visitMethod
(int access, String name, String descriptor, String signature, String[] exceptions) Visits a method of the class.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.visitRecordComponent
(String name, String descriptor, String signature) Visits a record component of the class.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
getDelegate, visitEnd, visitSource
-
Field Details
-
remapper
The remapper used to remap the types in the visited class. -
className
The internal name of the visited class.
-
-
Constructor Details
-
ClassRemapper
Constructs a newClassRemapper
. Subclasses must not use this constructor. Instead, they must use theClassRemapper(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
Constructs a newClassRemapper
.- Parameters:
api
- the ASM API version supported by this remapper. Must be one of theASM
x values inOpcodes
.classVisitor
- the class visitor this remapper must delegate to.remapper
- the remapper to use to remap the types in the visited class.
-
-
Method Details
-
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 classClassVisitor
- 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 (seeOpcodes
). This parameter also indicates if the class is deprecatedOpcodes.ACC_DEPRECATED
or a recordOpcodes.ACC_RECORD
.name
- the internal name of the class (seeType.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 (seeType.getInternalName()
). For interfaces, the super class isObject
. May be null, but only for theObject
class.interfaces
- the internal names of the class's interfaces (seeType.getInternalName()
). May be null.
-
visitModule
Description copied from class:ClassVisitor
Visit the module corresponding to the class.- Overrides:
visitModule
in classClassVisitor
- Parameters:
name
- the fully qualified name (using dots) of the module.flags
- the module access flags, amongACC_OPEN
,ACC_SYNTHETIC
andACC_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
Description copied from class:ClassVisitor
Visits an annotation of the class.- Overrides:
visitAnnotation
in classClassVisitor
- 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 classClassVisitor
- Parameters:
typeRef
- a reference to the annotated type. The sort of this type reference must beTypeReference.CLASS_TYPE_PARAMETER
,TypeReference.CLASS_TYPE_PARAMETER_BOUND
orTypeReference.CLASS_EXTENDS
. SeeTypeReference
.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
Description copied from class:ClassVisitor
Visits a non standard attribute of the class.- Overrides:
visitAttribute
in classClassVisitor
- 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 classClassVisitor
- Parameters:
name
- the record component name.descriptor
- the record component descriptor (seeType
).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 classClassVisitor
- Parameters:
access
- the field's access flags (seeOpcodes
). This parameter also indicates if the field is synthetic and/or deprecated.name
- the field's name.descriptor
- the field's descriptor (seeType
).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 anInteger
, aFloat
, aLong
, aDouble
or aString
(forint
,float
,long
orString
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 newMethodVisitor
instance (or null) each time it is called, i.e., it should not return a previously returned visitor.- Overrides:
visitMethod
in classClassVisitor
- Parameters:
access
- the method's access flags (seeOpcodes
). This parameter also indicates if the method is synthetic and/or deprecated.name
- the method's name.descriptor
- the method's descriptor (seeType
).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 (seeType.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
Description copied from class:ClassVisitor
Visits information about an inner class. This inner class is not necessarily a member of the class being visited. More precisely, every class or interface C which is referenced by this class and which is not a package member must be visited with this method. This class must reference its nested class or interface members, and its enclosing class, if any. See the JVMS 4.7.6 section for more details.- Overrides:
visitInnerClass
in classClassVisitor
- Parameters:
name
- the internal name of C (seeType.getInternalName()
).outerName
- the internal name of the class or interface C is a member of (seeType.getInternalName()
). Must be null if C is not the member of a class or interface (e.g. for local or anonymous classes).innerName
- the (simple) name of C. Must be null for anonymous inner classes.access
- the access flags of C originally declared in the source code from which this class was compiled.
-
visitOuterClass
Description copied from class:ClassVisitor
Visits the enclosing class of the class. This method must be called only if this class is a local or anonymous class. See the JVMS 4.7.7 section for more details.- Overrides:
visitOuterClass
in classClassVisitor
- Parameters:
owner
- internal name of the enclosing class of the class (seeType.getInternalName()
).name
- the name of the method that contains the class, or null if the class is not enclosed in a method or constructor of its enclosing class (e.g. if it is enclosed in an instance initializer, static initializer, instance variable initializer, or class variable initializer).descriptor
- the descriptor of the method that contains the class, or null if the class is not enclosed in a method or constructor of its enclosing class (e.g. if it is enclosed in an instance initializer, static initializer, instance variable initializer, or class variable initializer).
-
visitNestHost
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 classClassVisitor
- Parameters:
nestHost
- the internal name of the host class of the nest (seeType.getInternalName()
).
-
visitNestMember
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 classClassVisitor
- Parameters:
nestMember
- the internal name of a nest member (seeType.getInternalName()
).
-
visitPermittedSubclass
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 classClassVisitor
- Parameters:
permittedSubclass
- the internal name of a permitted subclass (seeType.getInternalName()
).
-
createFieldRemapper
Constructs a new remapper for fields. The default implementation of this method returns a newFieldRemapper
.- Parameters:
fieldVisitor
- the FieldVisitor the remapper must delegate to.- Returns:
- the newly created remapper.
-
createMethodRemapper
Constructs a new remapper for methods. The default implementation of this method returns a newMethodRemapper
.- Parameters:
methodVisitor
- the MethodVisitor the remapper must delegate to.- Returns:
- the newly created remapper.
-
createAnnotationRemapper
@Deprecated protected AnnotationVisitor createAnnotationRemapper(AnnotationVisitor annotationVisitor) Deprecated.usecreateAnnotationRemapper(String, AnnotationVisitor)
instead.Constructs a new remapper for annotations. The default implementation of this method returns a newAnnotationRemapper
.- 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 newAnnotationRemapper
.- Parameters:
descriptor
- the descriptor of the visited annotation.annotationVisitor
- the AnnotationVisitor the remapper must delegate to.- Returns:
- the newly created remapper.
-
createModuleRemapper
Constructs a new remapper for modules. The default implementation of this method returns a newModuleRemapper
.- 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 newRecordComponentRemapper
.- Parameters:
recordComponentVisitor
- the RecordComponentVisitor the remapper must delegate to.- Returns:
- the newly created remapper.
-
createAnnotationRemapper(String, AnnotationVisitor)
instead.