org.mpxj

Class ProjectCalendarException

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<LocalTimeRange>

org.mpxj.ProjectCalendarHours

org.mpxj.ProjectCalendarException

All Implemented Interfaces:

Comparable<ProjectCalendarException>, Iterable<LocalTimeRange>, Collection<LocalTimeRange>, List<LocalTimeRange>

public final class ProjectCalendarException
extends ProjectCalendarHours
implements Comparable<ProjectCalendarException>

This class represents instances of Calendar Exception records from an MPX file. It is used to define exceptions to the working days described in both base and resource calendars.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Method Summary

Modifier and Type	Method and Description
int	compareTo(ProjectCalendarException o)
boolean	contains(LocalDate date) This method determines whether the given date falls in the range of dates covered by this exception.
boolean	contains(LocalDateTime date) This method determines whether the given date falls in the range of dates covered by this exception.
boolean	contains(ProjectCalendarException exception) Returns true if any part of the supplied calendar exception overlaps this one.
List<ProjectCalendarException>	getExpandedExceptions() Expand the current exception into a list of exception.
LocalDate	getFromDate() Returns the from date.
String	getName() Retrieve the name of this exception.
RecurringData	getRecurring() Retrieve any recurrence data associated with this exception.
LocalDate	getToDate() Get to date.
boolean	getWorking() Gets working status.
void	setName(String name) Set the name of this exception.
String	toString()

Methods inherited from class org.mpxj.ProjectCalendarHours

add, clear, get, iterator, set, size

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

getName

public String getName()

Retrieve the name of this exception.

Returns:

exception name

setName

public void setName(String name)

Set the name of this exception.

Parameters:

name - exception name

getFromDate

public LocalDate getFromDate()

Returns the from date.

Returns:

Date

getToDate

public LocalDate getToDate()

Get to date.

Returns:

Date

getRecurring

public RecurringData getRecurring()

Retrieve any recurrence data associated with this exception. This will return null if this is a default single day exception.

Returns:

recurrence data

getWorking

public boolean getWorking()

Gets working status.

Returns:

boolean value

getExpandedExceptions

public List<ProjectCalendarException> getExpandedExceptions()

Expand the current exception into a list of exception. If the current exception is not recurring, or it is recurring and the exceptions form a contiguous range of days, then this list will only contain a single entry. If this is a recurring exception which covers multiple non-contiguous days the returned list will include exceptions for all exception dates.

Returns:

list of exceptions derived from the current exception

contains

public boolean contains(LocalDateTime date)

This method determines whether the given date falls in the range of dates covered by this exception. Note that this method assumes that both the start and end date of this exception have been set.

Parameters:

date - Date to be tested

Returns:

Boolean value

contains

public boolean contains(LocalDate date)

This method determines whether the given date falls in the range of dates covered by this exception. Note that this method assumes that both the start and end date of this exception have been set.

Parameters:

date - Date to be tested

Returns:

Boolean value

contains

public boolean contains(ProjectCalendarException exception)

Returns true if any part of the supplied calendar exception overlaps this one.

Parameters:

exception - calendar exception to test

Returns:

true if there is any overlap

compareTo

public int compareTo(ProjectCalendarException o)

Specified by:

compareTo in interface Comparable<ProjectCalendarException>

toString

public String toString()

Overrides:

toString in class ProjectCalendarHours