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 useIsElementOf
instead.- Since:
- 1.50
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Set<java.lang.Object>
possibleValues
-
Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor
next
-
-
Constructor Summary
Constructors Constructor Description IsIncludedIn(java.lang.Object[] possibleValues)
Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values.IsIncludedIn(java.lang.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(java.util.Set<java.lang.Object> possibleValues)
Constructs a new IsIncludedIn processor, which ensures that the input value belongs to a specific set of given values.IsIncludedIn(java.util.Set<java.lang.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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static void
checkPreconditions(java.lang.Object... possibleValues)
Checks the preconditions for creating a new IsIncludedIn processor with a array of Objects.private static void
checkPreconditions(java.util.Set<java.lang.Object> possibleValues)
Checks the preconditions for creating a new IsIncludedIn processor with a Set of Objects.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
-
IsIncludedIn
public IsIncludedIn(java.util.Set<java.lang.Object> possibleValues)
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:
java.lang.NullPointerException
- if possibleValues is nulljava.lang.IllegalArgumentException
- if possibleValues is empty
-
IsIncludedIn
public IsIncludedIn(java.util.Set<java.lang.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.- Parameters:
possibleValues
- the Set of valuesnext
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if possibleValues or next is nulljava.lang.IllegalArgumentException
- if possibleValues is empty
-
IsIncludedIn
public IsIncludedIn(java.lang.Object[] possibleValues)
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:
java.lang.NullPointerException
- if possibleValues is nulljava.lang.IllegalArgumentException
- if possibleValues is empty
-
IsIncludedIn
public IsIncludedIn(java.lang.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.- Parameters:
possibleValues
- the array of valuesnext
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if possibleValues or next is nulljava.lang.IllegalArgumentException
- if possibleValues is empty
-
-
Method Detail
-
checkPreconditions
private static void checkPreconditions(java.util.Set<java.lang.Object> possibleValues)
Checks the preconditions for creating a new IsIncludedIn processor with a Set of Objects.- Parameters:
possibleValues
- the Set of possible values- Throws:
java.lang.NullPointerException
- if possibleValues is nulljava.lang.IllegalArgumentException
- if possibleValues is empty
-
checkPreconditions
private static void checkPreconditions(java.lang.Object... possibleValues)
Checks the preconditions for creating a new IsIncludedIn processor with a array of Objects.- Parameters:
possibleValues
- the array of possible values- Throws:
java.lang.NullPointerException
- if possibleValues is nulljava.lang.IllegalArgumentException
- if possibleValues is empty
-
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:
SuperCsvCellProcessorException
- if value is nullSuperCsvConstraintViolationException
- if value isn't one of the possible values
-
-