Package org.apache.juneau.csv

Class CsvSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.csv.CsvSerializer

All Implemented Interfaces:

CsvMetaProvider

public class CsvSerializer
extends WriterSerializer
implements CsvMetaProvider

Serializes POJO models to CSV (Comma Separated Values) format.

This serializer converts Java objects (primarily collections of beans) into CSV format, where each bean becomes a row and bean properties become columns. The first row typically contains column headers derived from bean property names.

Notes:

• This class is thread safe and reusable.
• This serializer is optimized for simple tabular data structures and may have limitations with complex nested objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CsvSerializer.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final CsvSerializer	DEFAULT	Default serializer, all default settings.

Fields inherited from class org.apache.juneau.serializer.WriterSerializer

maxIndent, quoteChar, quoteCharOverride, useWhitespace

Fields inherited from class org.apache.juneau.serializer.Serializer

accept, addBeanTypes, addRootType, keepNullProperties, listener, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.BeanContextable

beanContext

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
CsvSerializer(CsvSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
CsvSerializer.Builder	copy()	Creates a builder from this context object.
static CsvSerializer.Builder	create()	Creates a new builder for this object.
CsvSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
CsvBeanPropertyMeta	getCsvBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
CsvClassMeta	getCsvClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
CsvSerializerSession	getSession()	Returns a session to use for this context.

Methods inherited from class org.apache.juneau.serializer.WriterSerializer

getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, properties, quoteChar, serialize, toString

Methods inherited from class org.apache.juneau.serializer.Serializer

createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddBeanTypes, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT

public static final CsvSerializer DEFAULT

Default serializer, all default settings.

Constructor Details

CsvSerializer

public CsvSerializer(CsvSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static CsvSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public CsvSerializer.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class WriterSerializer

Returns:

A new Builder object.

createSession

public CsvSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class WriterSerializer

Returns:

A new session builder.

getCsvBeanPropertyMeta

public CsvBeanPropertyMeta getCsvBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: CsvMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getCsvBeanPropertyMeta in interface CsvMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getCsvClassMeta

public CsvClassMeta getCsvClassMeta(ClassMeta<?> cm)

Description copied from interface: CsvMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getCsvClassMeta in interface CsvMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getSession

public CsvSerializerSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class WriterSerializer

Returns:

A new session object.