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

    Fields
    Modifier and Type
    Field
    Description
    private final Set<Object>
    possibleValues
     

    Fields inherited from class CellProcessorAdaptor

    next

  • Constructor Summary

    Constructors
    Constructor
    Description
    IsIncludedIn(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 Type
    Method
    Description
    private 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.
    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 CellProcessorAdaptor

    toString, validateInputNotNull

    Methods inherited from class Object

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

  • Field Details

    • possibleValues

      private final Set<Object> possibleValues

  • Constructor Details

    • IsIncludedIn

      public IsIncludedIn(Set<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:
      NullPointerException - if possibleValues is null
      IllegalArgumentException - if possibleValues is empty

    • IsIncludedIn

      public 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.
      Parameters:
      possibleValues - the Set of values
      next - the next processor in the chain
      Throws:
      NullPointerException - if possibleValues or next is null
      IllegalArgumentException - if possibleValues is empty

    • IsIncludedIn

      public IsIncludedIn(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:
      NullPointerException - if possibleValues is null
      IllegalArgumentException - if possibleValues is empty

    • IsIncludedIn

      public 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.
      Parameters:
      possibleValues - the array of values
      next - the next processor in the chain
      Throws:
      NullPointerException - if possibleValues or next is null
      IllegalArgumentException - if possibleValues is empty

  • Method Details

    • checkPreconditions

      private static void checkPreconditions(Set<Object> possibleValues)
      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 null
      IllegalArgumentException - if possibleValues is empty

    • checkPreconditions

      private static void checkPreconditions(Object... possibleValues)
      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 null
      IllegalArgumentException - if possibleValues is empty

    • 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
      SuperCsvConstraintViolationException - if value isn't one of the possible values