com.opencsv.bean

Annotation Type CsvDate

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Repeatable(value=CsvDates.class)
public @interface CsvDate

This annotation indicates that the destination field is an expression of time.

Conversion to the following old-style types is supported:

• Date
• Calendar (a GregorianCalendar is returned)
• GregorianCalendar
• XMLGregorianCalendar
• Date
• Time
• Timestamp

Conversion to the following TemporalAccessor-style types is supported:

• TemporalAccessor. If this interface is used, the actual type returned is not defined.
• ChronoLocalDate. If this interface is used, the actual type returned is LocalDate.
• LocalDate
• ChronoLocalDateTime. If this interface is used, the actual type returned is LocalDateTime.
• LocalDateTime
• ChronoZonedDateTime. If this interface is used, the actual type returned is ZonedDateTime.
• ZonedDateTime
• Temporal. If this interface is used, the actual type returned is not defined.
• Era. If this interface is used, the actual type returned is IsoEra.
• IsoEra
• DayOfWeek
• HijrahDate
• HijrahEra
• Instant
• JapaneseDate
• JapaneseEra
• LocalTime
• MinguoDate
• MinguoEra
• Month
• MonthDay
• OffsetDateTime
• OffsetTime
• ThaiBuddhistDate
• ThaiBuddhistEra
• Year
• YearMonth
• ZoneOffset

This annotation must be used with either CsvBindByName or CsvBindByPosition, otherwise it is ignored.

Since:

3.8

Author:

Andrew Rucker Jones

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	chronology The Chronology that should be used for parsing.
String[]	profiles A profile can be used to annotate the same field differently for different inputs or outputs.
String	value A date/time format string.
String	writeChronology The Chronology that should be used for formatting.
boolean	writeChronologyEqualsReadChronology Whether or not the same chronology string is used for writing as for reading.
String	writeFormat A date/time format string.
boolean	writeFormatEqualsReadFormat Whether or not the same format string is used for writing as for reading.

Element Detail

value

public abstract String value

A date/time format string. If this annotation is applied to old-style dates and times, then this must be a string understood by SimpleDateFormat(java.lang.String). If it is applied to TemporalAccessor-based dates and times, then this must be a string understood by DateTimeFormatter. The default value works for both styles and conforms with ISO 8601. Locale information, if specified, is gleaned from one of the other CSV-related annotations and is used for conversion.

Returns:

The format string for parsing input

Default:

"yyyyMMdd\'T\'HHmmss"

writeFormatEqualsReadFormat

public abstract boolean writeFormatEqualsReadFormat

Whether or not the same format string is used for writing as for reading. If this is true, value() is used for both reading and writing and writeFormat() is ignored.

Returns:

Whether the read format is used for writing as well

Since:

5.0

Default:

true

writeFormat

public abstract String writeFormat

A date/time format string.

Returns:

The format string for formatting output

Since:

5.0

See Also:

value(), writeFormatEqualsReadFormat()

Default:

"yyyyMMdd\'T\'HHmmss"

chronology

public abstract String chronology

The Chronology that should be used for parsing.

The value must be understood by Chronology.of(String). The requisite ID for the desired Chronology can usually be found in the Javadoc for the getId() method of the specific implementation.

This value is only used for TemporalAccessor-based fields. It is ignored for old-style dates and times.

The default value specifies the ISO-8601 chronology. If a blank string or empty string is specified, the chronology is taken from the locale.

Returns:

The Chronology in use

Since:

5.0

Default:

"ISO"

writeChronologyEqualsReadChronology

public abstract boolean writeChronologyEqualsReadChronology

Whether or not the same chronology string is used for writing as for reading. If this is true, chronology() is used for both reading and writing and writeChronology() is ignored.

Returns:

Whether the read chronology is used for writing as well

Since:

5.0

Default:

true

writeChronology

public abstract String writeChronology

The Chronology that should be used for formatting.

Returns:

The Chronology in use

Since:

5.0

See Also:

chronology(), writeChronologyEqualsReadChronology()

Default:

"ISO"

profiles

public abstract String[] profiles

A profile can be used to annotate the same field differently for different inputs or outputs.

Perhaps you have multiple input sources, and they all use different header names or positions for the same data. With profiles, you don't have to create different beans with the same fields and different annotations for each input. Simply annotate the same field multiple times and specify the profile when you parse the input.

The same applies to output: if you want to be able to represent the same data in multiple CSV formats (that is, with different headers or orders), annotate the bean fields multiple times with different profiles and specify which profile you want to use on writing.

Results are undefined if profile names are not unique.

If the same configuration applies to multiple profiles, simply list all applicable profile names here. This parameter is an array of strings.

The empty string, which is the default value, specifies the default profile and will be used if no annotation for the specific profile being used can be found, or if no profile is specified.

Returns:

The names of the profiles this configuration is for

Since:

5.4

Default:

""