fixes: jakartaee#362 Locale problem with JsonbNumberFormat

struberg · Oct 20, 2024 · 16b1911 · 16b1911
1 parent f3a2332
commit 16b1911
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/api/src/main/java/jakarta/json/bind/annotation/JsonbNumberFormat.java b/api/src/main/java/jakarta/json/bind/annotation/JsonbNumberFormat.java
@@ -20,6 +20,7 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.Locale;
 
 /**
  * <p>Annotation provides way how to set custom number format to field or JavaBean property.</p>
@@ -36,6 +37,11 @@
  *   <li> package </li>
  * </ul>
  *
+ * <p>Note that even when specifying a pattern format your JSON is depending on the Locale of the JVM you run on.
+ * For best portability it is recommended to either specify the {@link #locale()} or define a default Locale via
+ * {@link jakarta.json.bind.JsonbConfig#withLocale(Locale)}.
+ * </p>
+ *
  * @since JSON Binding 1.0
  */
 @JsonbAnnotation