Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.fasterxml.jackson.dataformat.csv
Class CsvGenerator

java.lang.Object
  extended by com.fasterxml.jackson.core.JsonGenerator
      extended by com.fasterxml.jackson.core.base.GeneratorBase
          extended by com.fasterxml.jackson.dataformat.csv.CsvGenerator
All Implemented Interfaces:
Versioned, Closeable
public class CsvGenerator
extends GeneratorBase

Nested Class Summary
static class CsvGenerator.Feature
          Enumeration that defines all togglable features for CSV writers (if any: currently none)
 
Field Summary
protected  int _csvFeatures
          Bit flag composed of bits that indicate which CsvGenerator.Features are enabled.
protected  boolean _handleFirstLine
          Flag that indicates that we need to write header line, if one is needed.
protected  IOContext _ioContext
           
protected  int _nextColumnByName
          Index of column that we will be getting next, based on field name call that was made.
protected  CsvSchema _schema
          Definition of columns being written, if available.
protected  CsvWriter _writer
           
protected static long MAX_INT_AS_LONG
           
protected static long MIN_INT_AS_LONG
           
 
Fields inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_cfgNumbersAsStrings, _closed, _features, _objectCodec, _writeContext
 
Fields inherited from class com.fasterxml.jackson.core.JsonGenerator
_cfgPrettyPrinter
 
Constructor Summary
CsvGenerator(IOContext ctxt, int jsonFeatures, int csvFeatures, ObjectCodec codec, Writer out, char columnSeparator, char quoteChar, char[] linefeed)
           
 
Method Summary
protected  int _columnIndex()
           
protected  void _handleFirstLine()
           
protected  void _releaseBuffers()
           
protected  void _verifyValueWrite(String typeMsg)
           
 boolean canUseSchema(FormatSchema schema)
           
 void close()
           
 CsvGenerator configure(CsvGenerator.Feature f, boolean state)
           
 CsvGenerator disable(CsvGenerator.Feature f)
           
 CsvGenerator enable(CsvGenerator.Feature f)
           
protected  void finishRow()
          Method called when the current row is complete; typically will flush possibly buffered column values, append linefeed and reset state appropriately.
 void flush()
           
 Object getOutputTarget()
           
 boolean isEnabled(CsvGenerator.Feature f)
           
 CsvGenerator setPrettyPrinter(PrettyPrinter pp)
          No way (or need) to indent anything, so let's block any attempts.
 void setSchema(FormatSchema schema)
           
 CsvGenerator useDefaultPrettyPrinter()
          No way (or need) to indent anything, so let's block any attempts.
 Version version()
           
 void writeBinary(Base64Variant b64variant, byte[] data, int offset, int len)
           
 void writeBoolean(boolean state)
           
 void writeEndArray()
           
 void writeEndObject()
           
 void writeFieldName(SerializableString name)
           
 void writeFieldName(String name)
           
 void writeNull()
           
 void writeNumber(BigDecimal dec)
           
 void writeNumber(BigInteger v)
           
 void writeNumber(double d)
           
 void writeNumber(float f)
           
 void writeNumber(int i)
           
 void writeNumber(long l)
           
 void writeNumber(String encodedValue)
           
 void writeRaw(char c)
           
 void writeRaw(char[] text, int offset, int len)
           
 void writeRaw(String text)
           
 void writeRaw(String text, int offset, int len)
           
 void writeRawUTF8String(byte[] text, int offset, int len)
           
 void writeRawValue(char[] text, int offset, int len)
           
 void writeRawValue(String text)
           
 void writeRawValue(String text, int offset, int len)
           
 void writeStartArray()
           
 void writeStartObject()
           
 void writeString(char[] text, int offset, int len)
           
 void writeString(SerializableString sstr)
           
 void writeString(String text)
           
 void writeStringField(String fieldName, String value)
           
 void writeUTF8String(byte[] text, int offset, int len)
           
 
