chore: refactor date library usage to use CodegenConstants.DATE_LIBRARY

ChihweiLHBird · ChihweiLHBird · commit 5f631d485ea8 · 2026-03-24T15:13:44.000-04:00
Signed-off-by: Zhiwei Liang &lt;zhiwei.liang@zliang.me&gt;
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConstants.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/CodegenConstants.java
@@ -239,4 +239,6 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,
     public static final String INTERFACE_CONTROLLER = "interface-controller";
 
     public static final String IGNORE_IMPORT_MAPPING_OPTION = "ignoreImportMappings";
+
+    public static final String DATE_LIBRARY = "dateLibrary";
 }
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java
@@ -55,12 +55,13 @@ public abstract class AbstractJavaCodegen extends DefaultCodegen implements Code
 
     static Logger LOGGER = LoggerFactory.getLogger(AbstractJavaCodegen.class);
     public static final String FULL_JAVA_UTIL = "fullJavaUtil";
+    /** @deprecated Use {@link CodegenConstants#DATE_LIBRARY} instead. */
+    @Deprecated
+    public static final String DATE_LIBRARY = CodegenConstants.DATE_LIBRARY;
     public static final String DEFAULT_LIBRARY = "<default>";
-    public static final String DATE_LIBRARY = "dateLibrary";
     public static final String JAVA8_MODE = "java8";
     public static final String JAVA11_MODE = "java11";
     public static final String SUPPORT_ASYNC = "supportAsync";
-    public static final String WITH_XML = "withXml";
     public static final String SUPPORT_JAVA6 = "supportJava6";
     public static final String DISABLE_HTML_ESCAPING = "disableHtmlEscaping";
     public static final String ERROR_ON_UNKNOWN_ENUM = "errorOnUnknownEnum";
@@ -177,15 +178,15 @@ public AbstractJavaCodegen() {
                 .SERIALIZE_BIG_DECIMAL_AS_STRING_DESC));
         cliOptions.add(CliOption.newBoolean(FULL_JAVA_UTIL, "whether to use fully qualified name for classes under java.util. This option only works for Java API client"));
         cliOptions.add(new CliOption("hideGenerationTimestamp", "hides the timestamp when files were generated"));
-        cliOptions.add(CliOption.newBoolean(WITH_XML, "whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)"));
+        cliOptions.add(CliOption.newBoolean(CodegenConstants.WITH_XML, "whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML)"));
         if(this instanceof NotNullAnnotationFeatures){
             cliOptions.add(CliOption.newBoolean(NOT_NULL_JACKSON_ANNOTATION, "adds @JsonInclude(JsonInclude.Include.NON_NULL) annotation to model classes"));
         }
         if (this instanceof IgnoreUnknownJacksonFeatures){
             cliOptions.add(CliOption.newBoolean(IGNORE_UNKNOWN_JACKSON_ANNOTATION,
                 "adds @JsonIgnoreProperties(ignoreUnknown = true) annotation to model classes"));
         }
-        CliOption dateLibrary = new CliOption(DATE_LIBRARY, "Option. Date library to use");
+        CliOption dateLibrary = new CliOption(CodegenConstants.DATE_LIBRARY, "Option. Date library to use");
         Map<String, String> dateOptions = new HashMap<String, String>();
         dateOptions.put("java8", "Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets \"" + JAVA8_MODE + "\" to true");
         dateOptions.put("java11", "Java 11 native JSR384 (preferred for jdk 11+) - note: this also sets \"" + JAVA11_MODE + "\" to true");
