EOMonth (POI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.ss.formula.functions
Class EOMonth

java.lang.Object
  org.apache.poi.ss.formula.functions.EOMonth

All Implemented Interfaces:: FreeRefFunction

public class EOMonth
extends java.lang.Object
implements FreeRefFunction
extends java.lang.Object
implements FreeRefFunction

Implementation for the Excel EOMONTH() function.

EOMONTH() returns the date of the last day of a month..

Syntax:
EOMONTH(start_date,months)

start_date is the starting date of the calculation months is the number of months to be added to start_date, to give a new date. For this new date, EOMONTH returns the date of the last day of the month. months may be positive (in the future), zero or negative (in the past).

Field Summary
`static FreeRefFunction`	`instance`

Constructor Summary
`EOMonth()`

Method Summary
`ValueEval`	`evaluate(ValueEval[] args, OperationEvaluationContext ec)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

instance

public static final FreeRefFunction instance

Constructor Detail

EOMonth

public EOMonth()

Method Detail

evaluate

public ValueEval evaluate(ValueEval[] args,
                          OperationEvaluationContext ec)

Specified by:: evaluate in interface FreeRefFunction

Parameters:: args - the pre-evaluated arguments for this function. args is never null, nor are any of its elements.; ec - primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.
Returns:: never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).