IDateTimeSet.java

/*
 * Copyright 2011-2013 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
 *
 *     http://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 kr.debop4j.timeperiod;

import org.joda.time.DateTime;
import org.joda.time.Duration;

import java.util.Collection;
import java.util.List;

/**
 * {@link DateTime}을 요소로 가지는 컬렉션입니다.
 *
 * @author 배성혁 sunghyouk.bae@gmail.com
 * @since 13. 5. 11. 오후 7:02
 */
public interface IDateTimeSet extends Collection<DateTime> {


    /**
     * 최소값, 요소가 없으면 null을 반환한다.
     *
     * @return the min
     */
    DateTime getMin();

    /**
     * 최대값, 요소가 없으면 null을 반환한다.
     *
     * @return the max
     */
    DateTime getMax();

    /**
     * Min~Max의 기간을 나타낸다. 둘 중 하나라도 null이면 null을 반환한다.
     *
     * @return the duration
     */
    Duration getDuration();

    /**
     * 요소가 없는 컬렉션인가 여부.
     *
     * @return <tt>true</tt> if this collection contains no elements
     */
    boolean isEmpty();

    /**
     * 모든 요소가 같은 시각을 나타내는가 여부.
     *
     * @return the boolean
     */
    boolean isMoment();

    /**
     * 요소가 모든 시각을 나타내는가 여부.
     *
     * @return the boolean
     */
    boolean isAnytime();

    /**
     * 지정된 컬렉션의 요소들을 모두 추가합니다.
     *
     * @param moments the moments
     */
    void addAll(Iterable<DateTime> moments);

    /**
     * 순번에 해당하는 시각들의 Duration을 구합니다.
     *
     * @param startIndex the start index
     * @param count      the count
     * @return the durations
     */
    List<Duration> getDurations(int startIndex, int count);

    /**
     * 지정된 시각의 바로 전의 시각을 찾습니다. 없으면 null을 반환합니다.
     *
     * @param moment the moment
     * @return the date time
     */
    DateTime findPrevious(DateTime moment);

    /**
     * 지정된 시각의 바로 후의 시각을 찾습니다. 없으면 null을 반환합니다.
     *
     * @param moment the moment
     * @return the date time
     */
    DateTime findNext(DateTime moment);
}