Holidays (app.pickmaven:businessdays 1.0.1 API)

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

```
public class Holidays
extends Object
```
The collection object storing reference to the app.pickmaven.businessdays.Holiday objects.
app.pickmaven.businessdays.Holidays stores a List<app.pickmaven.businessdays.Holiday> object and implements some operations of List interface such as Add, Remove, Contains, Get and others.
The List<app.pickmaven.businessdays.Holiday> stored iside the app.pickmaven.businessdays.Holidays object is implemented by default as an ArrayList<T>. The implemention can be set as LinkedList<T> calling the method asLinkedList.

Constructor Summary

Constructors
Constructor and Description
`Holidays()` Constructor
`Holidays(Holidays holidays)` Constructor from `app.pickmaven.businessdays.Holidays`
`Holidays(List<java.time.LocalDate> holidayList)` Constructor from a list of `LocalDate`
`Holidays(String delimiter, String... monthsAndDays)` Constructor from an array of months and days and a delimiter.
`Holidays(String dayMonthDelimiter, String dateDelimiter, String holidayList)` Constructor from list of holiday, given a date delimiter and a day-month delimiter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Holiday holiday)` Adds the `app.pickmaven.businessdays.Holiday` to `app.pickmaven.businessdays.Holidays`
`boolean`	`addAll(Holidays holidays)` Adds all `app.pickmaven.businessdays.Holiday` of holidays to this.
`Holidays`	`asLinkedList()` Sets the internal implementation of list of holidas as `LinkedList`.
`boolean`	`contains(Holiday holiday)` Checks if `app.pickmaven.businessdays.Holidays` contains `app.pickmaven.businessdays.Holiday` passed as parameter.
`boolean`	`containsAll(Holidays holidayList)` Checks if this `app.pickmaven.businessdays.Holidays` contains all elements of the `app.pickmaven.businessdays.Holidays` object passed in as parameter.
`Holiday`	`get(int i)` Returns the `app.pickmaven.businessdays.Holiday` at position i.
`String`	`getAsString(int i, java.time.format.DateTimeFormatter formatter)` Returns the date as string of `app.pickmaven.businessdays.Holiday` at position i, given a formatter pattern.
`List<Holiday>`	`getHolidays()` Gets the list of `app.pickmaven.businessdays.Holiday`.
`boolean`	`remove(Holiday holiday)` Removes holiday from `app.pickmaven.businessdays.Holidays` if exists
`boolean`	`removeIf(java.util.function.Predicate<? super Holiday> filter)` This method removes all `app.pickmaven.businessdays.Holiday` in `app.pickmaven.businessdays.Holidays` where the filter applies.
`int`	`size()`
`java.util.stream.Stream<Holiday>`	`stream()`

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

- Constructor Detail
  - Holidays
```
public Holidays()
```
    Constructor
  - Holidays
```
public Holidays(Holidays holidays)
```
    Constructor from app.pickmaven.businessdays.Holidays
    
    Parameters:
    
    holidays - from which get the holiday list
  - Holidays
```
public Holidays(List<java.time.LocalDate> holidayList)
```
    Constructor from a list of LocalDate
    
    Parameters:
    
    holidayList - list of Holiday
  - Holidays
```
public Holidays(String delimiter,
                String... monthsAndDays)
```
    Constructor from an array of months and days and a delimiter. The year of holiday date is the current year.
    
    Parameters:
    
    delimiter - delimiter for splitting monthAndDay dates
    
    monthsAndDays - String[] months and days
  - Holidays
```
public Holidays(String dayMonthDelimiter,
                String dateDelimiter,
                String holidayList)
```
    Constructor from list of holiday, given a date delimiter and a day-month delimiter.
    
    Parameters:
    
    dayMonthDelimiter - delimiter for splitting day and month
    
    dateDelimiter - delimiter for splitting dates
    
    holidayList - list of holiday
- Method Detail
  - add
```
public void add(Holiday holiday)
```
    Adds the app.pickmaven.businessdays.Holiday to app.pickmaven.businessdays.Holidays
    
    Parameters:
    
    holiday - to add, not null
  - remove
```
public boolean remove(Holiday holiday)
```
    Removes holiday from app.pickmaven.businessdays.Holidays if exists
    
    Parameters:
    
    holiday - to search for and remove, not null
    
    Returns:
    
    true if holiday has been removed
  - contains
```
public boolean contains(Holiday holiday)
```
    Checks if app.pickmaven.businessdays.Holidays contains app.pickmaven.businessdays.Holiday passed as parameter.
    
    Parameters:
    
    holiday - to search for, not null
    
    Returns:
    
    true if app.pickmaven.businessdays.Holidays contains holiday
  - containsAll
```
public boolean containsAll(Holidays holidayList)
```
    Checks if this app.pickmaven.businessdays.Holidays contains all elements of the app.pickmaven.businessdays.Holidays object passed in as parameter.
    
    Parameters:
    
    holidayList - app.pickmaven.businessdays.Holidays this should contain
    
    Returns:
    
    true if all elements of holidayList is contained in this app.pickmaven.businessdays.Holidays
  - size
```
public int size()
```
    Returns:
    
    number of elements in app.pickmaven.businessdays.Holidays
  - asLinkedList
```
public Holidays asLinkedList()
```
    Sets the internal implementation of list of holidas as LinkedList.
    
    Returns:
    
    this
  - getHolidays
```
public List<Holiday> getHolidays()
```
    Gets the list of app.pickmaven.businessdays.Holiday. Side-effect free.
    
    Returns:
    
    list of app.pickmaven.businessdays.Holiday
  - get
```
public Holiday get(int i)
```
    Returns the app.pickmaven.businessdays.Holiday at position i.
    
    Parameters:
    
    i - position of app.pickmaven.businessdays.Holiday in the list
    
    Returns:
    
    app.pickmaven.businessdays.Holiday
  - getAsString
```
public String getAsString(int i,
                          java.time.format.DateTimeFormatter formatter)
```
    Returns the date as string of app.pickmaven.businessdays.Holiday at position i, given a formatter pattern.
    
    Parameters:
    
    i - position in the list
    
    formatter - pattern for formatting the string
    
    Returns:
    
    string representing date of app.pickmaven.businessdays.Holiday
  - removeIf
```
public boolean removeIf(java.util.function.Predicate<? super Holiday> filter)
```
    This method removes all app.pickmaven.businessdays.Holiday in app.pickmaven.businessdays.Holidays where the filter applies.
    
    Parameters:
    
    filter - predicate to apply
    
    Returns:
    
    true if element has been removed
  - stream
```
public java.util.stream.Stream<Holiday> stream()
```
    Returns:
    
    a Stream<app.pickmaven.businessdays.Holiday> from the app.pickmaven.businessdays.Holidays.
  - addAll
```
public boolean addAll(Holidays holidays)
```
    Adds all app.pickmaven.businessdays.Holiday of holidays to this.
    
    Parameters:
    
    holidays - app.pickmaven.businessdays.Holidays to add
    
    Returns:
    
    true if all elements in holidays has been added to this

Class Holidays

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Holidays

Holidays

Holidays

Holidays

Holidays

Method Detail

add

remove

contains

containsAll

size

asLinkedList

getHolidays

get

getAsString

removeIf

stream

addAll