org.supercsv.cellprocessor

Class StrReplace

java.lang.Object

org.supercsv.cellprocessor.CellProcessorAdaptor

org.supercsv.cellprocessor.StrReplace

All Implemented Interfaces:

BoolCellProcessor, CellProcessor, DateCellProcessor, DoubleCellProcessor, LongCellProcessor, StringCellProcessor

public class StrReplace
extends CellProcessorAdaptor
implements BoolCellProcessor, DateCellProcessor, DoubleCellProcessor, LongCellProcessor, StringCellProcessor

Replaces each substring of the input string that matches the given regular expression with the given replacement. The regular expression pattern is compiled once then reused for efficiency.

Author:

Kasper B. Graversen, Dominique De Vito, James Bassett

Field Summary

Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

next

Constructor Summary

Constructors

Constructor and Description
StrReplace(String regex, String replacement) Constructs a new StrReplace processor, which replaces each substring of the input that matches the regex with the supplied replacement.
StrReplace(String regex, String replacement, StringCellProcessor next) Constructs a new StrReplace processor, which replaces each substring of the input that matches the regex with the supplied replacement, then calls the next processor in the chain.

Method Summary

Modifier and Type	Method and Description
Object	execute(Object value, CsvContext context) This method is invoked by the framework when the processor needs to process data or check constraints.

Methods inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

toString, validateInputNotNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StrReplace

public StrReplace(String regex,
                  String replacement)

Constructs a new StrReplace processor, which replaces each substring of the input that matches the regex with the supplied replacement.

Parameters:

regex - the regular expression to match

replacement - the string to be substituted for each match

Throws:

IllegalArgumentException - if regex is empty

NullPointerException - if regex or replacement is null

PatternSyntaxException - if regex is not a valid regular expression

StrReplace

public StrReplace(String regex,
                  String replacement,
                  StringCellProcessor next)

Constructs a new StrReplace processor, which replaces each substring of the input that matches the regex with the supplied replacement, then calls the next processor in the chain.

Parameters:

regex - the regular expression to match

replacement - the string to be substituted for each match

next - the next processor in the chain

Throws:

IllegalArgumentException - if regex is empty

NullPointerException - if regex or replacement is null

PatternSyntaxException - if regex is not a valid regular expression

Method Detail

execute

public Object execute(Object value,
                      CsvContext context)

This method is invoked by the framework when the processor needs to process data or check constraints.

Specified by:

execute in interface CellProcessor

Parameters:

value - the value to be processed

context - the CSV context

Returns:

the result of cell processor execution

Throws:

SuperCsvCellProcessorException - if value is null