com.doyospy.core.date.Week Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of doyospy-all Show documentation
Doyospy是一个小而全的基于SpringBoot的java工具类库，通过静态方法封装，方便开发者使用，降低学习成本并提升工作效率。
The newest version!
package com.doyospy.core.date;

import java.time.DayOfWeek;
import java.util.Calendar;

/**
 * 星期枚举
 */
public enum Week {
    /**
     * 周日
     */
    SUNDAY(Calendar.SUNDAY),
    /**
     * 周一
     */
    MONDAY(Calendar.MONDAY),
    /**
     * 周二
     */
    TUESDAY(Calendar.TUESDAY),
    /**
     * 周三
     */
    WEDNESDAY(Calendar.WEDNESDAY),
    /**
     * 周四
     */
    THURSDAY(Calendar.THURSDAY),
    /**
     * 周五
     */
    FRIDAY(Calendar.FRIDAY),
    /**
     * 周六
     */
    SATURDAY(Calendar.SATURDAY);
    ;

    /**
     * Weeks aliases.
     */
    private static final String[] ALIASES = {"sun", "mon", "tue", "wed", "thu", "fri", "sat"};
    private static final Week[] ENUMS = Week.values();

    /**
     * 星期对应{@link Calendar} 中的Week值
     */
    private final int value;

    /**
     * 构造
     *
     * @param value 星期对应{@link Calendar}中的Week值
     */
    Week(int value) {
        this.value = value;
    }

    /**
     * 获取星期对应的{@link Calendar}中的Week值
     *
     * @return 星期对应的{@link Calendar}中的Week值
     */
    public int getValue() {
        return this.value;
    }

    /**
     * 获取ISO8601规范的int值，from 1 (Monday) to 7 (Sunday).
     *
     * @return ISO8601规范的int值
     * @since 5.8.0
     */
    public int getIso8601Value(){
        int iso8601IntValue = getValue() -1;
        if(0 == iso8601IntValue){
            iso8601IntValue = 7;
        }
        return iso8601IntValue;
    }

    /**
     * 转换为中文名
     *
     * @return 星期的中文名
     * @since 3.3.0
     */
    public String toChinese() {
        return toChinese("星期");
    }

    /**
     * 转换为中文名
     *
     * @param weekNamePre 表示星期的前缀，例如前缀为“星期”，则返回结果为“星期一”；前缀为”周“，结果为“周一”
     * @return 星期的中文名
     * @since 4.0.11
     */
    public String toChinese(String weekNamePre) {
        switch (this) {
            case SUNDAY:
                return weekNamePre + "日";
            case MONDAY:
                return weekNamePre + "一";
            case TUESDAY:
                return weekNamePre + "二";
            case WEDNESDAY:
                return weekNamePre + "三";
            case THURSDAY:
                return weekNamePre + "四";
            case FRIDAY:
                return weekNamePre + "五";
            case SATURDAY:
                return weekNamePre + "六";
            default:
                return null;
        }
    }

    /**
     * 转换为{@link DayOfWeek}
     *
     * @return {@link DayOfWeek}
     * @since 5.8.0
     */
    public DayOfWeek toJdkDayOfWeek() {
        return DayOfWeek.of(getIso8601Value());
    }

    /**
     * 将 {@link Calendar}星期相关值转换为Week枚举对象

     *
     * @param calendarWeekIntValue Calendar中关于Week的int值，1表示Sunday
     * @return Week
     * @see #SUNDAY
     * @see #MONDAY
     * @see #TUESDAY
     * @see #WEDNESDAY
     * @see #THURSDAY
     * @see #FRIDAY
     * @see #SATURDAY
     */
    public static Week of(int calendarWeekIntValue) {
        if (calendarWeekIntValue > ENUMS.length || calendarWeekIntValue < 1) {
            return null;
        }
        return ENUMS[calendarWeekIntValue - 1];
    }
}