FenixActionException.java

/**
 * Copyright © 2002 Instituto Superior Técnico
 *
 * This file is part of FenixEdu Academic.
 *
 * FenixEdu Academic is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FenixEdu Academic is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with FenixEdu Academic.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.fenixedu.academic.ui.struts.action.exceptions;

import org.apache.struts.action.ActionError;
import org.apache.struts.action.ActionForward;

/**
 * 
 * @author Luis Cruz & Nuno Nunes & João Mota
 */

// Note: When upgrading to struts 1.1 rc1 or above change
// extends declaration to ModuleException and remove already
// implemented methods and constructors.
public class FenixActionException extends Exception {

    /**
     * @param actionForward
     *            to forward to when error handling.
     */
    public FenixActionException(ActionForward actionForward) {
        this.actionForward = actionForward;
    }

    protected String property = "error.default";

    protected ActionError error = null;

    private ActionForward actionForward;

    // --- End of Variable Declarations ----------------------------------

    public FenixActionException() {
        super("error.default");
        error = new ActionError("error.default");
    }

    public FenixActionException(String key) {
        super(key);
        error = new ActionError(key);
    }

    public FenixActionException(String key, Object value) {
        super(key);
        error = new ActionError(key, value);
    }

    public FenixActionException(String key, Object value0, Object value1) {
        super(key);
        error = new ActionError(key, value0, value1);
    }

    public FenixActionException(String key, Object value0, Object value1, Object value2) {
        super(key);
        error = new ActionError(key, value0, value1, value2);
    }

    public FenixActionException(String key, Object value0, Object value1, Object value2, Object value3) {
        super(key);
        error = new ActionError(key, value0, value1, value2, value3);
    }

    public FenixActionException(String key, Object[] values) {
        super(key);
        error = new ActionError(key, values);
    }

    public FenixActionException(String key, Throwable cause) {
        super(key, cause);
        error = new ActionError(key);
    }

    public FenixActionException(String key, Object value, Throwable cause) {
        super(key, cause);
        error = new ActionError(key, value);
    }

    public FenixActionException(String key, Object value0, Object value1, Throwable cause) {
        super(key, cause);
        error = new ActionError(key, value0, value1);
    }

    public FenixActionException(String key, Object value0, Object value1, Object value2, Throwable cause) {
        super(key, cause);
        error = new ActionError(key, value0, value1, value2);
    }

    public FenixActionException(String key, Object value0, Object value1, Object value2, Object value3, Throwable cause) {
        super(key, cause);
        error = new ActionError(key, value0, value1, value2, value3);
    }

    public FenixActionException(String key, Object[] values, Throwable cause) {
        super(key, cause);
        error = new ActionError(key, values);
    }

    public FenixActionException(Throwable cause) {
        super(cause);
    }

    // --- End of Constructores ------------------------------------------
    @Override
    public String toString() {
        String result = "[" + this.getClass().getName() + "\n";
        result += "property" + this.getProperty() + "\n";
        result += "error" + this.getError() + "\n";
        result += "cause" + this.getCause() + "\n";
        result += "]";
        return result;
    }

    public String getProperty() {
        return (property != null) ? property : getError().getKey();
    }

    public void setProperty(String property) {
        this.property = property;
    }

    public ActionError getError() {
        return error;
    }

    /**
     * @return actionForward to forward to.
     */
    public ActionForward getActionForward() {
        return actionForward;
    }

}