com.github.jferard.fastods.util

Class ValidationBuilder

java.lang.Object

com.github.jferard.fastods.util.ValidationBuilder

public class ValidationBuilder
extends Object

A builder for cell content validation.

Constructor Summary

Constructors

Constructor and Description
ValidationBuilder(String name)

Method Summary

Modifier and Type	Method and Description
ValidationBuilder	baseCellAddress(CellRef baseCellAddress) Change base cell address for formulas
Validation	build()
ValidationBuilder	displayList(DisplayList displayList)
ValidationBuilder	dontAllowEmptyCells() Do not allow empty cell (allow is the default)
ValidationBuilder	errorMessage(ErrorMessage errorMessage) Set an error message.
ValidationBuilder	listCondition(Collection<String> allowedValues) Create a condition on a list of allowed values

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationBuilder

public ValidationBuilder(String name)

Method Detail

dontAllowEmptyCells

public ValidationBuilder dontAllowEmptyCells()

Do not allow empty cell (allow is the default)

Returns:

this for fluent style

baseCellAddress

public ValidationBuilder baseCellAddress(CellRef baseCellAddress)

Change base cell address for formulas

Parameters:

baseCellAddress - the base cell address

Returns:

this for fluent style

listCondition

public ValidationBuilder listCondition(Collection<String> allowedValues)

Create a condition on a list of allowed values

Parameters:

allowedValues - the list of allowed values

Returns:

this for fluent style

displayList

public ValidationBuilder displayList(DisplayList displayList)

Parameters:

displayList - the display list mode: none, sort-ascending or unsorted

Returns:

this for fluent style

errorMessage

public ValidationBuilder errorMessage(ErrorMessage errorMessage)

Set an error message.

Parameters:

errorMessage - the error message

Returns:

this for fluent style

build

public Validation build()

Returns:

the validation