Class IsIncludedIn
java.lang.Object
org.supercsv.cellprocessor.CellProcessorAdaptor
org.supercsv.cellprocessor.constraint.IsIncludedIn
- All Implemented Interfaces:
BoolCellProcessor
,CellProcessor
,DateCellProcessor
,DoubleCellProcessor
,LongCellProcessor
,StringCellProcessor
public class IsIncludedIn
extends CellProcessorAdaptor
implements BoolCellProcessor, DateCellProcessor, DoubleCellProcessor, LongCellProcessor, StringCellProcessor
This processor ensures that the input value belongs to a specific set of (unchangeable) values. If you want to check
if the value is an element of a (possibly changing) Collection, then use
IsElementOf
instead.- Since:
- 1.50
-
Field Summary
FieldsFields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor
next
-
Constructor Summary
ConstructorsConstructorDescriptionIsIncludedIn
(Object[] possibleValues) Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values.IsIncludedIn
(Object[] possibleValues, CellProcessor next) Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values, then calls the next processor in the chain.IsIncludedIn
(Set<Object> possibleValues) Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values.IsIncludedIn
(Set<Object> possibleValues, CellProcessor next) Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values, then calls the next processor in the chain. -
Method Summary
Modifier and TypeMethodDescriptionprivate static void
checkPreconditions
(Object... possibleValues) Checks the preconditions for creating a new IsIncludedIn processor with a array of Objects.private static void
checkPreconditions
(Set<Object> possibleValues) Checks the preconditions for creating a new IsIncludedIn processor with a Set of Objects.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
-
Field Details
-
possibleValues
-
-
Constructor Details
-
IsIncludedIn
Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values.- Parameters:
possibleValues
- the Set of values- Throws:
NullPointerException
- if possibleValues is nullIllegalArgumentException
- if possibleValues is empty
-
IsIncludedIn
Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values, then calls the next processor in the chain.- Parameters:
possibleValues
- the Set of valuesnext
- the next processor in the chain- Throws:
NullPointerException
- if possibleValues or next is nullIllegalArgumentException
- if possibleValues is empty
-
IsIncludedIn
Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values.- Parameters:
possibleValues
- the array of values- Throws:
NullPointerException
- if possibleValues is nullIllegalArgumentException
- if possibleValues is empty
-
IsIncludedIn
Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values, then calls the next processor in the chain.- Parameters:
possibleValues
- the array of valuesnext
- the next processor in the chain- Throws:
NullPointerException
- if possibleValues or next is nullIllegalArgumentException
- if possibleValues is empty
-
-
Method Details
-
checkPreconditions
Checks the preconditions for creating a new IsIncludedIn processor with a Set of Objects.- Parameters:
possibleValues
- the Set of possible values- Throws:
NullPointerException
- if possibleValues is nullIllegalArgumentException
- if possibleValues is empty
-
checkPreconditions
Checks the preconditions for creating a new IsIncludedIn processor with a array of Objects.- Parameters:
possibleValues
- the array of possible values- Throws:
NullPointerException
- if possibleValues is nullIllegalArgumentException
- if possibleValues is empty
-
execute
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:
SuperCsvCellProcessorException
- if value is nullSuperCsvConstraintViolationException
- if value isn't one of the possible values
-