org.qetools.task_generator

Class TaskGenerator

java.lang.Object

org.qetools.task_generator.TaskGenerator

public class TaskGenerator
extends Object

Generates epics, tasks and subtasks from a YAML template.

Author:

Andrej Podhradsky

Constructor Summary

Constructors

Constructor and Description
TaskGenerator(JiraClient jiraClient) Constructs the generator with a given Jira client.
TaskGenerator(JiraClient jiraClient, File propertyFile) Constructs the generator with a given Jira client.

Method Summary

Modifier and Type	Method and Description
protected void	createEpic(Epic epic) Creates epic.
protected void	createSubtask(Task subtask, Task task) Creates a subtask of a given task / epic.
protected void	createTask(Task task, Epic epic) Creates a task which will be linked the an epic.
protected Map<String,String>	fields(Task task)
void	generate(File yamlFile) Generates epics, tasks and subtasks from a YAML template.
protected void	initializeJiraClient(Template template, File yamlFile) Initializes the Jira client with respect of variables defined an a given template.
protected Task	resolve(Task task)
protected Task	setMissingFields(Task child, Task parent) Sets missing task fields from a parent.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskGenerator

public TaskGenerator(JiraClient jiraClient)
              throws FileNotFoundException,
                     IOException

Constructs the generator with a given Jira client.

Parameters:

jiraClient - Jira client

Throws:

FileNotFoundException

IOException

TaskGenerator

public TaskGenerator(JiraClient jiraClient,
                     File propertyFile)
              throws FileNotFoundException,
                     IOException

Constructs the generator with a given Jira client. You can also specify a property file which will be used for variable substitution in a template.

Parameters:

jiraClient - Jira client

propertyFile - Property file

Throws:

FileNotFoundException

IOException

Method Detail

generate

public void generate(File yamlFile)

Generates epics, tasks and subtasks from a YAML template.

Parameters:

yamlFile - YAML template

initializeJiraClient

protected void initializeJiraClient(Template template,
                                    File yamlFile)

Initializes the Jira client with respect of variables defined an a given template. A given YAML file is used just for resolving relative paths in the template.

Parameters:

template - Template

yamlFile - YAML file of the template

createEpic

protected void createEpic(Epic epic)

Creates epic.

Parameters:

epic - Epic

createTask

protected void createTask(Task task,
                          Epic epic)

Creates a task which will be linked the an epic.

Parameters:

task - Task

epic - Epic

createSubtask

protected void createSubtask(Task subtask,
                             Task task)

Creates a subtask of a given task / epic.

Parameters:

subtask - Subtask

task - Parent task / epic

fields

protected Map<String,String> fields(Task task)

resolve

protected Task resolve(Task task)

setMissingFields

protected Task setMissingFields(Task child,
                                Task parent)

Sets missing task fields from a parent.

Parameters:

child - Child

parent - Parent

Returns:

All task fields