Package org.apache.juneau.csv

Class CsvParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.csv.CsvParser

All Implemented Interfaces:

AnnotationProvider, CsvMetaProvider

public class CsvParser
extends ReaderParser
implements CsvMetaProvider

TODO - Work in progress. CSV parser.

Notes:

• This class is thread safe and reusable.

See Also:

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final CsvParser	DEFAULT	Default parser, all default settings.

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Constructor	Description
CsvParser(CsvParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
CsvParser.Builder	copy()	Creates a builder from this context object.
static CsvParser.Builder	create()	Creates a new builder for this object.
CsvParserSession.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.
CsvParserSession	getSession()	Returns a session to use for this context.

Methods inherited from class org.apache.juneau.parser.ReaderParser

getFileCharset, getStreamCharset, isReaderParser, properties

Methods inherited from class org.apache.juneau.parser.Parser

canHandle, createParserBuilder, doParse, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.AnnotationProvider

firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation

Field Details

DEFAULT

public static final CsvParser DEFAULT

Default parser, all default settings.

Constructor Details

CsvParser

public CsvParser(CsvParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static CsvParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public CsvParser.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 Parser

Returns:

A new Builder object.

createSession

public CsvParserSession.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 ReaderParser

Returns:

A new session builder.

getSession

public CsvParserSession 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 ReaderParser

Returns:

A new session object.

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.

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.