app.pickmaven.businessdays.api

Class PublicHolidayAPI

java.lang.Object

app.pickmaven.businessdays.api.PublicHolidayAPI

All Implemented Interfaces:

HolidaySearcher

public class PublicHolidayAPI
extends Object
implements HolidaySearcher

This class implements app.pickmaven.businessdays.api.HolidaySearcher interface for getting a list of LocalDate objects representing the holidays for specific countries using the app.pickmaven.businessdays.api.PublicHolidayAPI of RapidAPI.

This class is immutable and thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PUBLIC_HOLIDAY_P_RAPIDAPI_COM Base endpoint for calling the Rapid Api of Public app.pickmaven.businessdays.Holiday.

Constructor Summary

Constructors

Constructor and Description
PublicHolidayAPI(String api_key) Constructor In order to get an api key from RapidApi you have to log in to your Developer Dashboard and create a new App; then just grab the api key and pass it in the constructor.

Method Summary

Modifier and Type	Method and Description
void	activateLogResponse() Sets logging response to true.
PublicHolidayAPI	applyPredicate(java.util.function.Predicate<? super com.google.gson.JsonObject> predicate) Call this method for apply a {@code Predicate
List<java.time.LocalDate>	searchHolidaysFor(String countryCode) Returns a list of LocalDate representing the holidays for a specific country.
List<java.time.LocalDate>	searchHolidaysFor(String countryCode, int year) Returns a list of LocalDate representing the holidays for a specific country and for specific year.

Methods inherited from class java.lang.Object

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

Field Detail

PUBLIC_HOLIDAY_P_RAPIDAPI_COM

public static final String PUBLIC_HOLIDAY_P_RAPIDAPI_COM

Base endpoint for calling the Rapid Api of Public app.pickmaven.businessdays.Holiday.

See Also:

Constant Field Values

Constructor Detail

PublicHolidayAPI

public PublicHolidayAPI(String api_key)

Constructor

In order to get an api key from RapidApi you have to log in to your Developer Dashboard and create a new App; then just grab the api key and pass it in the constructor.

Parameters:

api_key - personal api-key, not null

Method Detail

applyPredicate

public PublicHolidayAPI applyPredicate(java.util.function.Predicate<? super com.google.gson.JsonObject> predicate)

Call this method for apply a Predicate<? super JsonObject> in order to filter the holidays.

In order to know the fields that Api will give you in response you must call the activateLogResponse method, this way you will see the system.out outputs of the response.

Parameters:

predicate - for filtering holidays from the response

Returns:

this

searchHolidaysFor

public List<java.time.LocalDate> searchHolidaysFor(String countryCode)
                                            throws IOException

Returns a list of LocalDate representing the holidays for a specific country. This method assumes you are searching holidays for current year.

Specified by:

searchHolidaysFor in interface HolidaySearcher

Parameters:

countryCode - the code of country you are searching for

Returns:

a list of holiday dates

Throws:

IOException - If connection to the api failed

See Also:

for more details on this API

searchHolidaysFor

public List<java.time.LocalDate> searchHolidaysFor(String countryCode,
                                                   int year)
                                            throws IOException

Returns a list of LocalDate representing the holidays for a specific country and for specific year.

Parameters:

countryCode - for which search holidays

year - for which you are searching holidays

Returns:

a list of holiday dates

Throws:

IOException - If connection to the api failed

See Also:

for more details on this API

activateLogResponse

public void activateLogResponse()

Sets logging response to true.