• Home
• org.daisy.streamline
• streamline-api
• 1.6.0
• source code
• ReadOnlyTask.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.ReadOnlyTask Maven / Gradle / Ivy

package org.daisy.streamline.api.tasks;

import java.io.File;

import org.daisy.streamline.api.media.AnnotatedFile;
import org.daisy.streamline.api.media.FileSet;

/**
 * Provides an abstract base for read only tasks. A read only task is 
 * a task that does not produce an altered output.
 * 
 * @author Joel Håkansson
 *
 */
public abstract class ReadOnlyTask extends InternalTask { //NOPMD

	/**
	 * Creates a new read only task with the specified name
	 * @param name the name of the task
	 */
	public ReadOnlyTask(String name) {
		super(name);
	}

	/**
	 * Apply the task to input
	 * @param input input file
	 * @throws InternalTaskException throws InternalTaskException if something goes wrong.
	 * @deprecated use {@link #execute(AnnotatedFile)}
	 */
	@Deprecated
	public abstract void execute(File input) throws InternalTaskException;
	
	/**
	 * Apply the task to input
	 * @param input input file
	 * @throws InternalTaskException throws InternalTaskException if something goes wrong
	 */
	public abstract void execute(AnnotatedFile input) throws InternalTaskException;
	
	/**
	 * Apply the task to input
	 * @param input input file set
	 * @throws InternalTaskException throws InternalTaskException if something goes wrong
	 */
	public void execute(FileSet input) throws InternalTaskException {
		execute(input.getManifest());
	}
	
	@Override
	public final Type getType() {
		return Type.READ_ONLY;
	}
	
	@Override
	public final ReadOnlyTask asReadOnlyTask() {
		return this;
	}

}