cn.hutool.cron.pattern.Part Maven / Gradle / Ivy
package cn.hutool.cron.pattern;
import cn.hutool.core.date.Month;
import cn.hutool.core.date.Week;
import cn.hutool.core.lang.Assert;
import cn.hutool.cron.CronException;
import java.util.Calendar;
/**
* 表达式各个部分的枚举，用于限定在表达式中的位置和规则（如最小值和最大值）
* {@link #ordinal()}表示此部分在表达式中的位置，如0表示秒
* 表达式各个部分的枚举位置为：
*
* 0 1 2 3 4 5 6
* [SECOND] MINUTE HOUR DAY_OF_MONTH MONTH DAY_OF_WEEK [YEAR]
*
*
* @author looly
* @since 5.8.0
*/
public enum Part {
SECOND(Calendar.SECOND, 0, 59),
MINUTE(Calendar.MINUTE, 0, 59),
HOUR(Calendar.HOUR_OF_DAY, 0, 23),
DAY_OF_MONTH(Calendar.DAY_OF_MONTH, 1, 31),
MONTH(Calendar.MONTH, Month.JANUARY.getValueBaseOne(), Month.DECEMBER.getValueBaseOne()),
DAY_OF_WEEK(Calendar.DAY_OF_WEEK, Week.SUNDAY.ordinal(), Week.SATURDAY.ordinal()),
YEAR(Calendar.YEAR, 1970, 2099);
// ---------------------------------------------------------------
private static final Part[] ENUMS = Part.values();
private final int calendarField;
private final int min;
private final int max;
/**
* 构造
*
* @param calendarField Calendar中对应字段项
* @param min 限定最小值（包含）
* @param max 限定最大值（包含）
*/
Part(int calendarField, int min, int max) {
this.calendarField = calendarField;
if (min > max) {
this.min = max;
this.max = min;
} else {
this.min = min;
this.max = max;
}
}
/**
* 获取Calendar中对应字段项
*
* @return Calendar中对应字段项
*/
public int getCalendarField() {
return this.calendarField;
}
/**
* 获取最小值
*
* @return 最小值
*/
public int getMin() {
return this.min;
}
/**
* 获取最大值
*
* @return 最大值
*/
public int getMax() {
return this.max;
}
/**
* 检查单个值是否有效
*
* @param value 值
* @return 检查后的值
* @throws CronException 检查无效抛出此异常
*/
public int checkValue(int value) throws CronException {
Assert.checkBetween(value, min, max,
() -> new CronException("{} value {} out of range: [{} , {}]", this.name(), value, min, max));
return value;
}
/**
* 根据位置获取Part
*
* @param i 位置，从0开始
* @return Part
*/
public static Part of(int i) {
return ENUMS[i];
}
}