Package ca.cgjennings.apps.arkham.project

Class TaskGroup

java.lang.Object

ca.cgjennings.apps.arkham.project.Member

ca.cgjennings.apps.arkham.project.Task

ca.cgjennings.apps.arkham.project.TaskGroup

All Implemented Interfaces:

IconProvider, java.lang.Comparable<Member>, java.lang.Iterable<Member>

Direct Known Subclasses:

Project

public class TaskGroup
extends Task

A TaskGoup is a task folder that is allowed to contain other Tasks. Moving a task folder into a task that is not a task group will cause the moved task to lose its task status and become a plain file.

Since:

3.0

Author:

Chris Jennings

See Also:

Project

Field Summary

Fields inherited from class ca.cgjennings.apps.arkham.project.Task

KEY_ICON, KEY_SUBTYPE, KEY_TYPE, TASK_SETTINGS

Constructor Summary

Constructors

Constructor	Description
TaskGroup(TaskGroup parent, java.io.File taskToOpen)

Method Summary

Modifier and Type	Method	Description
Task	addNewTask(NewTaskType ntt, java.lang.String folderName)	Create a new task in a project using a NewTaskType as a template.

Methods inherited from class ca.cgjennings.apps.arkham.project.Task

createTask, getCustomIcons, getSettings, isTaskFolder, readTaskSettings, registerCustomIcon, unregisterCustomIcon, writeTaskSettings

Methods inherited from class ca.cgjennings.apps.arkham.project.Member

compareTo, deleteFile, equals, findChild, findChild, getBaseName, getChildAt, getChildCount, getChildren, getExcludedFilePatterns, getExtension, getFile, getIcon, getIndex, getMetadataSource, getName, getParent, getProject, getTask, getURL, hasChildren, hashCode, isAncestorOf, isFileExcluded, isFolder, iterator, registerMetadataSource, renameFile, setExcludedFilePatterns, synchronize, toString, unregisterMetadataSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TaskGroup

public TaskGroup(TaskGroup parent,
                 java.io.File taskToOpen)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addNewTask

public Task addNewTask(NewTaskType ntt,
                       java.lang.String folderName)
                throws java.io.IOException

Create a new task in a project using a NewTaskType as a template. The new task is returned. If the task folder cannot be created or is only partially created, but cannot be completed to to point of initializing it, then it will be removed. If initialization begins but is not completed, it will be left in place.

Parameters:

ntt - the template used to initialize the task

folderName - the name to use for the new task folder (must not already exist)

Returns:

the new task

Throws:

java.io.IOException - if the task cannot be created