Skip to content

Make PropertyNamingStrategy skip renaming on Enums #4311

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.

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
merged 4 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions release-notes/CREDITS-2.x
Original file line number Diff line number Diff line change
Expand Up @@ -1728,3 +1728,8 @@ Jan Pachol (janpacho@github)
* Reported #4175: Exception when deserialization of `private` record with
default constructor
(2.16.0)

Pieter Dirk Soels (Badbond@github)
* Reprted #4302: Problem deserializing some type of Enums when using
`PropertyNamingStrategy`
(2.16.2)
3 changes: 3 additions & 0 deletions release-notes/VERSION-2.x
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Project: jackson-databind

2.16.2 (not yet released)

#4302: Problem deserializing some type of Enums when using `PropertyNamingStrategy`
(reported by Pieter D-S)
(fix contributed by Joo-Hyuk K)
#4303: `ObjectReader` is not serializable if it's configured for polymorphism
(reported by @asardaes)
(fix contributed by Joo-Hyuk K)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1128,6 +1128,10 @@ protected void _renameUsing(Map<String, POJOPropertyBuilder> propMap,
for (POJOPropertyBuilder prop : props) {
PropertyName fullName = prop.getFullName();
String rename = null;
// [databind#4302] since 2.17, Need to skip renaming for Enum properties
if (!prop.hasSetter() && prop.getPrimaryType().isEnumType()) {
continue;
}
// As per [databind#428] need to skip renaming if property has
// explicitly defined name, unless feature is enabled
if (!prop.isExplicitlyNamed() || _config.isEnabled(MapperFeature.ALLOW_EXPLICIT_PROPERTY_RENAMING)) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
package com.fasterxml.jackson.databind.deser.enums;

import org.junit.jupiter.api.Test;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;

import static org.junit.jupiter.api.Assertions.assertEquals;

import static com.fasterxml.jackson.databind.BaseMapTest.jsonMapperBuilder;
import static com.fasterxml.jackson.databind.BaseTest.q;

// [databind#4302]
public class EnumSameName4302Test
{

enum Field4302Enum {
FOO(0);

public final int foo;

Field4302Enum(int foo) {
this.foo = foo;
}
}

enum Getter4302Enum {
BAR("bar");

public String bar;

Getter4302Enum(String bar) {
this.bar = bar;
}

public String getBar() {
return "bar";
}
}

enum Setter4302Enum {
CAT("dog");

public String cat;

Setter4302Enum(String cat) {
this.cat = cat;
}

public void setCat(String cat) {
this.cat = cat;
}
}

private final ObjectMapper MAPPER = jsonMapperBuilder()
.propertyNamingStrategy(PropertyNamingStrategies.LOWER_CASE)
.build();

@Test
void testShouldWork() throws Exception
{
// First, try roundtrip with same-ignore-case name field
assertEquals(Field4302Enum.FOO,
MAPPER.readValue("\"FOO\"", Field4302Enum.class));
assertEquals(q("FOO"),
MAPPER.writeValueAsString(Field4302Enum.FOO));

// Now, try roundtrip with same-ignore-case name getter
assertEquals(Getter4302Enum.BAR,
MAPPER.readValue("\"BAR\"", Getter4302Enum.class));
assertEquals(q("BAR"),
MAPPER.writeValueAsString(Getter4302Enum.BAR));

// Now, try roundtrip with same-ignore-case name setter
Setter4302Enum.CAT.setCat("cat");
assertEquals(Setter4302Enum.CAT,
MAPPER.readValue("\"CAT\"", Setter4302Enum.class));
assertEquals(q("CAT"),
MAPPER.writeValueAsString(Setter4302Enum.CAT));
}
}