org.dromara.hutool.cron.pattern.CronPatternUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hutool-cron Show documentation
Hutool 定时任务
There is a newer version: 6.0.0.M3
/*
 * Copyright (c) 2023 looly([email protected])
 * Hutool is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *          https://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */

package org.dromara.hutool.cron.pattern;

import org.dromara.hutool.core.date.CalendarUtil;
import org.dromara.hutool.core.date.DateUtil;
import org.dromara.hutool.core.lang.Assert;

import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.List;

/**
 * 定时任务表达式工具类
 *
 * @author looly
 *
 */
public class CronPatternUtil {

	/**
	 * 列举指定日期之后（到开始日期对应年年底）内第一个匹配表达式的日期
	 *
	 * @param pattern 表达式
	 * @param start 起始时间
	 * @return 日期
	 * @since 4.5.8
	 */
	public static Date nextDateAfter(final CronPattern pattern, final Date start) {
		return DateUtil.date(pattern.nextMatchAfter(CalendarUtil.calendar(start)));
	}

	/**
	 * 列举指定日期之后（到开始日期对应年年底）内所有匹配表达式的日期
	 *
	 * @param patternStr 表达式字符串
	 * @param start 起始时间
	 * @param count 列举数量
	 * @return 日期列表
	 */
	public static List matchedDates(final String patternStr, final Date start, final int count) {
		return matchedDates(patternStr, start, DateUtil.endOfYear(start), count);
	}

	/**
	 * 列举指定日期范围内所有匹配表达式的日期
	 *
	 * @param patternStr 表达式字符串
	 * @param start 起始时间
	 * @param end 结束时间
	 * @param count 列举数量
	 * @return 日期列表
	 */
	public static List matchedDates(final String patternStr, final Date start, final Date end, final int count) {
		return matchedDates(patternStr, start.getTime(), end.getTime(), count);
	}

	/**
	 * 列举指定日期范围内所有匹配表达式的日期
	 *
	 * @param patternStr 表达式字符串
	 * @param start 起始时间
	 * @param end 结束时间
	 * @param count 列举数量
	 * @return 日期列表
	 */
	public static List matchedDates(final String patternStr, final long start, final long end, final int count) {
		return matchedDates(new CronPattern(patternStr), start, end, count);
	}

	/**
	 * 列举指定日期范围内所有匹配表达式的日期
	 *
	 * @param pattern 表达式
	 * @param start 起始时间
	 * @param end 结束时间
	 * @param count 列举数量
	 * @return 日期列表
	 */
	public static List matchedDates(final CronPattern pattern, final long start, final long end, final int count) {
		Assert.isTrue(start < end, "Start date is later than end !");

		final List result = new ArrayList<>(count);

		Calendar calendar = pattern.nextMatchAfter(CalendarUtil.calendar(start));
		while(calendar.getTimeInMillis() < end){
			result.add(DateUtil.date(calendar));
			if(result.size() >= count){
				break;
			}
			calendar = pattern.nextMatchAfter(calendar);
		}

		return result;
	}
}