Add note about usage of StringBuilder for loading strings

Co-authored-by: Ladislav Thon <lthon@redhat.com>
quarkusio · Apr 12, 2023 · 1e0b6ec · 1e0b6ec
1 parent 7ff6379
commit 1e0b6ec
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/main/java/io/quarkus/gizmo/BytecodeCreatorImpl.java b/src/main/java/io/quarkus/gizmo/BytecodeCreatorImpl.java
@@ -309,6 +309,11 @@ ResultHandle getOutgoingResultHandle() {
 
     }
 
+    /**
+     * Implementation detail: when the string to be loaded is larger than {@link BytecodeCreatorImpl#MAX_STRING_LENGTH},
+     * then a {@link StringBuilder} is used to construct the final String. This is done because strings constants cannot be larger
+     * than {@link BytecodeCreatorImpl#MAX_STRING_LENGTH}.
+     */
     @Override
     public ResultHandle load(String val) {
         Objects.requireNonNull(val);