TagRunnerRuntimeException.java

/*
 * Copyright 2008 FatWire Corporation. All Rights Reserved.
 *
 * 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 com.fatwire.gst.foundation.facade.runtag;

import COM.FutureTense.Interfaces.FTValList;
import COM.FutureTense.Util.ftErrors;
import com.fatwire.gst.foundation.CSRuntimeException;


/**
 * Exception that is thrown when a TagRunner is invoked and the
 * 
 * @author Dolf.Dijkstra
 * @deprecated - com.fatwire.gst.foundation.facade and all subpackages have moved to the tools.gsf.facade package
 */
public class TagRunnerRuntimeException extends CSRuntimeException {
    private final String pageName;
    private final String elementName;
    private final FTValList arguments;
    private static final long serialVersionUID = 5392042951880858120L;

    /** 
     * @param msg message
     * @param errno error number
     * @param arguments list of arguments
     */
    public TagRunnerRuntimeException(String msg, int errno, final FTValList arguments) {
        this(msg, errno, arguments, null, null, null);
    }

    public TagRunnerRuntimeException(String msg, int errno, final FTValList arguments, ftErrors complexError,
            String pagename, String elementname) {
        super(msg, complexError, errno);
        this.arguments = arguments;
        this.pageName = pagename;
        this.elementName = elementname;
    }

    /**
     * @return the pagename that generated this exception or null if this was
     *         not provided
     */
    public String getPageName() {
        return pageName;
    }

    /**
     * @return the name of the element that generated this exception or null if
     *         this was not provided
     */
    public String getElementName() {
        return elementName;
    }

    public FTValList getArguments() {
        return arguments;
    }

    @Override
    public String getMessage() {
        StringBuilder builder = new StringBuilder();
        builder.append(super.getMessage());
        builder.append("|");
        builder.append(arguments);
        builder.append("|");
        builder.append(getPageName());
        builder.append("|");
        builder.append(getElementName());
        if (getComplexError() != null) {
            builder.append("|");
            builder.append("reason: ").append(getComplexError().getReason());
            builder.append("|message: ");
            builder.append(getComplexError().getMessage());

            int details = getComplexError().details();
            if (details > 0) {
                builder.append("|");
            }
            for (int i = 0; i < details; i++) {
                builder.append(" ");
                builder.append(getComplexError().detail(i));
            }
        }
        return builder.toString();
    }
}