Methods inherited from class com.fasterxml.jackson.core.base.GeneratorBase
_cantHappen, _reportError, _reportUnsupportedOperation, _throwInternal, _writeSimpleObject, copyCurrentEvent, copyCurrentStructure, disable, enable, getCodec, getOutputContext, isClosed, isEnabled, setCodec, writeObject, writeTree
 
Methods inherited from class com.fasterxml.jackson.core.JsonGenerator
configure, getCharacterEscapes, getHighestEscapedChar, getSchema, setCharacterEscapes, setHighestNonEscapedChar, writeArrayFieldStart, writeBinary, writeBinary, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MIN_INT_AS_LONG

protected static final long MIN_INT_AS_LONG
See Also:
Constant Field Values

MAX_INT_AS_LONG

protected static final long MAX_INT_AS_LONG
See Also:
Constant Field Values

_ioContext

protected final IOContext _ioContext

_csvFeatures

protected int _csvFeatures
Bit flag composed of bits that indicate which CsvGenerator.Features are enabled.

_schema

protected CsvSchema _schema
Definition of columns being written, if available.

_writer

protected final CsvWriter _writer

_handleFirstLine

protected boolean _handleFirstLine
Flag that indicates that we need to write header line, if one is needed. Used because schema may be specified after instance is constructed.

_nextColumnByName

protected int _nextColumnByName
Index of column that we will be getting next, based on field name call that was made.

Constructor Detail

CsvGenerator

public CsvGenerator(IOContext ctxt,
                    int jsonFeatures,
                    int csvFeatures,
                    ObjectCodec codec,
                    Writer out,
                    char columnSeparator,
                    char quoteChar,
                    char[] linefeed)
Method Detail

version

public Version version()
Specified by:
version in interface Versioned
Overrides:
version in class GeneratorBase

useDefaultPrettyPrinter

public CsvGenerator useDefaultPrettyPrinter()
No way (or need) to indent anything, so let's block any attempts. (should we throw an exception instead?)

Overrides:
useDefaultPrettyPrinter in class GeneratorBase

setPrettyPrinter

public CsvGenerator setPrettyPrinter(PrettyPrinter pp)
No way (or need) to indent anything, so let's block any attempts. (should we throw an exception instead?)

Overrides:
setPrettyPrinter in class JsonGenerator

getOutputTarget

public Object getOutputTarget()
Overrides:
getOutputTarget in class JsonGenerator

canUseSchema

public boolean canUseSchema(FormatSchema schema)
Overrides:
canUseSchema in class JsonGenerator

setSchema

public void setSchema(FormatSchema schema)
Overrides:
setSchema in class JsonGenerator

writeFieldName

public final void writeFieldName(String name)
                          throws IOException,
                                 JsonGenerationException
Specified by:
writeFieldName in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeFieldName

public final void writeFieldName(SerializableString name)
                          throws IOException,
                                 JsonGenerationException
Overrides:
writeFieldName in class GeneratorBase
Throws:
IOException
JsonGenerationException

writeStringField

public final void writeStringField(String fieldName,
                                   String value)
                            throws IOException,
                                   JsonGenerationException
Overrides:
writeStringField in class JsonGenerator
Throws:
IOException
JsonGenerationException

enable

public CsvGenerator enable(CsvGenerator.Feature f)

disable

public CsvGenerator disable(CsvGenerator.Feature f)

isEnabled

public final boolean isEnabled(CsvGenerator.Feature f)

configure

public CsvGenerator configure(CsvGenerator.Feature f,
                              boolean state)

flush

public final void flush()
                 throws IOException
Specified by:
flush in class GeneratorBase
Throws:
IOException

close

public void close()
           throws IOException
Specified by:
close in interface Closeable
Overrides:
close in class GeneratorBase
Throws:
IOException

writeStartArray

public final void writeStartArray()
                           throws IOException,
                                  JsonGenerationException
Specified by:
writeStartArray in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeEndArray

public final void writeEndArray()
                         throws IOException,
                                JsonGenerationException
Specified by:
writeEndArray in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeStartObject

