Class Equals
- java.lang.Object
-
- org.supercsv.cellprocessor.CellProcessorAdaptor
-
- org.supercsv.cellprocessor.constraint.Equals
-
- All Implemented Interfaces:
BoolCellProcessor
,CellProcessor
,DateCellProcessor
,DoubleCellProcessor
,LongCellProcessor
,StringCellProcessor
public class Equals extends CellProcessorAdaptor implements BoolCellProcessor, DateCellProcessor, DoubleCellProcessor, LongCellProcessor, StringCellProcessor
This constraint ensures that all input data is equal (to each other, or to a supplied constant value).- Since:
- 1.50
- Author:
- Dominique De Vito, James Bassett
-
-
Field Summary
-
Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor
next
-
-
Constructor Summary
Constructors Constructor Description Equals()
Constructs a new Equals processor, which ensures all input data is equal.Equals(java.lang.Object constantValue)
Constructs a new Equals processor, which ensures all input data is equal to the supplied constant value.Equals(java.lang.Object constantValue, CellProcessor next)
Constructs a new Equals processor, which ensures all input data is equal to the supplied constant value, then calls the the next processor in the chain.Equals(CellProcessor next)
Constructs a new Equals processor, which ensures all input data is equal, then calls the the next processor in the chain.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
execute(java.lang.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
-
-
-
-
Constructor Detail
-
Equals
public Equals()
Constructs a new Equals processor, which ensures all input data is equal.
-
Equals
public Equals(java.lang.Object constantValue)
Constructs a new Equals processor, which ensures all input data is equal to the supplied constant value.- Parameters:
constantValue
- the constant value that all input must equal
-
Equals
public Equals(CellProcessor next)
Constructs a new Equals processor, which ensures all input data is equal, then calls the the next processor in the chain.- Parameters:
next
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if next is null
-
Equals
public Equals(java.lang.Object constantValue, CellProcessor next)
Constructs a new Equals processor, which ensures all input data is equal to the supplied constant value, then calls the the next processor in the chain.- Parameters:
constantValue
- the constant value that all input must equalnext
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if next is null
-
-
Method Detail
-
execute
public java.lang.Object execute(java.lang.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 interfaceCellProcessor
- Parameters:
value
- the value to be processedcontext
- the CSV context- Returns:
- the result of cell processor execution
- Throws:
SuperCsvConstraintViolationException
- if value isn't equal to the constant value (or previously encountered value if a constant wasn't supplied)
-
-