org.mpxj

Class TaskContainer

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.mpxj.ListWithCallbacks<T>

org.mpxj.ProjectEntityContainer<T>

org.mpxj.ProjectEntityWithIDContainer<Task>

org.mpxj.TaskContainer

All Implemented Interfaces:

Iterable<Task>, Collection<Task>, List<Task>, ChildTaskContainer

public class TaskContainer
extends ProjectEntityWithIDContainer<Task>
implements ChildTaskContainer

Manages the collection of tasks belonging to a project.

Field Summary

Fields inherited from class org.mpxj.ProjectEntityWithIDContainer

m_idMap

Fields inherited from class org.mpxj.ProjectEntityContainer

m_sequenceProvider

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
TaskContainer(ProjectFile projectFile) Constructor.

Method Summary

Modifier and Type	Method and Description
Task	add() Add a task to the project.
Task	addTask() Creates and adds a task to the list of tasks held by this object.
protected int	firstUniqueID() Returns the value of the first Unique ID to use when renumbering Unique IDs.
List<Task>	getChildTasks() Retrieve a list of child tasks held by this object.
List<CustomField>	getCustomFields() Retrieve a list of task custom fields.
FieldType	getFieldTypeByAlias(String alias) Retrieve the type of a field by its alias.
Set<FieldType>	getPopulatedFields() Retrieve the set of populated fields for this project.
void	removed(Task task) Called to notify subclasses of item removal.
void	synchronizeTaskIDToHierarchy() Microsoft Project bases the order of tasks displayed on their ID value.

Methods inherited from class org.mpxj.ProjectEntityWithIDContainer

getByID, getNextID, mapID, renumberIDs, unmapID

Methods inherited from class org.mpxj.ProjectEntityContainer

added, fixUniqueIdClashes, getByUniqueID, getSequenceProvider, updateUniqueID

Methods inherited from class org.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

TaskContainer

public TaskContainer(ProjectFile projectFile)

Constructor.

Parameters:

projectFile - parent project

Method Detail

getChildTasks

public List<Task> getChildTasks()

Description copied from interface: ChildTaskContainer

Retrieve a list of child tasks held by this object.

Specified by:

getChildTasks in interface ChildTaskContainer

Returns:

list of child tasks

addTask

public Task addTask()

Description copied from interface: ChildTaskContainer

Creates and adds a task to the list of tasks held by this object.

Specified by:

addTask in interface ChildTaskContainer

Returns:

newly created task

add

public Task add()

Add a task to the project.

Returns:

new task instance

removed

public void removed(Task task)

Description copied from class: ProjectEntityContainer

Called to notify subclasses of item removal.

Overrides:

removed in class ProjectEntityContainer<Task>

Parameters:

task - removed item

synchronizeTaskIDToHierarchy

public void synchronizeTaskIDToHierarchy()

Microsoft Project bases the order of tasks displayed on their ID value. This method takes the hierarchical structure of tasks represented in MPXJ and renumbers the ID values to ensure that this structure is displayed as expected in Microsoft Project. This is typically used to deal with the case where a hierarchical task structure has been created programmatically in MPXJ.

getPopulatedFields

public Set<FieldType> getPopulatedFields()

Retrieve the set of populated fields for this project.

Returns:

set of populated fields

getCustomFields

public List<CustomField> getCustomFields()

Retrieve a list of task custom fields.

Returns:

task custom fields

getFieldTypeByAlias

public FieldType getFieldTypeByAlias(String alias)

Retrieve the type of a field by its alias.

Parameters:

alias - field alias

Returns:

FieldType instance

firstUniqueID

protected int firstUniqueID()

Description copied from class: ProjectEntityContainer

Returns the value of the first Unique ID to use when renumbering Unique IDs.

Overrides:

firstUniqueID in class ProjectEntityContainer<Task>

Returns:

first Unique ID value