public final void writeStartObject()
                            throws IOException,
                                   JsonGenerationException
Specified by:
writeStartObject in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeEndObject

public final void writeEndObject()
                          throws IOException,
                                 JsonGenerationException
Specified by:
writeEndObject in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeString

public void writeString(String text)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeString in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeString

public void writeString(char[] text,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeString in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeString

public final void writeString(SerializableString sstr)
                       throws IOException,
                              JsonGenerationException
Overrides:
writeString in class GeneratorBase
Throws:
IOException
JsonGenerationException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
                               int offset,
                               int len)
                        throws IOException,
                               JsonGenerationException
Specified by:
writeRawUTF8String in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeUTF8String

public final void writeUTF8String(byte[] text,
                                  int offset,
                                  int len)
                           throws IOException,
                                  JsonGenerationException
Specified by:
writeUTF8String in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRaw

public void writeRaw(String text)
              throws IOException,
                     JsonGenerationException
Specified by:
writeRaw in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRaw

public void writeRaw(String text,
                     int offset,
                     int len)
              throws IOException,
                     JsonGenerationException
Specified by:
writeRaw in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRaw

public void writeRaw(char[] text,
                     int offset,
                     int len)
              throws IOException,
                     JsonGenerationException
Specified by:
writeRaw in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRaw

public void writeRaw(char c)
              throws IOException,
                     JsonGenerationException
Specified by:
writeRaw in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeRawValue

public void writeRawValue(String text)
                   throws IOException,
                          JsonGenerationException
Overrides:
writeRawValue in class GeneratorBase
Throws:
IOException
JsonGenerationException

writeRawValue

public void writeRawValue(String text,
                          int offset,
                          int len)
                   throws IOException,
                          JsonGenerationException
Overrides:
writeRawValue in class GeneratorBase
Throws:
IOException
JsonGenerationException

writeRawValue

public void writeRawValue(char[] text,
                          int offset,
                          int len)
                   throws IOException,
                          JsonGenerationException
Overrides:
writeRawValue in class GeneratorBase
Throws:
IOException
JsonGenerationException

writeBinary

public void writeBinary(Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeBinary in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeBoolean

public void writeBoolean(boolean state)
                  throws IOException,
                         JsonGenerationException
Specified by:
writeBoolean in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNull

public void writeNull()
               throws IOException,
                      JsonGenerationException
Specified by:
writeNull in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNumber

public void writeNumber(int i)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeNumber in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNumber

public void writeNumber(long l)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeNumber in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNumber

public void writeNumber(BigInteger v)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeNumber in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNumber

public void writeNumber(double d)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeNumber in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNumber

public void writeNumber(float f)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeNumber in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNumber

public void writeNumber(BigDecimal dec)
                 throws IOException,
                        JsonGenerationException
Specified by:
writeNumber in class JsonGenerator
Throws:
IOException
JsonGenerationException

writeNumber

public void writeNumber(String encodedValue)
                 throws IOException,
                        JsonGenerationException,
                        UnsupportedOperationException
Specified by:
writeNumber in class JsonGenerator
Throws:
IOException
JsonGenerationException
UnsupportedOperationException

_verifyValueWrite

protected final void _verifyValueWrite(String typeMsg)
                                throws IOException,
                                       JsonGenerationException
Specified by:
_verifyValueWrite in class GeneratorBase
Throws:
IOException
JsonGenerationException

_releaseBuffers

protected void _releaseBuffers()
Specified by:
_releaseBuffers in class GeneratorBase

_columnIndex

protected final int _columnIndex()

finishRow

protected void finishRow()
                  throws IOException,
                         JsonGenerationException
Method called when the current row is complete; typically will flush possibly buffered column values, append linefeed and reset state appropriately.

Throws:
IOException
JsonGenerationException

_handleFirstLine

protected void _handleFirstLine()
                         throws IOException,
                                JsonGenerationException
Throws:
IOException
JsonGenerationException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012 fasterxml.com. All Rights Reserved.