app.pickmaven.businessdays

Class BusinessDay.Builder

java.lang.Object

app.pickmaven.businessdays.BusinessDay.Builder

Enclosing class:

BusinessDay

public static final class BusinessDay.Builder
extends Object

Public builder for creating instances of app.pickmaven.businessdays.BusinessDay objects.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor.

Method Summary

Modifier and Type	Method and Description
static BusinessDay.Builder	aBusinessDay()
BusinessDay.Builder	applyToYears(Integer... years) Sets years to apply holidays for computing next business day.
BusinessDay	build()
BusinessDay.Builder	computingChristmas() Adds the Christmas as app.pickmaven.businessdays.Holiday if is not already present in app.pickmaven.businessdays.Holidays.
BusinessDay.Builder	computingEaster() Adds the Easter as app.pickmaven.businessdays.Holiday if is not already present in app.pickmaven.businessdays.Holidays.
BusinessDay.Builder	computingEasterMonday() Adds the Easter Monday as app.pickmaven.businessdays.Holiday if is not already present in app.pickmaven.businessdays.Holidays.
BusinessDay.Builder	fromStartingDate(java.time.LocalDate startingDate) Sets the starting day for computing the next business day.
BusinessDay.Builder	givenHolidays(Holidays holidays) Sets the app.pickmaven.businessdays.Holidays object in the app.pickmaven.businessdays.BusinessDay object.
BusinessDay.Builder	holidayOnWeekDays(java.time.DayOfWeek... weekDays) Sets weekdays as holiday.
BusinessDay.Builder	holidayOnWeekDays(TemporalRange range, java.time.DayOfWeek... weekDays) Sets weekdays as holiday, applied to specific temporal range.
BusinessDay.Builder	withBusinessSaturday(Integer... yearsOrMonths) Sets saturday as business day for years or months passed as parameter; if no years or months are passed in it sets to true.
BusinessDay.Builder	withBusinessSaturday(TemporalRange range) Sets saturday as business day for the app.pickmaven.businessdays.TemporalRange passed as parameter.
BusinessDay.Builder	withBusinessSunday(Integer... yearsOrMonths) Sets sunday as business day for years or months passed as parameter; if no years or months are passed in it sets to true.
BusinessDay.Builder	withBusinessSunday(TemporalRange range) Sets sunday as business day for the app.pickmaven.businessdays.TemporalRange passed as parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor. It sets by default an empty app.pickmaven.businessdays.Holidays object.

Method Detail

aBusinessDay

public static BusinessDay.Builder aBusinessDay()

Returns:

instance of builder

givenHolidays

public BusinessDay.Builder givenHolidays(Holidays holidays)

Sets the app.pickmaven.businessdays.Holidays object in the app.pickmaven.businessdays.BusinessDay object.

Parameters:

holidays - to assign to app.pickmaven.businessdays.BusinessDay

Returns:

this

computingEaster

public BusinessDay.Builder computingEaster()

Adds the Easter as app.pickmaven.businessdays.Holiday if is not already present in app.pickmaven.businessdays.Holidays.

Returns:

this

computingEasterMonday

public BusinessDay.Builder computingEasterMonday()

Adds the Easter Monday as app.pickmaven.businessdays.Holiday if is not already present in app.pickmaven.businessdays.Holidays.

Returns:

this

computingChristmas

public BusinessDay.Builder computingChristmas()

Adds the Christmas as app.pickmaven.businessdays.Holiday if is not already present in app.pickmaven.businessdays.Holidays.

Returns:

this

withBusinessSaturday

public BusinessDay.Builder withBusinessSaturday(Integer... yearsOrMonths)

Sets saturday as business day for years or months passed as parameter; if no years or months are passed in it sets to true.

Parameters:

yearsOrMonths - to apply business saturday

Returns:

this

withBusinessSaturday

public BusinessDay.Builder withBusinessSaturday(TemporalRange range)

Sets saturday as business day for the app.pickmaven.businessdays.TemporalRange passed as parameter.

Parameters:

range - to apply business saturday; not null

Returns:

this

withBusinessSunday

public BusinessDay.Builder withBusinessSunday(Integer... yearsOrMonths)

Sets sunday as business day for years or months passed as parameter; if no years or months are passed in it sets to true.

Parameters:

yearsOrMonths - to apply business sunday

Returns:

this

withBusinessSunday

public BusinessDay.Builder withBusinessSunday(TemporalRange range)

Sets sunday as business day for the app.pickmaven.businessdays.TemporalRange passed as parameter.

Parameters:

range, - to apply business sunday; not null

Returns:

this

holidayOnWeekDays

public BusinessDay.Builder holidayOnWeekDays(java.time.DayOfWeek... weekDays)

Sets weekdays as holiday. This method takes precedence over 'withBusinessSaturday()' and 'withBusinessSunday()' ones.

Parameters:

weekDays - DayOfWeek[] weekdays to be holiday

Returns:

this

holidayOnWeekDays

public BusinessDay.Builder holidayOnWeekDays(TemporalRange range,
                                             java.time.DayOfWeek... weekDays)

Sets weekdays as holiday, applied to specific temporal range. This method takes precedence over 'withBusinessSaturday()' and 'withBusinessSunday()' ones.

Parameters:

range - app.pickmaven.businessdays.TemporalRange to apply weekdays as holidays, not null

weekDays - DayOfWeek[] weekdays to be holiday

Returns:

this

fromStartingDate

public BusinessDay.Builder fromStartingDate(java.time.LocalDate startingDate)

Sets the starting day for computing the next business day.

Parameters:

startingDate - for computing next business day

Returns:

this

applyToYears

public BusinessDay.Builder applyToYears(Integer... years)

Sets years to apply holidays for computing next business day.

Parameters:

years - to apply holidays

Returns:

this

build

public BusinessDay build()

Returns:

app.pickmaven.businessdays.BusinessDay instance