Annotation Type CsvCell


  • @Target(FIELD)
    @Retention(RUNTIME)
    public @interface CsvCell
    Various settings for a BeanInstructionsImpl translating to a CSV cell. By default every field in a BeanInstructionsImpl is expected to be a CsvCell, even if not so marked. Use @CsvIgnore to prevent a BeanInstructionsImpl field from being taken into account for both serialization and deserialization.
    Author:
    Robert Bor
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      int columnIndex
      This value will only be used if CsvFile.useHeaders == false.
      String columnName
      By default the column name is inferred from the property name.
      boolean required
      If required is set, the parse process will generate an error if the value is null after deserialization
    • Element Detail

      • columnIndex

        int columnIndex
        This value will only be used if CsvFile.useHeaders == false. If this value is not set, the index will be automatically determined on the basis of the order of the fields within the class. If this value is set, the column at the index position will be used for mapping to this field. A 1-based approach is used because the error report is aimed at the Excel user, not the developer.
        Returns:
        the index column to use for the mapping
        Default:
        -1
      • columnName

        String columnName
        By default the column name is inferred from the property name. However, if CsvFile.useHeaders == false, or the naming is not what you want in the BeanInstructions, you can override the column name to map to using this value.
        Returns:
        the column name in the CSV file header to use for mapping
        Default:
        ""
      • required

        boolean required
        If required is set, the parse process will generate an error if the value is null after deserialization
        Returns:
        whether the field must be not null
        Default:
        false