Skip to content

[Java][RestClient][WebClient] refactor: use CollectionFormat helper method in query generation #24781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 1 commit into from
Aug 26, 2026
Merged

[Java][RestClient][WebClient] refactor: use CollectionFormat helper method in query generation #24781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/openapi-generator/src/main/resources/Java/libraries/restclient/ApiClient.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,12 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -648,7 +648,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions modules/openapi-generator/src/main/resources/Java/libraries/webclient/ApiClient.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,12 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -549,7 +549,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions samples/client/echo_api/java/restclient/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -495,7 +495,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...rs/java/restclient-enum-in-multipart/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -494,7 +494,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...hers/java/restclient-sealedInterface/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -493,7 +493,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...va/restclient-useAbstractionForFiles/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -493,7 +493,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...thers/java/webclient-sealedInterface/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -384,7 +384,7 @@
/**
* Parse the given string into Date object.
*/
public Date parseDate(String str) {

Check warning on line 387 in samples/client/others/java/webclient-sealedInterface/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/others/java/webclient-sealedInterface)

Check warning on line 387 in samples/client/others/java/webclient-sealedInterface/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/others/java/webclient-sealedInterface) 

no @PARAM for str
try {
return dateFormat.parse(str);
} catch (ParseException e) {
Expand Down Expand Up @@ -468,7 +468,7 @@
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...s/java/webclient-sealedInterface_3_1/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -384,7 +384,7 @@
/**
* Parse the given string into Date object.
*/
public Date parseDate(String str) {

Check warning on line 387 in samples/client/others/java/webclient-sealedInterface_3_1/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/others/java/webclient-sealedInterface_3_1)

Check warning on line 387 in samples/client/others/java/webclient-sealedInterface_3_1/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/others/java/webclient-sealedInterface_3_1) 

no @PARAM for str
try {
return dateFormat.parse(str);
} catch (ParseException e) {
Expand Down Expand Up @@ -468,7 +468,7 @@
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...ava/webclient-useAbstractionForFiles/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -468,7 +468,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...tore/java/restclient-nullable-arrays/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -493,7 +493,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...java/restclient-springBoot4-jackson2/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -164,10 +164,10 @@
public static RestClient.Builder buildRestClientBuilder(ObjectMapper mapper) {

Consumer<List<HttpMessageConverter<?>>> messageConverters = converters -> {
converters.add(0, new MappingJackson2HttpMessageConverter(mapper));

Check warning on line 167 in samples/client/petstore/java/restclient-springBoot4-jackson2/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/petstore/java/restclient-springBoot4-jackson2) 

[removal] MappingJackson2HttpMessageConverter in org.springframework.http.converter.json has been deprecated and marked for removal

Check warning on line 167 in samples/client/petstore/java/restclient-springBoot4-jackson2/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/petstore/java/restclient-springBoot4-jackson2) 

org.springframework.http.converter.json.MappingJackson2HttpMessageConverter in org.springframework.http.converter.json has been deprecated and marked for removal
};

return RestClient.builder().messageConverters(messageConverters);

Check warning on line 170 in samples/client/petstore/java/restclient-springBoot4-jackson2/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/petstore/java/restclient-springBoot4-jackson2) 

[removal] messageConverters(Consumer<List<HttpMessageConverter<?>>>) in Builder has been deprecated and marked for removal

Check warning on line 170 in samples/client/petstore/java/restclient-springBoot4-jackson2/src/main/java/org/openapitools/client/ApiClient.java

View workflow job for this annotation

GitHub Actions / Build Java Client JDK17 (samples/client/petstore/java/restclient-springBoot4-jackson2) 

messageConverters(java.util.function.Consumer<java.util.List<org.springframework.http.converter.HttpMessageConverter<?>>>) in org.springframework.web.client.RestClient.Builder has been deprecated and marked for removal
}

/**
Expand Down Expand Up @@ -519,7 +519,7 @@
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...t4-jackson3-jspecify-openapiNullable/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -491,7 +491,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...client-springBoot4-jackson3-jspecify/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -489,7 +489,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...java/restclient-springBoot4-jackson3/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -515,7 +515,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...nt/petstore/java/restclient-swagger2/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -566,7 +566,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
6 changes: 3 additions & 3 deletions ...ent-useSingleRequestParameter-static/src/main/java/org/openapitools/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,12 @@ public class ApiClient extends JavaTimeFormatter {
public enum CollectionFormat {
CSV(","), TSV("\t"), SSV(" "), PIPES("|"), MULTI(null);

protected final String separator;
private final String separator;
CollectionFormat(String separator) {
this.separator = separator;
}

protected String collectionToString(Collection<?> collection) {
public String collectionToString(Collection<?> collection) {
return StringUtils.collectionToDelimitedString(collection, separator);
}
}
Expand Down Expand Up @@ -566,7 +566,7 @@ public MultiValueMap<String, String> parameterToMultiValueMapJson(CollectionForm
throw exceptionProvider.jacksonException(e);
}
}
return parameterToMultiValueMap(collectionFormat, name, "[" + StringUtils.collectionToDelimitedString(values, collectionFormat.separator) + "]");
return parameterToMultiValueMap(collectionFormat, name, "[" + collectionFormat.collectionToString(values) + "]");
}

/**
Expand Down
Loading
Loading