
org.nerd4j.csv.CSVProcessOperation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nerd4j-csv Show documentation
Show all versions of nerd4j-csv Show documentation
CSV manipulation library.
/*
* #%L
* Nerd4j CSV
* %%
* Copyright (C) 2013 Nerd4j
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
package org.nerd4j.csv;
import org.nerd4j.csv.field.CSVFieldProcessContext;
/**
* Represents an object able to perform an atomic
* operation over a CSV field.
*
*
* This interface is intended to be of help
* for the {@link CSVProcessError}.
*
*
*
* The error pattern returned by this interface
* method must be according with the use made
* by the {@link CSVProcessError}.
*
*
* @author Nerd4j Team
*/
public interface CSVProcessOperation
{
/**
* Returns a message pattern as described in
* the {@link java.text.MessageFormat} class.
*
* The placeholders in this pattern coincide
* with fields of the {@link CSVFieldProcessContext}
* as follows:
*
* - {0} = columnName;
* - {1} = originalValue;
* - {2} = convertedValue.
*
*
*
* @return the pattern to use to build the error message.
*/
public String getErrorMessagePattern();
}