From e7fe75dbae1997b0b8685f4f04be7a85ffc2bf6b Mon Sep 17 00:00:00 2001
From: Eric Bruneton <ebruneton@free.fr>
Date: Sun, 8 Sep 2019 10:42:36 +0200
Subject: [PATCH] Document some limitations of ClassRemapper.

---
 .../org/objectweb/asm/commons/ClassRemapper.java   | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/asm-commons/src/main/java/org/objectweb/asm/commons/ClassRemapper.java b/asm-commons/src/main/java/org/objectweb/asm/commons/ClassRemapper.java
index a7f34ecf5..4860b8271 100644
--- a/asm-commons/src/main/java/org/objectweb/asm/commons/ClassRemapper.java
+++ b/asm-commons/src/main/java/org/objectweb/asm/commons/ClassRemapper.java
@@ -41,6 +41,20 @@ import org.objectweb.asm.TypePath;
 /**
  * A {@link ClassVisitor} that remaps types with a {@link Remapper}.
  *
+ * <p><i>This visitor has several limitations</i>. A non-exhaustive list is the following:
+ *
+ * <ul>
+ *   <li>it cannot remap type names in dynamically computed strings (remapping of type names in
+ *       static values is supported).
+ *   <li>it cannot remap values derived from type names at compile time, such as
+ *       <ul>
+ *         <li>type name hashcodes used by some Java compilers to implement the string switch
+ *             statement.
+ *         <li>some compound strings used by some Java compilers to implement lambda
+ *             deserialization.
+ *       </ul>
+ * </ul>
+ *
  * @author Eugene Kuleshov
  */
 public class ClassRemapper extends ClassVisitor {
-- 
GitLab