com.ebay.xcelite.annotations

Annotation Type Column

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface Column

Annotation to annotate a field to represent a column in excel file.

Author:

kharel (kharel@ebay.com)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends ColumnValueConverter<?,?>>	converter Converter class to use when serializing/deserializing the data.
String	dataFormat The cell format to use when writing the data to excel file.
boolean	ignoreType If true, ignores the actual field type and serializes the field value as String.
String	name The actual name of the column that will be written to excel file.

Element Detail

name

public abstract String name

The actual name of the column that will be written to excel file. If no name specified, the annotated field name will be taken.

Default:

""

ignoreType

public abstract boolean ignoreType

If true, ignores the actual field type and serializes the field value as String. Otherwise, uses the actual field type when writing the data.

Default:

false

dataFormat

public abstract String dataFormat

The cell format to use when writing the data to excel file. Default is no format.

Default:

""

converter

public abstract Class<? extends ColumnValueConverter<?,?>> converter

Converter class to use when serializing/deserializing the data. Class must implement ColumnValueConverter. Default is no converter.

Default:

com.ebay.xcelite.annotate.NoConverterClass.class