Class ForbidSubStr

java.lang.Object
org.supercsv.cellprocessor.CellProcessorAdaptor
org.supercsv.cellprocessor.constraint.ForbidSubStr
All Implemented Interfaces:
CellProcessor, StringCellProcessor
public class ForbidSubStr extends CellProcessorAdaptor implements StringCellProcessor
Converts the input to a String and ensures that it doesn't contain any of the supplied substrings. For example, this constraint might be handy when reading/writing filenames and wanting to ensure no filename contains ":", "/", etc.
Since:
1.10
Author:
Kasper B. Graversen, James Bassett

  • Field Summary

    Fields inherited from class CellProcessorAdaptor

    next

  • Constructor Summary

    Constructors
    Constructor
    Description
    ForbidSubStr(String... forbiddenSubStrings)
    Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings.
    ForbidSubStr(String[] forbiddenSubStrings, CellProcessor next)
    Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings, then calls the next processor in the chain.
    ForbidSubStr(String forbiddenSubString, CellProcessor next)
    Constructs a new ForbidSubStr processor which ensures the input doesn't contain the supplied substring, then calls the next processor in the chain.
    ForbidSubStr(List<String> forbiddenSubStrings)
    Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings.
    ForbidSubStr(List<String> forbiddenSubStrings, CellProcessor next)
    Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings, then calls the next processor in the chain.

  • Method Summary

    Modifier and Type
    Method
    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 CellProcessorAdaptor

    toString, validateInputNotNull

    Methods inherited from class Object

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

  • Constructor Details

    • ForbidSubStr

      public ForbidSubStr(List<String> forbiddenSubStrings)
      Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings.
      Parameters:
      forbiddenSubStrings - the List of forbidden substrings
      Throws:
      NullPointerException - if forbiddenSubStrings or one of its elements is null
      IllegalArgumentException - if forbiddenSubStrings is empty

    • ForbidSubStr

      public ForbidSubStr(String... forbiddenSubStrings)
      Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings.
      Parameters:
      forbiddenSubStrings - the forbidden substrings
      Throws:
      NullPointerException - if forbiddenSubStrings or one of its elements is null
      IllegalArgumentException - if forbiddenSubStrings is empty

    • ForbidSubStr

      public ForbidSubStr(List<String> forbiddenSubStrings, CellProcessor next)
      Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings, then calls the next processor in the chain.
      Parameters:
      forbiddenSubStrings - the List of forbidden substrings
      next - the next processor in the chain
      Throws:
      NullPointerException - if forbiddenSubStrings, one of its elements or next is null
      IllegalArgumentException - if forbiddenSubStrings is empty

    • ForbidSubStr

      public ForbidSubStr(String forbiddenSubString, CellProcessor next)
      Constructs a new ForbidSubStr processor which ensures the input doesn't contain the supplied substring, then calls the next processor in the chain.
      Parameters:
      forbiddenSubString - the forbidden substring
      next - the next processor in the chain
      Throws:
      NullPointerException - if forbiddenSubString or next is null

    • ForbidSubStr

      public ForbidSubStr(String[] forbiddenSubStrings, CellProcessor next)
      Constructs a new ForbidSubStr processor which ensures the input doesn't contain any of the supplied substrings, then calls the next processor in the chain.
      Parameters:
      forbiddenSubStrings - the forbidden substrings
      next - the next processor in the chain
      Throws:
      NullPointerException - if forbiddenSubStrings, one of its elements or next is null
      IllegalArgumentException - if forbiddenSubStrings is empty

  • Method Details