net.sf.mpxj

Class ProjectCalendarDateRanges

java.lang.Object

net.sf.mpxj.ProjectCalendarDateRanges

All Implemented Interfaces:

Iterable<DateRange>

Direct Known Subclasses:

ProjectCalendarException, ProjectCalendarHours

public abstract class ProjectCalendarDateRanges
extends Object
implements Iterable<DateRange>

An abstract class representing a collection of date ranges with supporting methods.

Constructor Summary

Constructors

Constructor and Description
ProjectCalendarDateRanges()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRange(DateRange range) Add a date range to the list of date ranges.
DateRange	getRange(int index) Retrieve the date range at the specified index.
int	getRangeCount() Returns the number of date ranges associated with this instance.
Iterator<DateRange>	iterator() Retrieve an iterator to allow the list of date ranges to be traversed.
void	setRange(int index, DateRange value) Replace a date range at the specified index.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectCalendarDateRanges

public ProjectCalendarDateRanges()

Method Detail

addRange

public void addRange(DateRange range)

Add a date range to the list of date ranges.

Parameters:

range - date range

getRange

public DateRange getRange(int index)

Retrieve the date range at the specified index. The index is zero based, and this method will return null if the requested date range does not exist.

Parameters:

index - range index

Returns:

date range instance

setRange

public void setRange(int index,
            DateRange value)

Replace a date range at the specified index.

Parameters:

index - range index

value - DateRange instance

iterator

public Iterator<DateRange> iterator()

Retrieve an iterator to allow the list of date ranges to be traversed.

Specified by:

iterator in interface Iterable<DateRange>

Returns:

iterator.

getRangeCount

public int getRangeCount()

Returns the number of date ranges associated with this instance.

Returns:

number of date ranges