net.objectlab.kit.datecalc.common

Interface PeriodCountCalculator<E>

Type Parameters:

E - a representation of a date, typically JDK: Date, Calendar; Joda:LocalDate, YearMonthDay

All Known Implementing Classes:

CalendarPeriodCountCalculator, DatePeriodCountCalculator, LocalDatePeriodCountCalculator, LocalDatePeriodCountCalculator

public interface PeriodCountCalculator<E>

Interface that defines a financial market way of calculating difference in days, month (or part of) and year (or part of).

Author:

Benoit Xhenseval

Method Summary

Modifier and Type	Method and Description
int	dayDiff(E start, E end, PeriodCountBasis basis) This calculates the number of days between 2 dates, it follows the given basis which means that the result could vary between the same 2 dates if the basis is different.
double	monthDiff(E start, E end, PeriodCountBasis basis) This calculates the number of months (or fraction) between 2 dates, it follows the given basis which means that the result could vary between the same 2 dates if the basis is different.
double	yearDiff(E start, E end, PeriodCountBasis basis) This calculates the number of years (or fraction) between 2 dates, it follows the given basis which means that the result could vary between the same 2 dates if the basis is different.

Method Detail

dayDiff

int dayDiff(E start,
            E end,
            PeriodCountBasis basis)

This calculates the number of days between 2 dates, it follows the given basis which means that the result could vary between the same 2 dates if the basis is different.

Parameters:

start - the start date

end - the end date

basis - the basis to use

Returns:

number of days between end and start.

monthDiff

double monthDiff(E start,
                 E end,
                 PeriodCountBasis basis)

This calculates the number of months (or fraction) between 2 dates, it follows the given basis which means that the result could vary between the same 2 dates if the basis is different.

Parameters:

start - the start date

end - the end date

basis - the basis to use

Returns:

number of months between end and start.

yearDiff

double yearDiff(E start,
                E end,
                PeriodCountBasis basis)

This calculates the number of years (or fraction) between 2 dates, it follows the given basis which means that the result could vary between the same 2 dates if the basis is different.

Parameters:

start - the start date

end - the end date

basis - the basis to use

Returns:

number of months between end and start.