clean up

Author: cowtowncoder

csv/src/main/java/com/fasterxml/jackson/dataformat/csv/CsvGenerator.java

@@ -8,7 +8,6 @@
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.core.base.GeneratorBase;
 import com.fasterxml.jackson.core.io.CharacterEscapes;
-import com.fasterxml.jackson.core.json.JsonWriteContext;
 import com.fasterxml.jackson.core.io.IOContext;
 import com.fasterxml.jackson.dataformat.csv.impl.CsvEncoder;
 import com.fasterxml.jackson.dataformat.csv.impl.SimpleTokenWriteContext;
@@ -166,7 +165,7 @@ private Feature(boolean defaultState) {
      *
      * @since 2.11
      */
-    protected SimpleTokenWriteContext _csvWriteContext;
+    protected SimpleTokenWriteContext _tokenWriteContext;
 
     protected CharacterEscapes _characterEscapes = null;
 
@@ -244,7 +243,8 @@ public CsvGenerator(IOContext ctxt, int jsonFeatures, int csvFeatures,
         _formatFeatures = csvFeatures;
         _schema = schema;
         _writer = new CsvEncoder(ctxt, csvFeatures, out, schema);
-        _csvWriteContext = SimpleTokenWriteContext.createRootContext(null);
+        _writeContext = null; // just to make sure it won't be used
+        _tokenWriteContext = SimpleTokenWriteContext.createRootContext(null);
         _writer.setOutputEscapes(CsvCharacterEscapes.fromCsvFeatures(csvFeatures).getEscapeCodesForAscii());
     }
 
@@ -255,7 +255,8 @@ public CsvGenerator(IOContext ctxt, int jsonFeatures, int csvFeatures,
         _ioContext = ctxt;
         _formatFeatures = csvFeatures;
         _writer = csvWriter;
-        _csvWriteContext = SimpleTokenWriteContext.createRootContext(null);
+        _writeContext = null; // just to make sure it won't be used
+        _tokenWriteContext = SimpleTokenWriteContext.createRootContext(null);
     }
 
     /*                                                                                       
@@ -310,7 +311,7 @@ public int getOutputBuffered() {
 
     @Override
     public SimpleTokenWriteContext getOutputContext() {
-        return _csvWriteContext;
+        return _tokenWriteContext;
     }
 
     @Override
@@ -395,7 +396,7 @@ public boolean canOmitFields() {
     @Override
     public final void writeFieldName(String name) throws IOException
     {
-        if (!_csvWriteContext.writeFieldName(name)) {
+        if (!_tokenWriteContext.writeFieldName(name)) {
             _reportError("Can not write a field name, expecting a value");
         }
         _writeFieldName(name);
@@ -405,7 +406,7 @@ public final void writeFieldName(String name) throws IOException
     public final void writeFieldName(SerializableString name) throws IOException
     {
         // Object is a value, need to verify it's allowed
-        if (!_csvWriteContext.writeFieldName(name.getValue())) {
+        if (!_tokenWriteContext.writeFieldName(name.getValue())) {
             _reportError("Can not write a field name, expecting a value");
         }
         _writeFieldName(name.getValue());
@@ -507,10 +508,10 @@ public final void writeStartArray() throws IOException
         _verifyValueWrite("start an array");
         // Ok to create root-level array to contain Objects/Arrays, but
         // can not nest arrays in objects
-        if (_csvWriteContext.inObject()) {
+        if (_tokenWriteContext.inObject()) {
             if ((_skipWithin == null)
                     && _skipValue && isEnabled(JsonGenerator.Feature.IGNORE_UNKNOWN)) {
-                _skipWithin = _csvWriteContext;
+                _skipWithin = _tokenWriteContext;
             } else if (!_skipValue) {
                 // First: column may have its own separator
                 String sep;
@@ -540,20 +541,20 @@ && _skipValue && isEnabled(JsonGenerator.Feature.IGNORE_UNKNOWN)) {
                 _reportError("CSV generator does not support nested Array values");
             }
         }
-        _csvWriteContext = _csvWriteContext.createChildArrayContext(null);
+        _tokenWriteContext = _tokenWriteContext.createChildArrayContext(null);
         // and that's about it, really
     }
 
     @Override
     public final void writeEndArray() throws IOException
     {
-        if (!_csvWriteContext.inArray()) {
-            _reportError("Current context not Array but "+_csvWriteContext.typeDesc());
+        if (!_tokenWriteContext.inArray()) {
+            _reportError("Current context not Array but "+_tokenWriteContext.typeDesc());
         }
-        _csvWriteContext = _csvWriteContext.getParent();
+        _tokenWriteContext = _tokenWriteContext.getParent();
         // 14-Dec-2015, tatu: To complete skipping of ignored structured value, need this:
         if (_skipWithin != null) {
-            if (_csvWriteContext == _skipWithin) {
+            if (_tokenWriteContext == _skipWithin) {
                 _skipWithin = null;
             }
             return;
@@ -564,7 +565,7 @@ public final void writeEndArray() throws IOException
         }
         // 20-Nov-2014, tatu: When doing "untyped"/"raw" output, this means that row
         //    is now done. But not if writing such an array field, so:
-        if (!_csvWriteContext.inObject()) {
+        if (!_tokenWriteContext.inObject()) {
             finishRow();
         }
     }
@@ -575,30 +576,30 @@ public final void writeStartObject() throws IOException
         _verifyValueWrite("start an object");
         // No nesting for objects; can write Objects inside logical root-level arrays.
         // 14-Dec-2015, tatu: ... except, should be fine if we are ignoring the property
-        if (_csvWriteContext.inObject() ||
+        if (_tokenWriteContext.inObject() ||
                 // 07-Nov-2017, tatu: But we may actually be nested indirectly; so check
-                (_csvWriteContext.inArray() && !_csvWriteContext.getParent().inRoot())) {
+                (_tokenWriteContext.inArray() && !_tokenWriteContext.getParent().inRoot())) {
             if (_skipWithin == null) { // new in 2.7
                 if (_skipValue && isEnabled(JsonGenerator.Feature.IGNORE_UNKNOWN)) {
-                    _skipWithin = _csvWriteContext;
+                    _skipWithin = _tokenWriteContext;
                 } else {
                     _reportMappingError("CSV generator does not support Object values for properties (nested Objects)");
                 }
             }
         }
-        _csvWriteContext = _csvWriteContext.createChildObjectContext(null);
+        _tokenWriteContext = _tokenWriteContext.createChildObjectContext(null);
     }
 
     @Override
     public final void writeEndObject() throws IOException
     {
-        if (!_csvWriteContext.inObject()) {
-            _reportError("Current context not Object but "+_csvWriteContext.typeDesc());
+        if (!_tokenWriteContext.inObject()) {
+            _reportError("Current context not Object but "+_tokenWriteContext.typeDesc());
         }
-        _csvWriteContext = _csvWriteContext.getParent();
+        _tokenWriteContext = _tokenWriteContext.getParent();
         // 14-Dec-2015, tatu: To complete skipping of ignored structured value, need this:
         if (_skipWithin != null) {
-            if (_csvWriteContext == _skipWithin) {
+            if (_tokenWriteContext == _skipWithin) {
                 _skipWithin = null;
             }
             return;
@@ -775,16 +776,16 @@ public void writeNull() throws IOException
         if (!_skipValue) {
             if (!_arraySeparator.isEmpty()) {
                 _addToArray(_schema.getNullValueOrEmpty());
-            } else if (_csvWriteContext.inObject()) {
+            } else if (_tokenWriteContext.inObject()) {
                 _writer.writeNull(_columnIndex());
-            } else if (_csvWriteContext.inArray()) {
+            } else if (_tokenWriteContext.inArray()) {
                 // [dataformat-csv#106]: Need to make sure we don't swallow nulls in arrays either
                 // 04-Jan-2016, tatu: but check for case of array-wrapping, in which case null stands for absence
                 //   of Object. In this case, could either add an empty row, or skip -- for now, we'll
                 //   just skip; can change, if so desired, to expose "root null" as empty rows, possibly
                 //   based on either schema property, or CsvGenerator.Feature.
                 //  Note: if nulls are to be written that way, would need to call `finishRow()` right after `writeNull()`
-                if (!_csvWriteContext.getParent().inRoot()) {
+                if (!_tokenWriteContext.getParent().inRoot()) {
                     _writer.writeNull(_columnIndex());
                 }
 
@@ -924,7 +925,7 @@ public void writeOmittedField(String fieldName) throws IOException
             // assumed to have been removed from schema too
         } else {
             // basically combination of "writeFieldName()" and "writeNull()"
-            if (!_csvWriteContext.writeFieldName(fieldName)) {
+            if (!_tokenWriteContext.writeFieldName(fieldName)) {
                 _reportError("Can not skip a field, expecting a value");
             }
             // and all we do is just note index to use for following value write
@@ -944,7 +945,7 @@ public void writeOmittedField(String fieldName) throws IOException
     @Override
     protected final void _verifyValueWrite(String typeMsg) throws IOException
     {
-        if (!_csvWriteContext.writeValue()) {
+        if (!_tokenWriteContext.writeValue()) {
             _reportError("Can not "+typeMsg+", expecting field name");
         }
         if (_handleFirstLine) {

csv/src/test/java/com/fasterxml/jackson/dataformat/csv/ser/TestGenerator.java

@@ -56,7 +56,7 @@ public void testSimpleExplicit() throws Exception
 
         // from base, default order differs:
         // @JsonPropertyOrder({"firstName", "lastName", "gender" ,"verified", "userImage"})
-        
+
         FiveMinuteUser user = new FiveMinuteUser("Silu", "Seppala", false, Gender.MALE,
                 new byte[] { 1, 2, 3, 4, 5});
         String csv = mapper.writer(schema).writeValueAsString(user);
@@ -74,10 +74,9 @@ public void testWriteHeaders() throws Exception
         CsvMapper mapper = mapperForCsv();
         CsvSchema schema = mapper.schemaFor(FiveMinuteUser.class).withHeader();
         FiveMinuteUser user = new FiveMinuteUser("Barbie", "Benton", false, Gender.FEMALE, null);
-        String result = mapper.writer(schema).writeValueAsString(user);        
+        String result = mapper.writer(schema).writeValueAsString(user);
         assertEquals("firstName,lastName,gender,verified,userImage\n"
                 +"Barbie,Benton,FEMALE,false,\n", result);
-        
     }
 
     /**
@@ -90,7 +89,7 @@ public void testFailedWriteHeaders() throws Exception
         CsvSchema schema = CsvSchema.builder().setUseHeader(true).build();
         FiveMinuteUser user = new FiveMinuteUser("Barbie", "Benton", false, Gender.FEMALE, null);
         try {
-            mapper.writer(schema).writeValueAsString(user);        
+            mapper.writer(schema).writeValueAsString(user);
             fail("Should fail without columns");
         } catch (JsonMappingException e) {
             verifyException(e, "contains no column names");
@@ -148,7 +147,7 @@ public void testLongerWithQuotes() throws Exception
 
         String base = "Longer sequence with bunch of words to test quoting with needs to be at least one line "
                 +"long to allow for appropriate indexes and boundary crossing conditions as well";
-        
+
         StringBuilder sb = new StringBuilder();
         do {
             for (String word : base.split("\\s")) {
@@ -333,9 +332,9 @@ private void _testSimpleWithAutoSchema(boolean wrapAsArray) throws Exception
         String result;
         // having virtual root-level array should make no difference:
         if (wrapAsArray) {
-            result = mapper.writer(schema).writeValueAsString(new FiveMinuteUser[] { user });        
+            result = mapper.writer(schema).writeValueAsString(new FiveMinuteUser[] { user });
         } else {
-            result = mapper.writer(schema).writeValueAsString(user);        
+            result = mapper.writer(schema).writeValueAsString(user);
         }
         assertEquals("Veltto,Virtanen,MALE,true,AwE=\n", result);
     }