univocity-parsers 2.9.1 · com.univocity.parsers.annotations.Format

Indicates that a parsed value is formatted and must be parsed before being assigned.

The Conversion type assigned to this field will depend on its type.

Multiple format masks can be tried for a single value.

When reading from this value (for writing to a given output), the first mask declared in Format#formats() will be used to produce its String representation.

The options() is an optional configuration, with properties and values separated by =.. Each property will be used configure the underlying formatter. For example, if the parsed value is a BigDecimal, and the format is '#0,00', the decimal separator must be set to ','. To specify this using the options() annotation, use:

formats="#0,00", options="decimalSeparator=,".
The "decimalSeparator" property will be used to identify which method in DecimalFormat to invoke. In this case, the method "setDecimalSeparator", with the value on the right hand side of the = operator

Commonly used for java beans processed using BeanProcessor and/or BeanWriterProcessor

Method Summary

Modifier and Type	Method and Description
public String[]	Returns: the sequence of formats to use. formats() Formats that define how a value can be formatted.
public String[]	Returns: a sequence of properties available in the underlying formatter and their respective values options() Defines a sequence of properties and their values, used to configure the underlying formatter.

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

Method Detail

formats	back to summary
public String[] formats() Formats that define how a value can be formatted. When reading, the values parsed from the input will be parsed according to the specified format. If multiple formats are defined, the first successful parsed value will be used. When writing, the first format defined in the sequence of formats will be used to produce the correct String representation. Returns:String[] the sequence of formats to use.

formats

back to summary

public String[] formats()

Formats that define how a value can be formatted. When reading, the values parsed from the input will be parsed according to the specified format. If multiple formats are defined, the first successful parsed value will be used. When writing, the first format defined in the sequence of formats will be used to produce the correct String representation.

Returns:String[]: the sequence of formats to use.

options back to summary

options	back to summary
public String[] options() Defines a sequence of properties and their values, used to configure the underlying formatter. Each element must be specified as `property_name=property_value`, e.g. options={"decimalSeparator=,", "maximumFractionDigits=3", "locale=en"} Returns:String[] a sequence of properties available in the underlying formatter and their respective values

public String[] options()

Defines a sequence of properties and their values, used to configure the underlying formatter. Each element must be specified as property_name=property_value, e.g. options={"decimalSeparator=,", "maximumFractionDigits=3", "locale=en"}

Returns:String[]: a sequence of properties available in the underlying formatter and their respective values

public @Interface Format

Method Summary

Method Detail