bld-property-file/src/main/java/rife/bld/extension/propertyfile/EntryDate.java

/*
 * Copyright 2023-2025 the original author or authors.
 *
 * 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
 *
 *     https://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 rife.bld.extension.propertyfile;

import java.time.*;
import java.util.Calendar;
import java.util.Date;

/**
 * Declares the modifications to be made to a {@link java.util.Properties Date-based property}.
 *
 * @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
 * @since 1.0
 */
public class EntryDate extends EntryBase<EntryDate> {
    private EntryDate.Units unit_ = EntryDate.Units.DAY;

    /**
     * Creates a new {@link EntryDate entry}.
     *
     * @param key the required property key
     */
    public EntryDate(String key) {
        super(key);
    }

    /**
     * Sets the new {@link java.util.Properties property} value to now.
     *
     * @return this instance
     */
    public EntryDate now() {
        newValue("now");
        return this;
    }

    /**
     * Sets the {@link java.time.format.DateTimeFormatter DateTimeFormatter} pattern.
     *
     * @param pattern the pattern
     */
    public EntryDate pattern(String pattern) {
        super.pattern(pattern);
        return this;
    }

    /**
     * Sets the new {@link java.util.Properties property} value to an {@link Instant}
     *
     * @param instant the {@link Instant} to set the value to
     * @return this instance
     */
    public EntryDate set(Instant instant) {
        newValue(instant);
        return this;
    }

    /**
     * Sets the new {@link java.util.Properties property} value to a {@link LocalDate}
     *
     * @param date the {@link LocalDate} to set the value to
     * @return this instance
     */
    public EntryDate set(LocalDate date) {
        newValue(date);
        return this;
    }

    /**
     * Sets the new {@link java.util.Properties property} value to a {@link LocalDateTime}
     *
     * @param date the {@link LocalDateTime} to set the value to
     * @return this instance
     */
    public EntryDate set(LocalDateTime date) {
        newValue(date);
        return this;
    }

    /**
     * Sets the new {@link java.util.Properties property} value to a {@link ZonedDateTime}
     *
     * @param date the {@link ZonedDateTime} to set the value to
     * @return this instance
     */
    public EntryDate set(ZonedDateTime date) {
        newValue(date);
        return this;
    }

    /**
     * Sets the new {@link java.util.Properties property} value to a {@link LocalTime}
     *
     * @param time the {@link LocalTime} to set the value to
     * @return this instance
     */
    public EntryDate set(LocalTime time) {
        newValue(time);
        return this;
    }

    /**
     * Sets the new {@link java.util.Properties property} value to a {@link Calendar}
     *
     * @param cal the {@link Calendar} to set the value to
     * @return this instance
     */
    public EntryDate set(Calendar cal) {
        newValue(cal);
        return this;
    }

    /**
     * Sets the new {@link java.util.Properties property} value to a {@link Date}
     *
     * @param date the {@link Date} to set the value to
     * @return this instance
     */
    public EntryDate set(Date date) {
        newValue(date);
        return this;
    }

    /**
     * Returns the {@link EntryDate.Units unit}.
     *
     * @return the unit
     */
    public EntryDate.Units unit() {
        return unit_;
    }

    /**
     * Sets the {@link Units unit} value to apply to calculations for {@link EntryDate}.
     *
     * @param unit the {@link Units unit}
     * @return this instance
     */
    public EntryDate unit(Units unit) {
        unit_ = unit;
        return this;
    }

    /**
     * The units available for {@link EntryDate} calculations.
     *
     * <uL>
     * <li>{@link Units#SECOND SECOND}</li>
     * <li>{@link Units#MINUTE MINUTE}</li>
     * <li>{@link Units#HOUR HOUR}</li>
     * <li>{@link Units#DAY DAY}</li>
     * <li>{@link Units#WEEK WEEK}</li>
     * <li>{@link Units#MONTH MONTH}</li>
     * <li>{@link Units#YEAR YEAR}</li>
     * </uL>
     */
    public enum Units {
        /**
         * Second units.
         */
        SECOND,
        /**
         * Minute units.
         */
        MINUTE,
        /**
         * Hour units.
         */
        HOUR,
        /**
         * Day units.
         */
        DAY,
        /**
         * Week units.
         */
        WEEK,
        /**
         * Month units.
         */
        MONTH,
        /**
         * Year units.
         */
        YEAR
    }
}