CalendarSet.java

package org.openntf.calendars;

import java.util.Calendar;
import java.util.Set;
import java.util.TreeSet;

import org.openntf.domino.utils.Dates;

/**
 * Carrier for a set of Calendar objects specifying a range of time.
 */
public class CalendarSet extends TreeSet<Calendar> implements CalendarRangeInterface {

	private static final long serialVersionUID = 1L;

	/**
	 * Zero-Argument Constructor
	 */
	public CalendarSet() {
		super();
	}

	/**
	 * Default Constructor
	 * 
	 * @param first
	 *            The first Calendar entry for the range.
	 * @param last
	 *            The last Calendar entry for the range.
	 */
	public CalendarSet(final Calendar first, final Calendar last) {
		super();
		this.add(first);
		this.add(last);
	}

	/**
	 * Optional Constructor
	 * 
	 * @param set
	 *            Set from which to construct this object. All non-null values from set will be added to this object.
	 */
	public CalendarSet(final Set<Calendar> set) {
		super();
		this.addAll(set);
	}

	/*
	 * ***************************************************
	 * ***************************************************
	 * 
	 * PUBLIC Methods
	 * 
	 * ***************************************************
	 * ***************************************************
	 */

	@Override
	public boolean add(final Calendar calendar) {
		return (null == calendar) ? false : super.add(calendar);
	}

	@Override
	public boolean addObject(final Object object) {
		if (null != object) {
			final Calendar c = Dates.getCalendar(object);
			return (null == c) ? false : this.add(c);
		}

		return false;
	}

	/**
	 * Adds all non-null values from set to this object.
	 * 
	 * @param set
	 *            Set from which to construct this object. All non-null values from set will be added to this object.
	 * 
	 * @return Flag indicating if this set changed as a result of the call.
	 */
	@Override
	public boolean addAll(final Set<Calendar> set) {
		if ((null == set) || set.isEmpty()) {
			return false;
		}
		boolean result = false;

		for (final Calendar calendar : set) {
			final boolean temp = this.add(calendar);
			if (temp && !result) {
				result = true;
			}
		}

		return result;
	}

	/*
	 * ***************************************************
	 * ***************************************************
	 * 
	 * CalendarRangeInterface Methods
	 * 
	 * ***************************************************
	 * ***************************************************
	 */
	@Override
	public boolean contains(final Calendar calendar) {
		return super.contains(calendar);
	}

	@Override
	public String getHoursMinutes() {
		return this.toCalendarRange().getHoursMinutes();
	}

	@Override
	public CalendarRange getIntersection(final CalendarRange cr) {
		return this.toCalendarRange().getIntersection(cr);
	}

	@Override
	public long getMinutes() {
		return this.toCalendarRange().getMinutes();
	}

	@Override
	public CalendarRange getUnion(final CalendarRange cr) {
		return this.toCalendarRange().getUnion(cr);
	}

	@Override
	public boolean isInRange(final Object object) {
		return this.toCalendarRange().isInRange(object);
	}

	@Override
	public boolean isInRange(final Object object, final boolean inclusive) {
		return this.toCalendarRange().isInRange(object, inclusive);
	}

	@Override
	public boolean isIntersectionExists(final CalendarRange cr) {
		return this.toCalendarRange().isIntersectionExists(cr);
	}

	@Override
	public boolean isUnionExists(final CalendarRange cr) {
		return this.toCalendarRange().isUnionExists(cr);
	}

	@Override
	public boolean isValid() {
		return this.toCalendarRange().isValid();
	}

	@Override
	public CalendarRange toCalendarRange() {
		return new CalendarRange(this.first(), this.last());
	}

}