Top Description Inners Fields Constructors Methods
com.fasterxml.jackson.dataformat.csv

public Class CsvMapper

extends ObjectMapper
Class Inheritance
Imports
java.util.Collection, .Objects, com.fasterxml.jackson.core.type.TypeReference, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.cfg.MapperBuilder, com.fasterxml.jackson.databind.introspect.AnnotatedMember, .BeanPropertyDefinition, com.fasterxml.jackson.databind.util.NameTransformer, .ViewMatcher, com.fasterxml.jackson.dataformat.csv.impl.LRUMap
Specialized ObjectMapper, with extended functionality to produce CsvSchema instances out of POJOs.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CsvMapper.Builder

Base implementation for "Vanilla" ObjectMapper, used with CSV backend.

public static class
CsvMapper.ViewKey

Simple class in order to create a map key based on JavaType and a given view.

Field Summary

Modifier and TypeField and Description
protected final LRUMap<CsvMapper.ViewKey, CsvSchema>
_typedSchemas

Simple caching for schema instances, given that they are relatively expensive to construct; this one is for typed schemas

protected final LRUMap<CsvMapper.ViewKey, CsvSchema>
_untypedSchemas

Simple caching for schema instances, given that they are relatively expensive to construct; this one is for "loose" (non-typed) schemas

private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.ObjectMapper.serialVersionUID.

Inherited from com.fasterxml.jackson.databind.ObjectMapper:
_coercionConfigs_configOverrides_deserializationConfig_deserializationContext_injectableValues_jsonFactory_mixIns_registeredModuleTypes_rootDeserializers_serializationConfig_serializerFactory_serializerProvider_subtypeResolver_typeFactoryDEFAULT_ANNOTATION_INTROSPECTORDEFAULT_BASE

Constructor Summary

AccessConstructor and Description
public
CsvMapper()

public
CsvMapper(CsvFactory f)

protected
CsvMapper(CsvMapper src)

Copy-constructor, mostly used to support copy.

Method Summary

Modifier and TypeMethod and Description
protected void
_addSchemaProperties(CsvSchema.Builder builder, AnnotationIntrospector intr, boolean typed, JavaType pojoType, NameTransformer unwrapper, Class<?> view)

protected CsvSchema.ColumnType
_determineType(Class<?> propType)

protected boolean
_nonPojoType(JavaType t)

protected CsvSchema
_schemaFor(JavaType pojoType, LRUMap<CsvMapper.ViewKey, CsvSchema> schemas, boolean typed, Class<?> view)

protected CsvSchema
_schemaFor(JavaType pojoType, LRUMap<CsvMapper.ViewKey, CsvSchema> schemas, boolean typed)
Deprecated

public static CsvMapper.Builder
builder()

public static CsvMapper.Builder
builder(CsvFactory streamFactory)

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

public CsvMapper
configure(CsvParser.Feature f, boolean state)

public CsvMapper
copy()

Overrides com.fasterxml.jackson.databind.ObjectMapper.copy.

Method for creating a new ObjectMapper instance that has same initial configuration as this instance.

public static CsvMapper.Builder
csvBuilder()

Short-cut for: 

   return builder(new CsvFactory());
public CsvMapper
disable(CsvGenerator.Feature f)

public CsvMapper
disable(CsvParser.Feature f)

public CsvMapper
enable(CsvGenerator.Feature f)

public CsvMapper
enable(CsvParser.Feature f)

public CsvFactory
getFactory()

Overrides com.fasterxml.jackson.databind.ObjectMapper.getFactory.

Overridden with more specific type, since factory we have is always of type CsvFactory

public ObjectReader
readerWithSchemaFor(Class<?>
Type used both for data-binding (result type) and for schema introspection.

Note

must NOT be an array or Collection type, since these only make sense for data-binding (like arrays of objects to bind), but not for schema construction (no CSV types can be mapped to arrays or Collections)

pojoType)

Convenience method which is functionally equivalent to: 

  reader(pojoType).withSchema(schemaFor(pojoType));
public ObjectReader
readerWithTypedSchemaFor(Class<?> pojoType)

Convenience method which is functionally equivalent to: 

  reader(pojoType).withSchema(typedSchemaFor(pojoType));
public CsvSchema
schema()

Convenience method that is same as 

   CsvSchema.emptySchema()
public CsvSchema
schemaFor(JavaType pojoType)

Method that can be used to determine a CSV schema to use for given POJO type, using default serialization settings including ordering.

public final CsvSchema
schemaFor(Class<?> pojoType)

public final CsvSchema
schemaFor(TypeReference<?> pojoTypeRef)

public CsvSchema
schemaForWithView(JavaType pojoType, Class<?> view)

public final CsvSchema
schemaForWithView(Class<?> pojoType, Class<?> view)

public final CsvSchema
schemaForWithView(TypeReference<?> pojoTypeRef, Class<?> view)

public CsvSchema
schemaWithHeader()

Convenience method that is same as 

   CsvSchema.emptySchema().withHeader();
