• Home
• org.daisy.streamline
• streamline-api
• 1.6.0
• source code
• TaskGroup.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.daisy.streamline.api.tasks.TaskGroup Maven / Gradle / Ivy

package org.daisy.streamline.api.tasks;

import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.daisy.streamline.api.option.UserOption;


/**
 * a task group is a file/fileset conversion unit. An implementation
 * should provide a useful small conversion step that may be used in a
 * larger context, for example to assemble a task system based on
 * several such implementations. However, a task group MUST NOT
 * depend on other task groups to serve it's purpose.
 * 
 * @author Joel Håkansson
 */
public interface TaskGroup {
	
	/**
	 * Get a descriptive name for the task group
	 * @return returns the name for the task group
	 */
	public default String getName() {
		return this.getClass().getName();
	}
	
	/**
	 * Gets a list of parameters applicable to this instance
	 * @return returns a list of parameters
	 */
	public default List getOptions() {
		return Collections.emptyList();
	}

	/**
	 * Compile the task group using the supplied parameters
	 * @param parameters the parameters to pass to the task group
	 * @return returns a list of InternalTasks
	 * @throws TaskSystemException throws TaskSystemException if something goes wrong when compiling the task group
	 */
	public List compile(Map parameters) throws TaskSystemException;

}