org.chronicj.impl
Class RangeEachYearTE

java.lang.Object
  |
  +--org.chronicj.impl.AbstractTemporalExpression
        |
        +--org.chronicj.impl.RangeEachYearTE

All Implemented Interfaces:

TemporalExpression

public class RangeEachYearTE

extends AbstractTemporalExpression

Implements support for temporal expressions that describe a recurring range of the year. In pseudocode, this is of the form: "starting May 5th and ending August 28th" or "From November to December". Expression syntax is specified using constructors.

This class is based directly on patterns described in a paper by Martin Fowler which can be found here.

Author:

Matthew Lipper

See Also:

Recurring Events for Calendars by Martin Fowler

Constructor Summary

RangeEachYearTE(int month)

RangeEachYearTE(int startMonth, int endMonth)

RangeEachYearTE(int startMonth, int startDay, int endMonth, int endDay)

Method Summary

boolean

includes(org.chronicj.TimePoint aTimePoint) Used to check whether a given date is occurs within the current range expressed by this TemporalExpression.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RangeEachYearTE

public RangeEachYearTE(int startMonth,
                       int startDay,
                       int endMonth,
                       int endDay)

RangeEachYearTE

public RangeEachYearTE(int startMonth,
                       int endMonth)

RangeEachYearTE

public RangeEachYearTE(int month)

Method Detail

includes

public boolean includes(org.chronicj.TimePoint aTimePoint)

Description copied from interface: TemporalExpression

Used to check whether a given date is occurs within the current range expressed by this TemporalExpression.

Specified by:

includes in interface TemporalExpression

Specified by:

includes in class AbstractTemporalExpression

Parameters:

aTimePoint - the TimePoint to be checked for inclusion in the current set

Returns:

true or false, indicating whether the supplied TimePoint occurs within the current range