Class RequireSubStr
- java.lang.Object
-
- org.supercsv.cellprocessor.CellProcessorAdaptor
-
- org.supercsv.cellprocessor.constraint.RequireSubStr
-
- All Implemented Interfaces:
CellProcessor
,StringCellProcessor
public class RequireSubStr extends CellProcessorAdaptor implements StringCellProcessor
Converts the input to a String and ensures that the input contains at least one of the specified substrings.- Since:
- 1.10
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<java.lang.String>
requiredSubStrings
-
Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor
next
-
-
Constructor Summary
Constructors Constructor Description RequireSubStr(java.lang.String... requiredSubStrings)
Converts the input to a String and ensures that the input contains at least one of the specified substrings.RequireSubStr(java.lang.String[] requiredSubStrings, CellProcessor next)
Converts the input to a String, ensures that the input contains at least one of the specified substrings, then calls the next processor in the chain.RequireSubStr(java.lang.String requiredSubString, CellProcessor next)
Converts the input to a String, ensures that the input contains the specified substring, then calls the next processor in the chain.RequireSubStr(java.util.List<java.lang.String> requiredSubStrings, CellProcessor next)
Converts the input to a String, ensures that the input contains at least one of the specified substrings, then calls the next processor in the chain.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
checkAndAddRequiredSubStrings(java.lang.String... requiredSubStrings)
Adds each required substring, checking that it's not null.private void
checkAndAddRequiredSubStrings(java.util.List<java.lang.String> requiredSubStrings)
Adds each required substring, checking that it's not null.private static void
checkPreconditions(java.lang.String... requiredSubStrings)
Checks the preconditions for creating a new RequireSubStr processor with an array of Strings.private static void
checkPreconditions(java.util.List<java.lang.String> requiredSubStrings)
Checks the preconditions for creating a new RequireSubStr processor with a List of Strings.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
-
RequireSubStr
public RequireSubStr(java.lang.String... requiredSubStrings)
Converts the input to a String and ensures that the input contains at least one of the specified substrings.- Parameters:
requiredSubStrings
- the required substrings- Throws:
java.lang.NullPointerException
- if requiredSubStrings or one of its elements is nulljava.lang.IllegalArgumentException
- if requiredSubStrings is empty
-
RequireSubStr
public RequireSubStr(java.util.List<java.lang.String> requiredSubStrings, CellProcessor next)
Converts the input to a String, ensures that the input contains at least one of the specified substrings, then calls the next processor in the chain.- Parameters:
requiredSubStrings
- the List of required substringsnext
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if requiredSubStrings, one of its elements or next is nulljava.lang.IllegalArgumentException
- if requiredSubStrings is empty
-
RequireSubStr
public RequireSubStr(java.lang.String requiredSubString, CellProcessor next)
Converts the input to a String, ensures that the input contains the specified substring, then calls the next processor in the chain.- Parameters:
requiredSubString
- the required substringnext
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if requiredSubString or next is null
-
RequireSubStr
public RequireSubStr(java.lang.String[] requiredSubStrings, CellProcessor next)
Converts the input to a String, ensures that the input contains at least one of the specified substrings, then calls the next processor in the chain.- Parameters:
requiredSubStrings
- the List of required substringsnext
- the next processor in the chain- Throws:
java.lang.NullPointerException
- if requiredSubStrings, one of its elements or next is nulljava.lang.IllegalArgumentException
- if requiredSubStrings is empty
-
-
Method Detail
-
checkPreconditions
private static void checkPreconditions(java.lang.String... requiredSubStrings)
Checks the preconditions for creating a new RequireSubStr processor with an array of Strings.- Parameters:
requiredSubStrings
- the required substrings- Throws:
java.lang.NullPointerException
- if requiredSubStrings or one of its elements is nulljava.lang.IllegalArgumentException
- if requiredSubStrings is empty
-
checkPreconditions
private static void checkPreconditions(java.util.List<java.lang.String> requiredSubStrings)
Checks the preconditions for creating a new RequireSubStr processor with a List of Strings.- Parameters:
requiredSubStrings
- the required substrings- Throws:
java.lang.NullPointerException
- if requiredSubStrings or one of its elements is nulljava.lang.IllegalArgumentException
- if requiredSubStrings is empty
-
checkAndAddRequiredSubStrings
private void checkAndAddRequiredSubStrings(java.util.List<java.lang.String> requiredSubStrings)
Adds each required substring, checking that it's not null.- Parameters:
requiredSubStrings
- the required substrings- Throws:
java.lang.NullPointerException
- if a required substring is null
-
checkAndAddRequiredSubStrings
private void checkAndAddRequiredSubStrings(java.lang.String... requiredSubStrings)
Adds each required substring, checking that it's not null.- Parameters:
requiredSubStrings
- the required substrings- Throws:
java.lang.NullPointerException
- if a required substring is null
-
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 doesn't contain any of the required substrings
-
-