BusinessDay (app.pickmaven:businessdays 1.0.0 API)

java.lang.Object
- app.pickmaven.businessdays.BusinessDay

```
public class BusinessDay
extends Object
```
This class is responsible for computing the next business day.
app.pickmaven.businessdays.BusinessDay stores an app.pickmaven.businessdays.Holidays object. It offers different construction methods for setting up some configurations such as the weekdays that will be treated as holidays or also the temporal range to which the calculation is applied.
This class is immutable and thread-safe.

Author:

Daniele Gubbiotti

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`BusinessDay.Builder` Public builder for creating instances of `app.pickmaven.businessdays.BusinessDay` objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`asDate()`
`String`	`asDateTimeDuration(String... hoursMinutesCommaSeparated)` Prints the duration between current date and the next business day as a string in format 'PnDTnHnMnS'.
`java.time.Duration`	`asDuration(String... hoursMinutesCommaSeparated)` Prints the `Duration` between current date and the next business day.
`java.time.LocalDate`	`asLocalDate()`
`Long`	`asLong(int... hoursMinutesSecondsCommaSeparated)` Return next business day as long value given hours, minutes and seconds to add.
`java.time.Period`	`asPeriod()`
`String`	`asString(java.time.format.DateTimeFormatter formatter)` Outputs the date as string given a `DateTimeFormatte`.
`String`	`asString(String pattern)` Outputs the date as string given a string formatter.
`Holidays`	`getHolidays(Integer... years)` Gets the `app.pickmaven.businessdays.Holidays` object; this method gives you the possibility to filter the holidays based on years you pass as integers.
`Holidays`	`getHolidaysForTemporalRange(TemporalRange range)` Gets the `app.pickmaven.businessdays.Holidays` object filtered based temporal range you pass as parameter.
`Holidays`	`getHolidaysFromNow(Integer... years)` Gets the `app.pickmaven.businessdays.Holidays` object starting from current date; this method gives you the possibility to filter the holidays based on years you pass as integers.
`Holidays`	`getHolidaysFromStartingDate(Integer... years)` Gets the `app.pickmaven.businessdays.Holidays` object starting from starting date; this method gives you the possibility to filter the holidays based on years you pass as integers.
`BusinessDay`	`nextBusinessDay()` Computes the next business day based on certain conditions.
`BusinessDay`	`nextBusinessDay(int workDays)` Computes the next business day based on certain conditions adding a specific number of workdays.

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

- Method Detail
  - nextBusinessDay
```
public BusinessDay nextBusinessDay()
```
    Computes the next business day based on certain conditions.
    This method checks if starting date is not a business saturday or sunday, is not an holiday weekday or an holiday adding a day to the starting one only if theese conditions are met.
    
    Returns:
    
    the next business day
  - nextBusinessDay
```
public BusinessDay nextBusinessDay(int workDays)
```
    Computes the next business day based on certain conditions adding a specific number of workdays.
    This method checks if starting date is not a business saturday or sunday, is not an holiday weekday or an holiday adding days to the starting one only if theese conditions are met.
    
    Parameters:
    
    workDays - the number to add from starting date
    
    Returns:
    
    the next business day
  - asLocalDate
```
public java.time.LocalDate asLocalDate()
```
    Returns:
    
    next business day as LocalDate
  - asDate
```
public Date asDate()
```
    Returns:
    
    next business day as Date
  - asLong
```
public Long asLong(int... hoursMinutesSecondsCommaSeparated)
```
    Return next business day as long value given hours, minutes and seconds to add.
    
    Parameters:
    
    hoursMinutesSecondsCommaSeparated - hours, minutes and seconds comma separated; default '0'
    
    Returns:
    
    next business day as long value
  - asString
```
public String asString(java.time.format.DateTimeFormatter formatter)
```
    Outputs the date as string given a DateTimeFormatte.
    
    Parameters:
    
    formatter - DateTimeFormatter pattern object for formatting the string
    
    Returns:
    
    next business day as formatted string
  - asString
```
public String asString(String pattern)
```
    Outputs the date as string given a string formatter.
    
    Parameters:
    
    pattern - pattern for formatting the string
    
    Returns:
    
    next business day as formatted string
  - asPeriod
```
public java.time.Period asPeriod()
```
    Returns:
    
    next business day as Period
  - asDuration
```
public java.time.Duration asDuration(String... hoursMinutesCommaSeparated)
```
    Prints the Duration between current date and the next business day.
    
    Parameters:
    
    hoursMinutesCommaSeparated - hours and minutes comma separated, default '00'
    
    Returns:
    
    interval between today and next business day as Duration
  - asDateTimeDuration
```
public String asDateTimeDuration(String... hoursMinutesCommaSeparated)
```
    Prints the duration between current date and the next business day as a string in format 'PnDTnHnMnS'.
    
    Parameters:
    
    hoursMinutesCommaSeparated - hours and minutes comma separated, default '00'
    
    Returns:
    
    interval between today and next business day as String
  - getHolidays
```
public Holidays getHolidays(Integer... years)
```
    Gets the app.pickmaven.businessdays.Holidays object; this method gives you the possibility to filter the holidays based on years you pass as integers.
    
    Parameters:
    
    years - Integer[] years for filtering the holidays in app.pickmaven.businessdays.Holidays object
    
    Returns:
    
    app.pickmaven.businessdays.Holidays
  - getHolidaysFromNow
```
public Holidays getHolidaysFromNow(Integer... years)
```
    Gets the app.pickmaven.businessdays.Holidays object starting from current date; this method gives you the possibility to filter the holidays based on years you pass as integers.
    
    Parameters:
    
    years - Integer[] years for filtering the holidays in app.pickmaven.businessdays.Holidays object
    
    Returns:
    
    app.pickmaven.businessdays.Holidays
  - getHolidaysFromStartingDate
```
public Holidays getHolidaysFromStartingDate(Integer... years)
```
    Gets the app.pickmaven.businessdays.Holidays object starting from starting date; this method gives you the possibility to filter the holidays based on years you pass as integers.
    
    Parameters:
    
    years - Integer[] years for filtering the holidays in app.pickmaven.businessdays.Holidays object
    
    Returns:
    
    app.pickmaven.businessdays.Holidays
  - getHolidaysForTemporalRange
```
public Holidays getHolidaysForTemporalRange(TemporalRange range)
```
    Gets the app.pickmaven.businessdays.Holidays object filtered based temporal range you pass as parameter.
    
    Parameters:
    
    range - app.pickmaven.businessdays.TemporalRange range for filtering the holidays in app.pickmaven.businessdays.Holidays object
    
    Returns:
    
    app.pickmaven.businessdays.Holidays

Class BusinessDay

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

nextBusinessDay

nextBusinessDay

asLocalDate

asDate

asLong

asString

asString

asPeriod

asDuration

asDateTimeDuration

getHolidays

getHolidaysFromNow

getHolidaysFromStartingDate

getHolidaysForTemporalRange