daterange.java

来自「struts spring ibatis」· Java 代码 · 共 52 行

/*
 * $RCSfile: DateRange.java,v $
 * $Revision: 1.1 $
 * $Date: 2002/11/20 04:03:17 $
 *
 * Copyright (C) 1999-2002 CoolServlets, Inc. All rights reserved.
 *
 * This software is the proprietary information of CoolServlets, Inc.
 * Use is subject to license terms.
 */

package com.struts2.framework.util;

import java.util.Date;

/**
 * A DateRange converts an abstract starting and ending time into specific
 * instances in time. For example, the conceptual date range of "last year"
 * might be translated into the actual start and end date of "January 1, 2000"
 * to "December 31, 2000."
 */
public interface DateRange {

    /**
     * Returns a specific start date for this date range based on the specified
     * date.
     *
     * @param date the date to base a date range calculation on. Most often,
     *      this will be the current instance in time.
     * @return a specific start date based on <tt>date</tt>.
     */
    public abstract Date getStartDate(Date date);

    /**
     * Returns a specific end date for this date range based on the specified
     * date.
     *
     * @param date the date to base a date range calculation on. Most often,
     *      this will be the current instance in time.
     * @return a specific end date based on <tt>date</tt>.
     */
    public abstract Date getEndDate(Date date);

    /**
     * Returns a string representing a human-readable descriptive name of
     * this date range.
     *
     * @return a descriptive name of this date range.
     */
    public String getDisplayName();

}