org.jdal.cmd.DefaultTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdal-core Show documentation
JDAL Core Library
The newest version!
/*
 * Copyright 2008-2010 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jdal.cmd;

import java.util.LinkedList;
import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Composite of commands that delegate operations to collections.
 * A command may be added as preprocessor, command or postprocessor
 * 
 * @author Jose Luis Martin - ([email protected])
 */

public class DefaultTask   implements Task {
	
	/** Log */
	private static Log log = LogFactory.getLog(DefaultTask.class);
	/** Stop executing commands on command fault */
	private boolean stopOnFault = false;
	/** List of commands executed first */
    private List preProcessors;
    /** List of commands executed last */
    private List postProcessors;
    /** List of commands to execute */
    private List commands;
    /** Command Name */
    private String name;
    
    /**
     * Default Ctor.
     */
    public DefaultTask() {
    	
        preProcessors = new LinkedList();
        postProcessors = new LinkedList();
        commands = new LinkedList();
    }
 
    /**
     * Add a Command to the command list of task
     * 
     * @param c Command to add.
     */
    public void addCommand(Command c) {
        commands.add(c);
    }
    
    /** 
     * Add a list of commands
     * @param cmdList the command list to add
     */
    public void addComand(List cmdList) {
    	commands.addAll(cmdList);
    }
    
    /**
     * Remove a Command from command list of task
     * 
     * @param c Commmand to remove
     */
    public void removeComannd(Command c) {
        if (commands.contains(c)) {
            commands.remove(c);
        }
    }

    /**
     * Add a Command to prepocesor command list
     * 
     * @param c Command to add.
     */
    public void addPreprocesor(Command c) {
        preProcessors.add(c);
    }

    /**
     * Remove a Command from preprocesor command list
     * 
     * @param c Command to remove.
     */
    public void removePreprocesor(Command c) {
    	if (preProcessors.contains(c)) {
    		preProcessors.remove(c);
    	}
    }
    
    /** 
     * Add a Command to postprocessor command list
     * 
     * @param c Command to add.
     */
    public void addPostProcessor(Command c) {
        postProcessors.add(c);
    }
    
    /**
     * Remove a Command to postprocesor list of task
     * 
     * @param c Command to removce.
     */
    public void removePostProcessor(Command c) {
    	if (postProcessors.contains(c)) {
    		postProcessors.remove(c);
    	}
    }
    
    /**
     * Execute prepocesors, commands and postprocessors in order
     * throw a CommandException if some command fails an stopOnfault
     * is true.
     *
     * @param data with command data
     * @return true if command ok.
     */
    public boolean execute(Object data) {
        boolean result = true;

        for (Command cmd : newCommandList()) {
        	try {
        		cmd.execute(data);
        	} catch (CommandException ce) {
        		log.error(ce);
        		onFault(ce);
        		result = false;
        		
        		if (stopOnFault) { 
        			throw ce;
        		}
        	}
        }
        return result;
    }
    
	/**
	 * Composite onFault to Commands
	 * @param data generic command data
	 */
    public void onFault(Object data) {
		for (Command cmd : newCommandList()) {
			cmd.onFault(data);
		}
	}
    
    /**
	 * Creates a new command list
	 * @return list a new Command List with all commands from 
	 * pre, commmand, post lists.
	 */
	public List newCommandList() {
		List list  = new LinkedList();
		list.addAll(this.preProcessors);
		list.addAll(this.commands);
		list.addAll(this.postProcessors);
		
		return list;
	}
    
    // Getter And Setters
	
	/**
	 * @return list of commands 
	 */
	public List  getCommands() {
		return commands;
	}
	/**
	 * @param commands list of commands to set
	 */
	public void setCommands(List commands) {
		this.commands = commands;
	}
	/**
	 * 
	 * @return postprocesor command list
	 */
	public List  getPostProcessors() {
		return postProcessors;
	}
	/**
	 * 
	 * @param postProcessors command list to set
	 */
	public void setPostProcessors(List postProcessors) {
		this.postProcessors = postProcessors;
	}
	/**
	 * @return preprocesor command list
	 */
	public List  getPreProcessors() {
		return preProcessors;
	}
	/**
	 * @param preProcessors command list to sets
	 */
	public void setPreProcessors(List preProcessors) {
		this.preProcessors = preProcessors;
	}

	/**
	 * @return the name
	 */
	public String getName() {
		return name;
	}

	/**
	 * @param name the name to set
	 */
	public void setName(String name) {
		this.name = name;
	}

	/** 
	 * Undo command 
	 */
	public void undo() {
		for (Command cmd : newCommandList()) {
			cmd.undo();
		}
	}


}