plume

Class TaskManager

java.lang.Object

plume.TaskManager

Deprecated.

Is undocumented

@Deprecated
public class TaskManager
extends java.lang.Object

TaskManager extracts information about tasks from text files and provides structured output. For example, it can extract all of the tasks associated with a specific milestone or person and total the amount of work required.

The command-line arguments are as follows:

• -r --responsible=string. Include only those tasks assigned to the specified person
• -m --milestone=string. Include only those tasks required for the specified milestone
• -c --completed=boolean. Include only completed tasks [default false]
• -o --open=boolean. Include only open tasks [default false]
• -v --verbose=boolean. Print progress information [default false]
• -f --format=enum. Specify output format [default short_ascii]
  • short_ascii
  • short_html
  • milestone_html
• --comment-re=string. Regex that matches an entire comment (not just a comment start) [default ^%.*]
• --include-re=string. Regex that matches an include directive; group 1 is the file name [default \\include\{(.*)\}]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskManager.OutputFormat Deprecated. The format in which to output the TaskManager information.
static class	TaskManager.Task Deprecated. Information about a single task.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	comment_re Deprecated.
static boolean	completed Deprecated.
static TaskManager.OutputFormat	format Deprecated.
static java.lang.String	include_re Deprecated.
static java.lang.String	lineSep Deprecated.
static java.lang.String	milestone Deprecated.
static boolean	open Deprecated.
static java.lang.String	responsible Deprecated.
java.util.List<TaskManager.Task>	tasks Deprecated. List of all of the tasks.
static boolean	verbose Deprecated.

Constructor Summary

Constructors

Constructor and Description
TaskManager() Deprecated. empty TaskManger.
TaskManager(java.lang.String[] filenames) Deprecated. initializes a task manager with all of the tasks in filenames.

Method Summary

Modifier and Type	Method and Description
void	add(TaskManager.Task task) Deprecated. Adds the specified task to the end of the task list.
TaskManager	completed_only() Deprecated. Create a new TaskManger with only completed tasks.
static void	main(java.lang.String[] args) Deprecated.
TaskManager	milestone_match(java.lang.String milestone) Deprecated. Create a new TaskManger with only those tasks in milestone.
TaskManager	open_only() Deprecated. Create a new TaskManger with only open tasks.
TaskManager	responsible_match(java.lang.String responsible) Deprecated. Create a new TaskManger with only those tasks assigned to responsible.
java.lang.String	toString_milestone_html() Deprecated.
java.lang.String	toString_short_ascii() Deprecated.
java.lang.String	toString_short_html() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

responsible

public static java.lang.String responsible

Deprecated.

milestone

public static java.lang.String milestone

Deprecated.

completed

public static boolean completed

Deprecated.

open

public static boolean open

Deprecated.

verbose

public static boolean verbose

Deprecated.

format

public static TaskManager.OutputFormat format

Deprecated.

comment_re

public static java.lang.String comment_re

Deprecated.

include_re

public static java.lang.String include_re

Deprecated.

lineSep

public static final java.lang.String lineSep

Deprecated.

tasks

public java.util.List<TaskManager.Task> tasks

Deprecated.

List of all of the tasks.

Constructor Detail

TaskManager

public TaskManager()

Deprecated.

empty TaskManger.

TaskManager

public TaskManager(java.lang.String[] filenames)
            throws java.io.IOException

Deprecated.

initializes a task manager with all of the tasks in filenames.

Parameters:

filenames - list of files to read tasks from

Throws:

java.io.IOException - if there is trouble reading a file

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

toString_short_ascii

public java.lang.String toString_short_ascii()

Deprecated.

toString_short_html

public java.lang.String toString_short_html()

Deprecated.

toString_milestone_html

public java.lang.String toString_milestone_html()

Deprecated.

add

public void add(TaskManager.Task task)

Deprecated.

Adds the specified task to the end of the task list.

Parameters:

task - the task to be queued on the task list

responsible_match

public TaskManager responsible_match(java.lang.String responsible)

Deprecated.

Create a new TaskManger with only those tasks assigned to responsible. All tasks match a responsible value of null.

Parameters:

responsible - name of the responsible party, or null; search for tasks assigned to responsible

Returns:

a TaskManger with only those tasks assigned to responsible

milestone_match

public TaskManager milestone_match(java.lang.String milestone)

Deprecated.

Create a new TaskManger with only those tasks in milestone.

Parameters:

milestone - milestone to search for

Returns:

TaskManger with only the tasks in the given milestone

completed_only

public TaskManager completed_only()

Deprecated.

Create a new TaskManger with only completed tasks.

Returns:

a new TaskManger with only completed tasks

open_only

public TaskManager open_only()

Deprecated.

Create a new TaskManger with only open tasks.

Returns:

a new TaskManger with only completed tasks