app.pickmaven.businessdays

Class Holiday

java.lang.Object

app.pickmaven.businessdays.Holiday

public class Holiday
extends Object

The base unit to refer to the holiday date.

app.pickmaven.businessdays.Holiday is an immutable object that wraps a date as a LocalDate object.

This class is immutable and thread-safe

Author:

Daniele Gubbiotti

Field Summary

Fields

Modifier and Type	Field and Description
static Holiday	CHRISTMAS The app.pickmaven.businessdays.Holiday represented by Christmas day.
static Holiday	EASTER The app.pickmaven.businessdays.Holiday represented by Easter.
static Holiday	EASTER_MONDAY The app.pickmaven.businessdays.Holiday represented by Easter Monday.
static Holiday	HOLIDAY_NOW The app.pickmaven.businessdays.Holiday represented by today.

Constructor Summary

Constructors

Constructor and Description
Holiday(Date date) Create an holiday from a Date object.
Holiday(java.time.LocalDate date) Create an holiday from a LocalDate object.
Holiday(java.time.MonthDay date) Create an holiday from a MonthDay object assuming the year as the current one.
Holiday(String date, java.time.format.DateTimeFormatter formatter) Create an holiday from a String object representing the date and a DateTimeFormatter.
Holiday(String date, SimpleDateFormat formatter) Create an holiday from a String object representing the date and a SimpleDateFormat object.
Holiday(String date, String formatter) Create an holiday from a String object representing the date and a String representing the formatter pattern.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Check if this holiday date is equal to another holiday date.
java.time.LocalDate	getDate() Gets the holiday date.
int	getDay() Gets the day of holiday.
static Holiday	getEasterMonday(int year) Return an instance of app.pickmaven.businessdays.Holiday from the Easter Monday date for the specified year.
int	getMonth() Gets the month of holiday.
int	getYear() Gets the year of holiday.
int	hashCode() A hash code for this holiday date.
static Holiday	of(int year, int month, int day) Return instance of app.pickmaven.businessdays.Holiday from year, month and day.
static Holiday	today() Return instance of @code app.pickmaven.businessdays.Holiday} with the current date.
String	toString() Outputs the holiday date as date.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HOLIDAY_NOW

public static final Holiday HOLIDAY_NOW

The app.pickmaven.businessdays.Holiday represented by today.

EASTER

public static final Holiday EASTER

The app.pickmaven.businessdays.Holiday represented by Easter.

EASTER_MONDAY

public static final Holiday EASTER_MONDAY

The app.pickmaven.businessdays.Holiday represented by Easter Monday.

CHRISTMAS

public static final Holiday CHRISTMAS

The app.pickmaven.businessdays.Holiday represented by Christmas day.

Constructor Detail

Holiday

public Holiday(java.time.LocalDate date)

Create an holiday from a LocalDate object.

Parameters:

date -

Holiday

public Holiday(String date,
               java.time.format.DateTimeFormatter formatter)

Create an holiday from a String object representing the date and a DateTimeFormatter.

Parameters:

date -

formatter -

Holiday

public Holiday(String date,
               String formatter)

Create an holiday from a String object representing the date and a String representing the formatter pattern.

Parameters:

date -

formatter -

Holiday

public Holiday(String date,
               SimpleDateFormat formatter)

Create an holiday from a String object representing the date and a SimpleDateFormat object.

Parameters:

date -

formatter -

Holiday

public Holiday(Date date)

Create an holiday from a Date object.

Parameters:

date -

Holiday

public Holiday(java.time.MonthDay date)

Create an holiday from a MonthDay object assuming the year as the current one.

Parameters:

date -

Method Detail

today

public static Holiday today()

Return instance of @code app.pickmaven.businessdays.Holiday} with the current date.

Returns:

Holiday today

of

public static Holiday of(int year,
                         int month,
                         int day)

Return instance of app.pickmaven.businessdays.Holiday from year, month and day.

Parameters:

year - of Holiday

month - of Holiday

day - of Holiday

Returns:

Holiday

getEasterMonday

public static Holiday getEasterMonday(int year)

Return an instance of app.pickmaven.businessdays.Holiday from the Easter Monday date for the specified year.

Parameters:

year - for which computing Easter Monday

Returns:

Easter Monday Holiday

getDate

public java.time.LocalDate getDate()

Gets the holiday date.

Returns:

LocalDate

getYear

public int getYear()

Gets the year of holiday.

Returns:

year of date

getMonth

public int getMonth()

Gets the month of holiday.

Returns:

month of date

getDay

public int getDay()

Gets the day of holiday.

Returns:

day of date

equals

public boolean equals(Object o)

Check if this holiday date is equal to another holiday date.

Overrides:

equals in class Object

Parameters:

o - Holiday to check equality

Returns:

true if o is equal to this

hashCode

public int hashCode()

A hash code for this holiday date.

Overrides:

hashCode in class Object

Returns:

hashcode

toString

public String toString()

Outputs the holiday date as date.

Overrides:

toString in class Object

Returns:

string representing Holiday