01: /*
02: * CSVFieldFormatter.java
03: *
04: * Copyright (C) 2005 Anupam Sengupta (anupamsg@users.sourceforge.net)
05: *
06: * This program is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU General Public License
08: * as published by the Free Software Foundation; either version 2
09: * of the License, or (at your option) any later version.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, write to the Free Software
18: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19: *
20: * Version: $Revision: 1.1 $
21: */
22: package net.sf.anupam.csv.formatters;
23:
24: /**
25: * Main Interface for a CSV field formatter. This interface needs to be
26: * implemented by the actual formatter implementations in order to be recognized
27: * by the Framework.
28: * <p>
29: * Default implementations are available for common formatting requirements in
30: * the Framework, and are present in this package. See the package overview for
31: * details.
32: * </p>
33: *
34: * @author Anupam Sengupta
35: * @version $Revision: 1.1 $
36: * @since 1.5
37: * @see CSVFormatterFactory
38: */
39: public interface CSVFieldFormatter {
40:
41: /**
42: * Formats the specified CSV field value and returns the formatted result.
43: *
44: * @param value
45: * the CSV field value to format
46: * @return the formatted result
47: */
48: String format(final String value);
49: }
|