Package org.supercsv.cellprocessor
Class Truncate
- java.lang.Object
-
- org.supercsv.cellprocessor.CellProcessorAdaptor
-
- org.supercsv.cellprocessor.Truncate
-
- All Implemented Interfaces:
BoolCellProcessor
,CellProcessor
,DateCellProcessor
,DoubleCellProcessor
,LongCellProcessor
,StringCellProcessor
public class Truncate extends CellProcessorAdaptor implements BoolCellProcessor, DateCellProcessor, DoubleCellProcessor, LongCellProcessor, StringCellProcessor
Ensure that Strings or String-representations of objects are truncated to a maximum size. If you desire, you can append a String to denote that the data has been truncated (e.g. "...").As of 2.0.0, this functionality was moved from the
Trim
processor to this processor, to allow a clear distinction between trimming and truncating.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
EMPTY_STRING
private int
maxSize
private java.lang.String
suffix
-
Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor
next
-
-
Constructor Summary
Constructors Constructor Description Truncate(int maxSize)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size.Truncate(int maxSize, java.lang.String suffix)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size, then appends thesuffix
String to indicate that the String has been truncated.Truncate(int maxSize, java.lang.String suffix, StringCellProcessor next)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size, then appends thesuffix
String to indicate that the String has been truncated and calls the next processor in the chain.Truncate(int maxSize, StringCellProcessor next)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size, 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(int maxSize, java.lang.String suffix)
Checks the preconditions for creating a new Truncate processor.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
-
-
-
-
Field Detail
-
EMPTY_STRING
private static final java.lang.String EMPTY_STRING
- See Also:
- Constant Field Values
-
maxSize
private final int maxSize
-
suffix
private final java.lang.String suffix
-
-
Constructor Detail
-
Truncate
public Truncate(int maxSize)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size.- Parameters:
maxSize
- the maximum size of the String- Throws:
java.lang.IllegalArgumentException
- ifmaxSize <= 0
-
Truncate
public Truncate(int maxSize, java.lang.String suffix)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size, then appends thesuffix
String to indicate that the String has been truncated.- Parameters:
maxSize
- the maximum size of the Stringsuffix
- the String to append if the input is truncated (e.g. "...")- Throws:
java.lang.IllegalArgumentException
- ifmaxSize <= 0
java.lang.NullPointerException
- if suffix is null
-
Truncate
public Truncate(int maxSize, java.lang.String suffix, StringCellProcessor next)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size, then appends thesuffix
String to indicate that the String has been truncated and calls the next processor in the chain.- Parameters:
maxSize
- the maximum size of the Stringsuffix
- the String to append if the input is truncated (e.g. "...")next
- the next processor in the chain- Throws:
java.lang.IllegalArgumentException
- ifmaxSize <= 0
java.lang.NullPointerException
- if suffix or next is null
-
Truncate
public Truncate(int maxSize, StringCellProcessor next)
Constructs a new Truncate processor, which truncates a String to ensure it is no longer than the specified size, then calls the next processor in the chain.- Parameters:
maxSize
- the maximum size of the Stringnext
- the next processor in the chain- Throws:
java.lang.IllegalArgumentException
- ifmaxSize <= 0
java.lang.NullPointerException
- if next is null
-
-
Method Detail
-
checkPreconditions
private static void checkPreconditions(int maxSize, java.lang.String suffix)
Checks the preconditions for creating a new Truncate processor.- Parameters:
maxSize
- the maximum size of the Stringsuffix
- the String to append if the input is truncated (e.g. "...")- Throws:
java.lang.IllegalArgumentException
- ifmaxSize <= 0
java.lang.NullPointerException
- if suffix 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 null
-
-