A B C D E F G H I J L M N O P R S T U V W Y

A

AbstractTemporalExpression - class org.chronicj.impl.AbstractTemporalExpression.

Abstract base class for TemporalExpression implementations.

AbstractTemporalExpression() - Constructor for class org.chronicj.impl.AbstractTemporalExpression

Creates a new AbstractTemporalExpression object.

abuts(DateRange) - Method in class org.chronicj.DateRange

Used to detect whether two date ranges abut each other.

add(Event, TemporalExpression) - Method in class org.chronicj.impl.DefaultSchedule

add(Event, TemporalExpression) - Method in interface org.chronicj.Schedule

Adds an Eventwhose occurance is determined by the given TemporalExpression.

addDays(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance plus n days.

addHours(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance plus n hours.

addMilliSeconds(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance plus n milliseconds.

addMinutes(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance plus n minutes.

addMonths(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance plus n months.

addSeconds(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance plus n seconds.

addYears(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance plus n years.

after(TimePoint) - Method in class org.chronicj.TimePoint

Method to see whether this TimePoint instance occurs after another TimePoint instance.

APRIL - Static variable in class org.chronicj.impl.DateExpression

ArbitraryDateRangeTE - class org.chronicj.impl.ArbitraryDateRangeTE.

Implements support for matching arbitrary dates using a DateRange supplied to the constructor.

ArbitraryDateRangeTE(DateRange) - Constructor for class org.chronicj.impl.ArbitraryDateRangeTE

ArbitraryTimePointTE - class org.chronicj.impl.ArbitraryTimePointTE.

Implements support for matching arbitrary dates using a TimePoint supplied to the constructor.

ArbitraryTimePointTE(TimePoint) - Constructor for class org.chronicj.impl.ArbitraryTimePointTE

AUGUST - Static variable in class org.chronicj.impl.DateExpression

B

before(TimePoint) - Method in class org.chronicj.TimePoint

Method to see whether this TimePoint instance occurs before another TimePoint instance.

C

combination(DateRange[]) - Static method in class org.chronicj.DateRange

compareTo(Object) - Method in class org.chronicj.DatePrecision

compareTo(Object) - Method in class org.chronicj.DateRange

Compare the current DateRange instance to the one provided.

compareTo(Object) - Method in class org.chronicj.TimePoint

Compare wrapped GregorianCalendars.

D

DATE - Static variable in class org.chronicj.DatePrecision

DateExpression - class org.chronicj.impl.DateExpression.

Constants used for facilitating construction of ChronicJ date expressions.

DateExpression() - Constructor for class org.chronicj.impl.DateExpression

DatePrecision - class org.chronicj.DatePrecision.

Constants used for expressing date precision when working with ChronicJ components.

DateRange - class org.chronicj.DateRange.

Defines basic requirements and utility methods for classes that model periods of time.

DateRange(Date, Date) - Constructor for class org.chronicj.DateRange

Construct a DateRange using the given start and end dates.

DateRange(TimePoint, TimePoint) - Constructor for class org.chronicj.DateRange

Construct a DateRange using the supplied start and end TimePoints.

dates(Event, DateRange) - Method in class org.chronicj.impl.DefaultSchedule

All calculations are made using DatePrecision#DATE precision.

dates(Event, DateRange) - Method in interface org.chronicj.Schedule

Returns a Listof TimePoints on which the supplied event occurs given the specified DateRange.

DateUtil - class org.chronicj.impl.DateUtil.

Silly helper class for date formatting and other random utilities that don't squarely belong in other classes.

DateUtil() - Constructor for class org.chronicj.impl.DateUtil

DayInMonthTE - class org.chronicj.impl.DayInMonthTE.

Implements support for temporal expressions of the form: "last Friday of the month" or "first Tuesday of the month".

DayInMonthTE(int) - Constructor for class org.chronicj.impl.DayInMonthTE

Creates a temporal expression using day of the week 1 to 7.

DayInMonthTE(int, int) - Constructor for class org.chronicj.impl.DayInMonthTE

Creates a temporal expression using day of the week 1 to 7 and day of week in month which may be either positive or negative indicating whether count is from beginning or end of the month, respectively.

DECEMBER - Static variable in class org.chronicj.impl.DateExpression

DefaultSchedule - class org.chronicj.impl.DefaultSchedule.

Default implementation of a Schedule.

DefaultSchedule() - Constructor for class org.chronicj.impl.DefaultSchedule

Creates an instance of a DefaultSchedule.

DefaultScheduleElement - class org.chronicj.impl.DefaultScheduleElement.

Default implementation of a ScheduleElement that can be used to compose a Schedule.

DefaultScheduleElement(Event, TemporalExpression) - Constructor for class org.chronicj.impl.DefaultScheduleElement

Create a default ScheduleElement using the supplied Event and TemporalExpression.

DifferenceTE - class org.chronicj.impl.DifferenceTE.

TemporalExpression that provides the difference of two composing expressions; for use in a set expression.

DifferenceTE(TemporalExpression, TemporalExpression) - Constructor for class org.chronicj.impl.DifferenceTE

Creates an instance of DifferenceTE using two other TemporalExpressions such that the new expression matches dates/times based on the set defined by argument 1 - argument 2.

E

EMTPY - Static variable in class org.chronicj.DateRange

Specifies an empty range which can be used as a constant

end() - Method in class org.chronicj.DateRange

Accessor method for the TimePoint denoting the upper end of this range.

equals(Object) - Method in class org.chronicj.DateRange

equals(Object) - Method in class org.chronicj.TimePoint

Compare wrapped GregorianCalendar s for equality

Event - interface org.chronicj.Event.

Purposefully open-ended way for defining various events which can be scheduled.

F

FEBRUARY - Static variable in class org.chronicj.impl.DateExpression

FIRST - Static variable in class org.chronicj.impl.DateExpression

format(Date) - Static method in class org.chronicj.impl.DateUtil

Date to String using the default pattern.

format(Date, String) - Static method in class org.chronicj.impl.DateUtil

Date to String using the supplied pattern.

FOURTH - Static variable in class org.chronicj.impl.DateExpression

FRIDAY - Static variable in class org.chronicj.impl.DateExpression

G

gap(DateRange) - Method in class org.chronicj.DateRange

Used to determine the duration of time (expressed as another DateRange) between the current DateRange instance and another DateRange.

getCalendar() - Method in class org.chronicj.TimePoint

Getter method for the wrapped GregorianCalendar.

getDatePrecision() - Method in class org.chronicj.DateRange

The DatePrecisionof this range.

getDatePrecision() - Method in class org.chronicj.TimePoint

Getter method for DatePrecision field.

getDayOfMonth() - Method in class org.chronicj.TimePoint

Getter for day of the month.

getDayOfWeek() - Method in class org.chronicj.TimePoint

Getter for day of the week.

getHourOfDay() - Method in class org.chronicj.TimePoint

Getter for hour of the day (24hr).

getId() - Method in interface org.chronicj.Event

getMilliSeconds() - Method in class org.chronicj.TimePoint

Getter for milliseconds.

getMinute() - Method in class org.chronicj.TimePoint

Getter for minutes.

getMonth() - Method in class org.chronicj.TimePoint

Getter for month (not zero-indexed).

getSeconds() - Method in class org.chronicj.TimePoint

Getter for seconds.

getTime() - Method in class org.chronicj.TimePoint

Convenience getter method for getCalendar()

getYear() - Method in class org.chronicj.TimePoint

Getter for year.

getZeroIndexedMonth() - Method in class org.chronicj.TimePoint

Getter returning the wrapped Calendarmonth which is zero-indexed.

greaterThan(DatePrecision) - Method in class org.chronicj.DatePrecision

H

hashCode() - Method in class org.chronicj.DateRange

hashCode() - Method in class org.chronicj.TimePoint

hasNext() - Method in class org.chronicj.RangeIterator

Returns:
currentRange.includes(nextRangeIndex));

HOUR_OF_DAY - Static variable in class org.chronicj.DatePrecision

I

includes(DateRange) - Method in class org.chronicj.DateRange

Used to check whether a given DateRange occurs within the current range.

includes(TimePoint) - Method in class org.chronicj.DateRange

Used to check whether a given TimePoint occurs within the current range.

includes(TimePoint) - Method in class org.chronicj.impl.AbstractTemporalExpression

includes(TimePoint) - Method in class org.chronicj.impl.ArbitraryDateRangeTE

includes(TimePoint) - Method in class org.chronicj.impl.ArbitraryTimePointTE

includes(TimePoint) - Method in class org.chronicj.impl.DayInMonthTE

Does the value of the supplied argument match this expression? If this instance was created with DayInMonthTE.DayInMonthTE(int, int) constructor:
true = day of week matches and week of month matches, e.g.

includes(TimePoint) - Method in class org.chronicj.impl.DifferenceTE

includes(TimePoint) - Method in class org.chronicj.impl.IntersectionTE

includes(TimePoint) - Method in class org.chronicj.impl.RangeEachDayTE

includes(TimePoint) - Method in class org.chronicj.impl.RangeEachYearTE

includes(TimePoint) - Method in class org.chronicj.impl.UnionTE

includes(TimePoint) - Method in interface org.chronicj.TemporalExpression

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

increment(int) - Method in class org.chronicj.TimePoint

Increment this TimePoint using the current internal DatePrecisionby the number of units specified.

IntersectionTE - class org.chronicj.impl.IntersectionTE.

Composite TemporalExpression that provides an intersection of the composing expressions for use in a set expression.

IntersectionTE() - Constructor for class org.chronicj.impl.IntersectionTE

Creates an instance of IntersectionTE.

isContiguous(DateRange[]) - Static method in class org.chronicj.DateRange

isEmpty() - Method in class org.chronicj.DateRange

Used mostly by other date range calculations to indicate an empty set.

isOccuring(Event, DateRange) - Method in class org.chronicj.impl.DefaultSchedule

Default implementation of org.chronicj.Schedule#isOccuring(org.chronicj.Event,org.chronicj.DateRangeImpl).

isOccuring(Event, DateRange) - Method in class org.chronicj.impl.DefaultScheduleElement

Default implementation of org.chronicj.ScheduleElement#isOccuring(org.chronicj.Event,org.chronicj.DateRangeImpl) that will return the logical AND of calling DefaultScheduleElement.isOccuring(org.chronicj.Event,org.chronicj.TimePoint) for the start and end dates of the supplied DateRange.

isOccuring(Event, DateRange) - Method in interface org.chronicj.Schedule

Determines if a given event occurs within a particular date range for this schedule.

isOccuring(Event, DateRange) - Method in interface org.chronicj.ScheduleElement

Determines if a given event occurs within a particular data range.

isOccuring(Event, TimePoint) - Method in class org.chronicj.impl.DefaultSchedule

Default implementation of Schedule.isOccuring(org.chronicj.Event,org.chronicj.TimePoint).

isOccuring(Event, TimePoint) - Method in class org.chronicj.impl.DefaultScheduleElement

Default implementation of ScheduleElement.isOccuring(org.chronicj.Event,org.chronicj.TimePoint) that will return true if the supplied Event takes place during the supplied TimePoint.

isOccuring(Event, TimePoint) - Method in interface org.chronicj.Schedule

Determines if a given event occurs during a particular instant in time.

isOccuring(Event, TimePoint) - Method in interface org.chronicj.ScheduleElement

Determines if a given event occurs during a particular instant in time.

isScheduled(Event) - Method in class org.chronicj.impl.DefaultSchedule

J

JANUARY - Static variable in class org.chronicj.impl.DateExpression

JULY - Static variable in class org.chronicj.impl.DateExpression

JUNE - Static variable in class org.chronicj.impl.DateExpression

L

LAST - Static variable in class org.chronicj.impl.DateExpression

lessThan(DatePrecision) - Method in class org.chronicj.DatePrecision

M

MARCH - Static variable in class org.chronicj.impl.DateExpression

MAY - Static variable in class org.chronicj.impl.DateExpression

MILLISECOND - Static variable in class org.chronicj.DatePrecision

minusDays(int) - Method in class org.chronicj.TimePoint

Create a new TimePoint using the current instance minus n days.

MINUTE - Static variable in class org.chronicj.DatePrecision

MONDAY - Static variable in class org.chronicj.impl.DateExpression

MONTH - Static variable in class org.chronicj.DatePrecision

N

next() - Method in class org.chronicj.RangeIterator

Returns:
new DateRange(currentRangeIndex.start().increment(1), currentRangeIndex.start().increment(2));

nextOccurence(Event, TimePoint) - Method in class org.chronicj.impl.DefaultSchedule

nextOccurence(Event, TimePoint) - Method in interface org.chronicj.Schedule

Returns a TimePointindicating the next occurence of the supplied Eventon or after the given point in time.

NOVEMBER - Static variable in class org.chronicj.impl.DateExpression

O

OCTOBER - Static variable in class org.chronicj.impl.DateExpression

org.chronicj - package org.chronicj

Defines the interfaces for fundamental types that can be used to build temporal applications.

org.chronicj.impl - package org.chronicj.impl

Defines default implementations of the fundamental types defined in the org.chronicj package.

overlaps(DateRange) - Method in class org.chronicj.DateRange

Used mostly by other date range calculations to indicate an empty set.

P

parse(String) - Static method in class org.chronicj.impl.DateUtil

Date format function using default pattern.

parse(String, String) - Static method in class org.chronicj.impl.DateUtil

Date format function using supplied pattern.

partitionedBy(DateRange[]) - Method in class org.chronicj.DateRange

Used to check whether a group of ranges completely partition the current DateRange.

R

RangeEachDayTE - class org.chronicj.impl.RangeEachDayTE.

Implements support for temporal expressions that describe a recurring span of time each day or across multiple days.

RangeEachDayTE(int, int, int, int) - Constructor for class org.chronicj.impl.RangeEachDayTE

Creates a new RangeEachDayTE object.

RangeEachYearTE - class org.chronicj.impl.RangeEachYearTE.

Implements support for temporal expressions that describe a recurring range of the year.

RangeEachYearTE(int) - Constructor for class org.chronicj.impl.RangeEachYearTE

RangeEachYearTE(int, int) - Constructor for class org.chronicj.impl.RangeEachYearTE

RangeEachYearTE(int, int, int, int) - Constructor for class org.chronicj.impl.RangeEachYearTE

RangeIterator - class org.chronicj.RangeIterator.

Simple Iteratorimplmentation that can be used to traverse the sub ranges that occur between the start and end TimePointsof a given DateRange.

RangeIterator(DateRange) - Constructor for class org.chronicj.RangeIterator

remove() - Method in class org.chronicj.RangeIterator

Currently, throws an UnsupportedOperationException as this method is not supported.

S

SATURDAY - Static variable in class org.chronicj.impl.DateExpression

Schedule - interface org.chronicj.Schedule.

Represents a coherent collection of logical events that are expected to occur over the course of time.

ScheduleElement - interface org.chronicj.ScheduleElement.

Encapsulates the information and behaviour for specific Events in the context of a Schedule.

SECOND - Static variable in class org.chronicj.DatePrecision

SECOND - Static variable in class org.chronicj.impl.DateExpression

SEPTEMBER - Static variable in class org.chronicj.impl.DateExpression

start() - Method in class org.chronicj.DateRange

Accessor method for the TimePoint denoting the lower end of this range.

SUNDAY - Static variable in class org.chronicj.impl.DateExpression

T

TemporalExpression - interface org.chronicj.TemporalExpression.

Interface for objects that wish to provide algorithmic support for building recurring event sets.

THIRD - Static variable in class org.chronicj.impl.DateExpression

THURSDAY - Static variable in class org.chronicj.impl.DateExpression

TimePoint - class org.chronicj.TimePoint.

Based directly on the Time Point pattern described by Martin Fowler.

TimePoint(Date) - Constructor for class org.chronicj.TimePoint

Creates a TimePoint using default DatePrecision.

TimePoint(Date, DatePrecision) - Constructor for class org.chronicj.TimePoint

Creates a TimePoint using the specified DatePrecision.

TimePoint(GregorianCalendar) - Constructor for class org.chronicj.TimePoint

Delegates call to TimePoint(GregorianCalendar, DatePrecision) using constant TimePoint#DEFAULT_PRECISION.

TimePoint(GregorianCalendar, DatePrecision) - Constructor for class org.chronicj.TimePoint

Creates a TimePoint using specified DatePrecision.

TimePoint(int, int) - Constructor for class org.chronicj.TimePoint

Convenience constructor allowing the more natural 1-based-index for specifying month.

TimePoint(int, int, int) - Constructor for class org.chronicj.TimePoint

Convenience constructor allowing the more natural 1-based-index for specifying month.

TimePoint(int, int, int, int) - Constructor for class org.chronicj.TimePoint

Convenience constructor allowing the more natural 1-based-index for specifying month.

TimePoint(int, int, int, int, int) - Constructor for class org.chronicj.TimePoint

Convenience constructor allowing the more natural 1-based-index for specifying month.

to(int, int) - Static method in class org.chronicj.impl.DateExpression

toPrecison(DatePrecision) - Method in class org.chronicj.TimePoint

Create a new TimePoint using this TimePoint current value set to the supplied DatePrecision.

toString() - Method in class org.chronicj.DatePrecision

toString() - Method in class org.chronicj.DateRange

toString() - Method in class org.chronicj.impl.IntersectionTE

toString() - Method in class org.chronicj.impl.RangeEachDayTE

toString() - Method in class org.chronicj.TimePoint

TUESDAY - Static variable in class org.chronicj.impl.DateExpression

U

UnionTE - class org.chronicj.impl.UnionTE.

Composite TemporalExpression that provides a union of the composing expressions for use in a set expression.

UnionTE() - Constructor for class org.chronicj.impl.UnionTE

Creates an instance of UnionTE.

V

VALUES - Static variable in class org.chronicj.DatePrecision

W

WEDNESDAY - Static variable in class org.chronicj.impl.DateExpression

Y

YEAR - Static variable in class org.chronicj.DatePrecision

A B C D E F G H I J L M N O P R S T U V W Y