de.siegmar.fastcsv.reader.FieldModifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fastcsv Show documentation

Lightning-fast, dependency-free CSV library that conforms to RFC standards.

There is a newer version: 3.3.1

package de.siegmar.fastcsv.reader;

/**
 * Implementations of this class are used within {@link CsvCallbackHandler} implementations to modify the fields of
 * a CSV record before storing them in the resulting object.
 * 
 * Applying field modifiers might affect the behavior of skipping empty lines – see
 * {@link CsvReader.CsvReaderBuilder#skipEmptyLines(boolean)}.
 *
 * @see FieldModifiers
 * @see SimpleFieldModifier
 */
public interface FieldModifier {

    /**
     * Gets called for every single field (that is not a comment).
     * The Default implementation returns the field as is.
     *
     * @param startingLineNumber the starting line number (starting with 1)
     * @param fieldIdx           the field index (starting with 0)
     * @param quoted             {@code true} if the field was enclosed by the defined quote characters
     * @param field              the field value, never {@code null}
     * @return the modified field value (must not be {@code null})
     */
    default String modify(final long startingLineNumber, final int fieldIdx, final boolean quoted, final String field) {
        return field;
    }

    /**
     * Gets called for every comment.
     * The Default implementation returns the field as is.
     *
     * @param startingLineNumber the starting line number (starting with 1)
     * @param field              the field value (comment), never {@code null}
     * @return the modified field value (must not be {@code null})
     */
    default String modifyComment(final long startingLineNumber, final String field) {
        return field;
    }

    /**
     * Chains multiple modifiers.
     *
     * @param after the next modifier to use.
     * @return a composed field modifier that first applies this modifier and then applies the after modifier
     */
    default FieldModifier andThen(final FieldModifier after) {
        return new FieldModifier() {
            @Override
            public String modify(final long startingLineNumber, final int fieldIdx, final boolean quoted,
                                 final String field) {
                return after.modify(startingLineNumber, fieldIdx, quoted,
                    FieldModifier.this.modify(startingLineNumber, fieldIdx, quoted, field));
            }

            @Override
            public String modifyComment(final long startingLineNumber, final String field) {
                return after.modifyComment(startingLineNumber,
                    FieldModifier.this.modifyComment(startingLineNumber, field));
            }
        };
    }

}