@@ -411,10 +412,10 @@ public void processOpts() {
         additionalProperties.put(FULL_JAVA_UTIL, fullJavaUtil);
         additionalProperties.put("javaUtilPrefix", javaUtilPrefix);
 
-        if (additionalProperties.containsKey(WITH_XML)) {
-            this.setWithXml(Boolean.valueOf(additionalProperties.get(WITH_XML).toString()));
+        if (additionalProperties.containsKey(CodegenConstants.WITH_XML)) {
+            this.setWithXml(Boolean.valueOf(additionalProperties.get(CodegenConstants.WITH_XML).toString()));
         }
-        additionalProperties.put(WITH_XML, withXml);
+        additionalProperties.put(CodegenConstants.WITH_XML, withXml);
 
         if (additionalProperties.containsKey(ERROR_ON_UNKNOWN_ENUM)) {
             boolean errorOnUnknownEnum = Boolean.parseBoolean(additionalProperties.get(ERROR_ON_UNKNOWN_ENUM).toString());
@@ -484,14 +485,14 @@ public void processOpts() {
             }
         }
 
-        if (additionalProperties.containsKey(WITH_XML)) {
-            setWithXml(Boolean.parseBoolean(additionalProperties.get(WITH_XML).toString()));
+        if (additionalProperties.containsKey(CodegenConstants.WITH_XML)) {
+            setWithXml(Boolean.parseBoolean(additionalProperties.get(CodegenConstants.WITH_XML).toString()));
             if ( withXml ) {
-                additionalProperties.put(WITH_XML, "true");
+                additionalProperties.put(CodegenConstants.WITH_XML, "true");
             }
         }
 
-        if (additionalProperties.containsKey(DATE_LIBRARY)) {
+        if (additionalProperties.containsKey(CodegenConstants.DATE_LIBRARY)) {
             setDateLibrary(additionalProperties.get("dateLibrary").toString());
         } else if (java8Mode) {
             setDateLibrary("java8");
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/KotlinClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/KotlinClientCodegen.java
@@ -13,7 +13,9 @@
 
 public class KotlinClientCodegen extends AbstractKotlinCodegen {
 
-    public static final String DATE_LIBRARY = "dateLibrary";
+    /** @deprecated Use {@link CodegenConstants#DATE_LIBRARY} instead. */
+    @Deprecated
+    public static final String DATE_LIBRARY = CodegenConstants.DATE_LIBRARY;
     protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming = CodegenConstants.ENUM_PROPERTY_NAMING_TYPE.camelCase;
     static Logger LOGGER = LoggerFactory.getLogger(KotlinClientCodegen.class);
 
@@ -49,7 +51,7 @@ public KotlinClientCodegen() {
         apiPackage = packageName + ".apis";
         modelPackage = packageName + ".models";
 
-        CliOption dateLibrary = new CliOption(DATE_LIBRARY, "Option. Date library to use");
+        CliOption dateLibrary = new CliOption(CodegenConstants.DATE_LIBRARY, "Option. Date library to use");
         Map<String, String> dateOptions = new HashMap<>();
         dateOptions.put(DateLibrary.THREETENBP.value, "Threetenbp");
         dateOptions.put(DateLibrary.STRING.value, "String");
@@ -78,8 +80,8 @@ public void setDateLibrary(String library) {
     public void processOpts() {
         super.processOpts();
 
-        if (additionalProperties.containsKey(DATE_LIBRARY)) {
-            setDateLibrary(additionalProperties.get(DATE_LIBRARY).toString());
+        if (additionalProperties.containsKey(CodegenConstants.DATE_LIBRARY)) {
+            setDateLibrary(additionalProperties.get(CodegenConstants.DATE_LIBRARY).toString());
         }
 
         if (DateLibrary.THREETENBP.value.equals(dateLibrary)) {
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SpringCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/SpringCodegen.java
@@ -135,7 +135,7 @@ public void processOpts() {
         if (this.java8) {
             additionalProperties.put("javaVersion", "1.8");
             additionalProperties.put("jdk8", "true");
-            if (!additionalProperties.containsKey(DATE_LIBRARY)) {
+            if (!additionalProperties.containsKey(CodegenConstants.DATE_LIBRARY)) {
                 setDateLibrary("java8");
             }
         }
diff --git a/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/JavaOptionsProvider.java b/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/JavaOptionsProvider.java
@@ -70,11 +70,11 @@ public JavaOptionsProvider() {
                 .put(CodegenConstants.LOCAL_VARIABLE_PREFIX, LOCAL_PREFIX_VALUE)
                 .put(CodegenConstants.SERIALIZABLE_MODEL, SERIALIZABLE_MODEL_VALUE)
                 .put(JavaClientCodegen.FULL_JAVA_UTIL, FULL_JAVA_UTIL_VALUE)
-                .put(JavaClientCodegen.WITH_XML, WITH_XML_VALUE)
+                .put(CodegenConstants.WITH_XML, WITH_XML_VALUE)
                 .put(JavaClientCodegen.JAVA8_MODE, JAVA8_MODE_VALUE)
                 .put(JavaClientCodegen.JAVA11_MODE, JAVA11_MODE_VALUE)
                 .put(CodegenConstants.SERIALIZE_BIG_DECIMAL_AS_STRING, "true")
-                .put(JavaClientCodegen.DATE_LIBRARY, "joda")
+                .put(CodegenConstants.DATE_LIBRARY, "joda")
                 .put(JavaClientCodegen.DISABLE_HTML_ESCAPING, "false")
                 .put("hideGenerationTimestamp", "true")
                 .put(CodegenConstants.ALLOW_UNICODE_IDENTIFIERS, ALLOW_UNICODE_IDENTIFIERS_VALUE)
diff --git a/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/JaxRSServerOptionsProvider.java b/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/JaxRSServerOptionsProvider.java
@@ -60,7 +60,7 @@ public String getLanguage() {
     public Map<String, String> createOptions() {
         ImmutableMap.Builder<String, String> builder = new ImmutableMap.Builder<String, String>();
         builder.put(CodegenConstants.IMPL_FOLDER, IMPL_FOLDER_VALUE)
-            .put(JavaClientCodegen.DATE_LIBRARY, "joda") //java.lang.IllegalArgumentException: Multiple entries with same key: dateLibrary=joda and dateLibrary=joda
+            .put(CodegenConstants.DATE_LIBRARY, "joda") //java.lang.IllegalArgumentException: Multiple entries with same key: dateLibrary=joda and dateLibrary=joda
             .put("title", "Test title")
             .put(CodegenConstants.MODEL_PACKAGE, MODEL_PACKAGE_VALUE)
             .put(CodegenConstants.API_PACKAGE, API_PACKAGE_VALUE)
@@ -89,7 +89,7 @@ public Map<String, String> createOptions() {
             .put(CodegenConstants.SERIALIZE_BIG_DECIMAL_AS_STRING, "true")
             .put(JavaClientCodegen.JAVA8_MODE, JAVA8_MODE_VALUE)
             .put(JavaClientCodegen.JAVA11_MODE, JAVA11_MODE_VALUE)
-            .put(JavaClientCodegen.WITH_XML, WITH_XML_VALUE)
+            .put(CodegenConstants.WITH_XML, WITH_XML_VALUE)
             .put("hideGenerationTimestamp", "true")
             .put(JavaClientCodegen.DISABLE_HTML_ESCAPING, "false")
             .put(JavaCXFServerCodegen.USE_BEANVALIDATION, USE_BEANVALIDATION)
diff --git a/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/KotlinClientCodegenOptionsProvider.java b/modules/swagger-codegen/src/test/java/io/swagger/codegen/options/KotlinClientCodegenOptionsProvider.java
@@ -31,7 +31,7 @@ public Map<String, String> createOptions() {
                 .put(CodegenConstants.GROUP_ID, GROUP_ID)
                 .put(CodegenConstants.SOURCE_FOLDER, SOURCE_FOLDER)
                 .put(CodegenConstants.ENUM_PROPERTY_NAMING, ENUM_PROPERTY_NAMING)
-                .put(KotlinClientCodegen.DATE_LIBRARY, DATE_LIBRARY)
+                .put(CodegenConstants.DATE_LIBRARY, DATE_LIBRARY)
                 .build();
     }
 

Original file line number	Diff line number	Diff line change
`@@ -239,4 +239,6 @@ public static enum ENUM_PROPERTY_NAMING_TYPE {camelCase, PascalCase, snake_case,`
`239`	`239`	`public static final String INTERFACE_CONTROLLER = "interface-controller";`
`240`	`240`
`241`	`241`	`public static final String IGNORE_IMPORT_MAPPING_OPTION = "ignoreImportMappings";`
	`242`	`+`
	`243`	`+ public static final String DATE_LIBRARY = "dateLibrary";`
`242`	`244`	`}`
Original file line number	Diff line number	Diff line change
`@@ -135,7 +135,7 @@ public void processOpts() {`
`135`	`135`	`if (this.java8) {`
`136`	`136`	`additionalProperties.put("javaVersion", "1.8");`
`137`	`137`	`additionalProperties.put("jdk8", "true");`
`138`		`- if (!additionalProperties.containsKey(DATE_LIBRARY)) {`
	`138`	`+ if (!additionalProperties.containsKey(CodegenConstants.DATE_LIBRARY)) {`
`139`	`139`	`setDateLibrary("java8");`
`140`	`140`	`}`
`141`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public Map<String, String> createOptions() {`
`31`	`31`	`.put(CodegenConstants.GROUP_ID, GROUP_ID)`
`32`	`32`	`.put(CodegenConstants.SOURCE_FOLDER, SOURCE_FOLDER)`
`33`	`33`	`.put(CodegenConstants.ENUM_PROPERTY_NAMING, ENUM_PROPERTY_NAMING)`
`34`		`- .put(KotlinClientCodegen.DATE_LIBRARY, DATE_LIBRARY)`
	`34`	`+ .put(CodegenConstants.DATE_LIBRARY, DATE_LIBRARY)`
`35`	`35`	`.build();`
`36`	`36`	`}`
`37`	`37`