Apache
/
commons-csv
mirror of https://github.com/apache/commons-csv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[CSV-269] CSVRecord.get(Enum) should use Enum.name() instead of 

Enum.toString().
This commit is contained in:
Gary Gregory 2022-02-19 12:36:24 -05:00
parent 9e687fff30
commit c158188597
3 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -43,6 +43,7 @@
<action type="fix" dev="ggregory" due-to="Arturo Bernal">Minor changes #172.</action>
<action issue="CSV-292" type="fix" dev="kinow" due-to="Rob Vesse">No Automatic-Module-Name prevents usage in JPMS projects without repacking the JAR.</action>
<action issue="CSV-288" type="fix" dev="ggregory" due-to="Santhsoh, Angus">Fix for multi-char delimiter not working as expected #218.</action>
<action issue="CSV-269" type="fix" dev="ggregory" due-to="Auke te Winkel, Gary Gregory">CSVRecord.get(Enum) should use Enum.name() instead of Enum.toString().</action>
<!-- ADD -->
<action issue="CSV-291" type="add" dev="ggregory" due-to="Gary Gregory">Make CSVRecord#values() public.</action>
<action issue="CSV-264" type="add" dev="ggregory" due-to="Sagar Tiwari, Seth Falco, Alex Herbert, Gary Gregory">Add DuplicateHeaderMode for flexibility with header strictness. #114.</action>

3
src/main/java/org/apache/commons/csv/CSVRecord.java
View File

@ -23,7 +23,6 @@ import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Stream;
/**
@ -73,7 +72,7 @@ public final class CSVRecord implements Serializable, Iterable<String> {
* @return the String at the given enum String
*/
public String get(final Enum<?> e) {
return get(Objects.toString(e, null));
return get(e == null ? null : e.name());
}
/**

36
src/test/java/org/apache/commons/csv/CSVRecordTest.java
View File

@ -30,12 +30,14 @@ import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.AtomicInteger;
import org.apache.commons.lang3.EnumUtils;
import org.apache.commons.lang3.StringUtils;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
@ -46,6 +48,7 @@ public class CSVRecordTest {
UNKNOWN_COLUMN
}
/** This enum overrides toString() but it's the names that matter. */
public enum EnumHeader {
FIRST("first"),
SECOND("second"),
@ -69,13 +72,12 @@ public class CSVRecordTest {
@BeforeEach
public void setUp() throws Exception {
values = new String[] { "A", "B", "C" };
values = new String[] {"A", "B", "C"};
final String rowData = StringUtils.join(values, ',');
try (final CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(rowData))) {
record = parser.iterator().next();
}
final String[] headers = { "first", "second", "third" };
try (final CSVParser parser = CSVFormat.DEFAULT.withHeader(headers).parse(new StringReader(rowData))) {
try (final CSVParser parser = CSVFormat.DEFAULT.builder().setHeader(EnumHeader.class).build().parse(new StringReader(rowData))) {
recordWithHeader = parser.iterator().next();
headerMap = parser.getHeaderMap();
}
@ -103,9 +105,9 @@ public class CSVRecordTest {
@Test
public void testGetString() {
assertEquals(values[0], recordWithHeader.get("first"));
assertEquals(values[1], recordWithHeader.get("second"));
assertEquals(values[2], recordWithHeader.get("third"));
assertEquals(values[0], recordWithHeader.get(EnumHeader.FIRST.name()));
assertEquals(values[1], recordWithHeader.get(EnumHeader.SECOND.name()));
assertEquals(values[2], recordWithHeader.get(EnumHeader.THIRD.name()));
}
@Test
@ -141,8 +143,8 @@ public class CSVRecordTest {
@Test
public void testGetWithEnum() {
assertEquals(recordWithHeader.get("first"), recordWithHeader.get(EnumHeader.FIRST));
assertEquals(recordWithHeader.get("second"), recordWithHeader.get(EnumHeader.SECOND));
assertEquals(recordWithHeader.get("FIRST"), recordWithHeader.get(EnumHeader.FIRST));
assertEquals(recordWithHeader.get("SECOND"), recordWithHeader.get(EnumHeader.SECOND));
assertThrows(IllegalArgumentException.class, () -> recordWithHeader.get(EnumFixture.UNKNOWN_COLUMN));
}
@ -171,7 +173,7 @@ public class CSVRecordTest {
@Test
public void testIsMapped() {
assertFalse(record.isMapped("first"));
assertTrue(recordWithHeader.isMapped("first"));
assertTrue(recordWithHeader.isMapped(EnumHeader.FIRST.name()));
assertFalse(recordWithHeader.isMapped("fourth"));
}
@ -188,8 +190,8 @@ public class CSVRecordTest {
@Test
public void testIsSetString() {
assertFalse(record.isSet("first"));
assertTrue(recordWithHeader.isSet("first"));
assertFalse(recordWithHeader.isSet("fourth"));
assertTrue(recordWithHeader.isSet(EnumHeader.FIRST.name()));
assertFalse(recordWithHeader.isSet("DOES NOT EXIST"));
}
@Test
@ -315,16 +317,16 @@ public class CSVRecordTest {
}
private void validateMap(final Map<String, String> map, final boolean allowsNulls) {
assertTrue(map.containsKey("first"));
assertTrue(map.containsKey("second"));
assertTrue(map.containsKey("third"));
assertTrue(map.containsKey(EnumHeader.FIRST.name()));
assertTrue(map.containsKey(EnumHeader.SECOND.name()));
assertTrue(map.containsKey(EnumHeader.THIRD.name()));
assertFalse(map.containsKey("fourth"));
if (allowsNulls) {
assertFalse(map.containsKey(null));
}
assertEquals("A", map.get("first"));
assertEquals("B", map.get("second"));
assertEquals("C", map.get("third"));
assertEquals("A", map.get(EnumHeader.FIRST.name()));
assertEquals("B", map.get(EnumHeader.SECOND.name()));
assertEquals("C", map.get(EnumHeader.THIRD.name()));
assertNull(map.get("fourth"));
}
}