org.apache.poi.ss.formula.functions

Class WeekdayFunc

java.lang.Object

org.apache.poi.ss.formula.functions.WeekdayFunc

All Implemented Interfaces:

Function

public final class WeekdayFunc
extends java.lang.Object
implements Function

Implementation for the Excel function WEEKDAY

Field Summary

Fields

Modifier and Type	Field and Description
static Function	instance

Method Summary

Modifier and Type	Method and Description
ValueEval	evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex) Perform WEEKDAY(date, returnOption) function.

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static final Function instance

Method Detail

evaluate

public ValueEval evaluate(ValueEval[] args,
                          int srcRowIndex,
                          int srcColumnIndex)

Perform WEEKDAY(date, returnOption) function.

https://support.microsoft.com/en-us/office/weekday-function-60e44483-2ed1-439f-8bd0-e404c190949a

Specified by:

evaluate in interface Function

Parameters:

args - the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcRowIndex - row index of the cell containing the formula under evaluation

srcColumnIndex - column index of the cell containing the formula under evaluation

Returns:

The evaluated result, possibly an ErrorEval, never null. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double.NaN be sure to translate the result to ErrorEval.NUM_ERROR.