org.sellcom.geotemporal.time.HolidayPredicate Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015-2017 Petr Zelenka .
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sellcom.geotemporal.time;

import java.time.temporal.Temporal;
import java.util.EnumSet;

import org.sellcom.geotemporal.geography.GeoRegion;
import org.sellcom.geotemporal.geography.GeoRegionNotSupportedException;

/**
 * Predicate determining holidays.
 *
 * @since 1.0
 */
@FunctionalInterface
public interface HolidayPredicate {

	/**
	 * Checks whether the given temporal is a holiday in the given region.
	 * 
	 * Only considers holidays of the given types.
	 *
	 * @throws IllegalArgumentException if {@code temporal} is {@code null}
	 * @throws IllegalArgumentException if {@code region} is {@code null}
	 * @throws IllegalArgumentException if {@code types} is {@code null}
	 * @throws GeoRegionNotSupportedException if the given region is not supported
	 *
	 * @since 1.0
	 */
	boolean test(Temporal temporal, GeoRegion region, EnumSet types);

}