public CsvSchema
typedSchemaFor(JavaType pojoType)

Method that can be used to determine a CSV schema to use for given POJO type, using default serialization settings including ordering.

public final CsvSchema
typedSchemaFor(Class<?> pojoType)

public final CsvSchema
typedSchemaFor(TypeReference<?> pojoTypeRef)

public CsvSchema
typedSchemaForWithView(JavaType pojoType, Class<?> view)

public final CsvSchema
typedSchemaForWithView(Class<?> pojoType, Class<?> view)

public final CsvSchema
typedSchemaForWithView(TypeReference<?> pojoTypeRef, Class<?> view)

public ObjectWriter
writerWithSchemaFor(Class<?>
Type used both for data-binding (result type) and for schema introspection.

Note

must NOT be an array or Collection type, since these only make sense for data-binding (like arrays of objects to bind), but not for schema construction (no root-level CSV types can be mapped to arrays or Collections)

pojoType)

Convenience method which is functionally equivalent to: 

  writer(pojoType).with(schemaFor(pojoType));
public ObjectWriter
writerWithTypedSchemaFor(Class<?> pojoType)

Convenience method which is functionally equivalent to: 

  writer(pojoType).with(typedSchemaFor(pojoType));
Inherited from com.fasterxml.jackson.databind.ObjectMapper:
_assertNotNull_checkInvalidCopy_configAndWriteValue_constructDefaultTypeResolverBuilder_convert_findRootDeserializer_initForReading_newReader_newReader_newWriter_newWriter_newWriter_readMapAndClose_readTreeAndClose_readValue_serializerProvider_verifyNoTrailingTokens_verifySchemaType_writeValueAndCloseacceptJsonFormatVisitoracceptJsonFormatVisitoractivateDefaultTypingactivateDefaultTypingactivateDefaultTypingactivateDefaultTypingAsPropertyaddHandleraddMixInaddMixInAnnotationscanDeserializecanDeserializecanSerializecanSerializeclearProblemHandlerscoercionConfigDefaultscoercionConfigForcoercionConfigForconfigOverrideconfigureconfigureconfigureconfigureconfigureconfigureconstructTypeconstructTypeconvertValueconvertValueconvertValuecopyWithcreateArrayNodecreateDeserializationContextcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateNonBlockingByteArrayParsercreateObjectNodecreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParserdeactivateDefaultTypingdefaultClassIntrospectordisabledisabledisabledisabledisabledisabledisabledisableDefaultTypingenableenableenableenableenableenableenableenableDefaultTypingenableDefaultTypingenableDefaultTypingenableDefaultTypingAsPropertyfindAndRegisterModulesfindMixInClassForfindModulesfindModulesgenerateJsonSchemagetDateFormatgetDeserializationConfiggetDeserializationContextgetInjectableValuesgetNodeFactorygetPolymorphicTypeValidatorgetPropertyNamingStrategygetRegisteredModuleIdsgetSerializationConfiggetSerializerFactorygetSerializerProvidergetSerializerProviderInstancegetSubtypeResolvergetTypeFactorygetVisibilityCheckerisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledmissingNodemixInCountnullNodereaderreaderreaderreaderreaderreaderreaderreaderreaderreaderreaderreaderForreaderForreaderForreaderForArrayOfreaderForListOfreaderForMapOfreaderForUpdatingreaderWithViewreadTreereadTreereadTreereadTreereadTreereadTreereadTreereadTreereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuesreadValuesreadValuesreadValuesregisterModuleregisterModulesregisterModulesregisterSubtypesregisterSubtypesregisterSubtypessetAccessorNamingsetAnnotationIntrospectorsetAnnotationIntrospectorssetBase64VariantsetCacheProvidersetConfigsetConfigsetConstructorDetectorsetDateFormatsetDefaultAttributessetDefaultLeniencysetDefaultMergeablesetDefaultPrettyPrintersetDefaultPropertyInclusionsetDefaultPropertyInclusionsetDefaultSetterInfosetDefaultTypingsetDefaultVisibilitysetFilterProvidersetFilterssetHandlerInstantiatorsetInjectableValuessetLocalesetMixInAnnotationssetMixInResolversetMixInssetNodeFactorysetPolymorphicTypeValidatorsetPropertyInclusionsetPropertyNamingStrategysetSerializationInclusionsetSerializerFactorysetSerializerProvidersetSubtypeResolversetTimeZonesetTypeFactorysetVisibilitysetVisibilitysetVisibilityCheckertokenStreamFactorytreeAsTokenstreeToValuetreeToValuetreeToValueupdateValuevalueToTreeversionwriterwriterwriterwriterwriterwriterwriterwriterwriterwriterwriterForwriterForwriterForwriterWithDefaultPrettyPrinterwriterWithTypewriterWithTypewriterWithTypewriterWithViewwriteTreewriteTreewriteValuewriteValuewriteValuewriteValuewriteValuewriteValueAsByteswriteValueAsString