net.sf.mpxj

Class ProjectCalendarContainer

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

net.sf.mpxj.ListWithCallbacks<T>

net.sf.mpxj.ProjectEntityContainer<ProjectCalendar>

net.sf.mpxj.ProjectCalendarContainer

All Implemented Interfaces:

Iterable<ProjectCalendar>, Collection<ProjectCalendar>, List<ProjectCalendar>

public class ProjectCalendarContainer
extends ProjectEntityContainer<ProjectCalendar>

Manages the collection of calendars belonging to a project.

Field Summary

Fields inherited from class net.sf.mpxj.ProjectEntityContainer

m_sequenceProvider

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ProjectCalendarContainer(ProjectFile projectFile) Constructor.

Method Summary

Modifier and Type	Method and Description
ProjectCalendar	add() Add a calendar to the project.
ProjectCalendar	addDefaultBaseCalendar() This is a convenience method used to add a calendar called "Standard" to the project, and populate it with a default working week and default working hours.
ProjectCalendar	addDefaultDerivedCalendar() This is a convenience method to add a default derived calendar to the project.
ProjectCalendar	findOrCreateDefaultCalendar() If we're calling this method, we don't have a reliable way to identify the default calendar.
ProjectCalendar	getByName(String calendarName) Retrieves the named calendar.
void	removed(ProjectCalendar calendar) Called to notify subclasses of item removal.

Methods inherited from class net.sf.mpxj.ProjectEntityContainer

added, firstUniqueID, fixUniqueIdClashes, getByUniqueID, updateUniqueID

Methods inherited from class net.sf.mpxj.ListWithCallbacks

add, add, clear, get, remove, replaced, set, size

Methods inherited from class java.util.AbstractList

addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

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

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

Constructor Detail

ProjectCalendarContainer

public ProjectCalendarContainer(ProjectFile projectFile)

Constructor.

Parameters:

projectFile - parent project

Method Detail

removed

public void removed(ProjectCalendar calendar)

Description copied from class: ProjectEntityContainer

Called to notify subclasses of item removal.

Overrides:

removed in class ProjectEntityContainer<ProjectCalendar>

Parameters:

calendar - removed item

add

public ProjectCalendar add()

Add a calendar to the project.

Returns:

new task instance

addDefaultBaseCalendar

public ProjectCalendar addDefaultBaseCalendar()

This is a convenience method used to add a calendar called "Standard" to the project, and populate it with a default working week and default working hours.

Returns:

a new default calendar

addDefaultDerivedCalendar

public ProjectCalendar addDefaultDerivedCalendar()

This is a convenience method to add a default derived calendar to the project.

Returns:

new ProjectCalendar instance

findOrCreateDefaultCalendar

public ProjectCalendar findOrCreateDefaultCalendar()

If we're calling this method, we don't have a reliable way to identify the default calendar. As that's the case we'll try to find a calendar called "Standard". If that doesn't exist, but we have some calendars, we'll just use the first one. Finally, if we have no calendars we'll create ourselves a default one.

Returns:

default project calendar

getByName

public ProjectCalendar getByName(String calendarName)

Retrieves the named calendar. This method will return null if the named calendar is not located.

Parameters:

calendarName - name of the required calendar

Returns:

ProjectCalendar instance