opencsv 5.12.0 · com.opencsv.bean.CsvDate · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public String	Returns: The `java.time.chrono.Chronology` in use chronology() The `java.time.chrono.Chronology` that should be used for parsing.
public String[]	Returns: The names of the profiles this configuration is for profiles() A profile can be used to annotate the same field differently for different inputs or outputs.
public String	Returns: The format string for parsing input value() A date/time format string.
public String	Returns: The `java.time.chrono.Chronology` in use writeChronology() The `java.time.chrono.Chronology` that should be used for formatting.
public boolean	Returns: Whether the read chronology is used for writing as well writeChronologyEqualsReadChronology() Whether or not the same chronology string is used for writing as for reading.
public String	Returns: The format string for formatting output writeFormat() A date/time format string.
public boolean	Returns: Whether the read format is used for writing as well writeFormatEqualsReadFormat() Whether or not the same format string is used for writing as for reading.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

chronology back to summary

chronology	back to summary
public String chronology() The `java.time.chrono.Chronology` that should be used for parsing. The value must be understood by `java.time.chrono.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 `java.time.temporal.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:String The `java.time.chrono.Chronology` in use Since 5.0

public String chronology()

The java.time.chrono.Chronology that should be used for parsing.

The value must be understood by java.time.chrono.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 java.time.temporal.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:String: The java.time.chrono.Chronology in use
Since: 5.0

profiles	back to summary
public 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:String[] The names of the profiles this configuration is for Since 5.4

profiles

back to summary

public 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:String[]: The names of the profiles this configuration is for
Since: 5.4

value back to summary

value	back to summary
public 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 `java.text.SimpleDateFormat#SimpleDateFormat(java.lang.String)`. If it is applied to `java.time.temporal.TemporalAccessor`-based dates and times, then this must be a string understood by `java.time.format.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:String The format string for parsing input

public 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 java.text.SimpleDateFormat#SimpleDateFormat(java.lang.String). If it is applied to java.time.temporal.TemporalAccessor-based dates and times, then this must be a string understood by java.time.format.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:String: The format string for parsing input

writeChronology back to summary

writeChronology	back to summary
public String writeChronology() The `java.time.chrono.Chronology` that should be used for formatting. Returns:String The `java.time.chrono.Chronology` in use Since 5.0 See Also `chronology()`, `writeChronologyEqualsReadChronology()`

public String writeChronology()

The java.time.chrono.Chronology that should be used for formatting.

Returns:String: The java.time.chrono.Chronology in use
Since: 5.0
See Also: chronology(), writeChronologyEqualsReadChronology()

writeChronologyEqualsReadChronology back to summary

writeChronologyEqualsReadChronology	back to summary
public 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:boolean Whether the read chronology is used for writing as well Since 5.0

public 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:boolean: Whether the read chronology is used for writing as well
Since: 5.0

writeFormat back to summary

writeFormat	back to summary
public String writeFormat() A date/time format string. Returns:String The format string for formatting output Since 5.0 See Also `value()`, `writeFormatEqualsReadFormat()`

public String writeFormat()

A date/time format string.

Returns:String: The format string for formatting output
Since: 5.0
See Also: value(), writeFormatEqualsReadFormat()

writeFormatEqualsReadFormat back to summary

writeFormatEqualsReadFormat	back to summary
public 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:boolean Whether the read format is used for writing as well Since 5.0

public 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:boolean: Whether the read format is used for writing as well
Since: 5.0

public @Interface CsvDate

Method Summary

Method Detail