org.supercsv.cellprocessor.constraint

Class StrMinMax

java.lang.Object

org.supercsv.cellprocessor.CellProcessorAdaptor

org.supercsv.cellprocessor.constraint.StrMinMax

All Implemented Interfaces:

CellProcessor, StringCellProcessor

public class StrMinMax
extends CellProcessorAdaptor
implements StringCellProcessor

This constraint ensures that the input data has a string length between the supplied min and max values (both inclusive). Should the input be anything different from a String, it will be converted to a string using the input's toString() method.

Author:

Kasper B. Graversen, James Bassett

Field Summary

Fields inherited from class org.supercsv.cellprocessor.CellProcessorAdaptor

next

Constructor Summary

Constructors

Constructor and Description
StrMinMax(long min, long max) Constructs a new StrMinMax processor, which ensures that the input data has a string length between the supplied min and max values (both inclusive).
StrMinMax(long min, long max, CellProcessor next) Constructs a new StrMinMax processor, which ensures that the input data has a string length between the supplied min and max values (both inclusive), then calls the next processor in the chain.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StrMinMax

public StrMinMax(long min,
                 long max)

Constructs a new StrMinMax processor, which ensures that the input data has a string length between the supplied min and max values (both inclusive).

Parameters:

min - the minimum String length

max - the maximum String length

Throws:

java.lang.IllegalArgumentException - if max < min, or min is < 0

StrMinMax

public StrMinMax(long min,
                 long max,
                 CellProcessor next)

Constructs a new StrMinMax processor, which ensures that the input data has a string length between the supplied min and max values (both inclusive), then calls the next processor in the chain.

Parameters:

min - the minimum String length

max - the maximum String length

next - the next processor in the chain

Throws:

java.lang.NullPointerException - if next is null

java.lang.IllegalArgumentException - if max < min, or min is < 0

Method Detail

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 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 length < min or length > max