org.smooks.edi.edisax.EDIParseException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smooks-edi-sax Show documentation
The newest version!
/*-
 * ========================LICENSE_START=================================
 * smooks-edi-sax
 * %%
 * Copyright (C) 2020 Smooks
 * %%
 * Licensed under the terms of the Apache License Version 2.0, or
 * the GNU Lesser General Public License version 3.0 or later.
 *
 * SPDX-License-Identifier: Apache-2.0 OR LGPL-3.0-or-later
 *
 * ======================================================================
 *
 * 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.
 *
 * ======================================================================
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * =========================LICENSE_END==================================
 */
package org.smooks.edi.edisax;

import org.smooks.edi.edisax.model.internal.Edimap;
import org.smooks.edi.edisax.model.internal.MappingNode;
import org.xml.sax.SAXException;

/**
 * EDI message parsing exception.
 *
 * @author tfennelly
 */
public class EDIParseException extends SAXException {

    private static final long serialVersionUID = 1L;
    private MappingNode errorNode;
    private int segmentNumber;
    private String[] segmentline;

    /**
     * Public constructor.
     *
     * @param message Exception message.
     */
    public EDIParseException(String message) {
        super(message);
    }

    /**
     * Public constructor.
     *
     * @param message Exception message.
     * @param cause   Exception cause
     */
    public EDIParseException(String message, Exception cause) {
        super(message, cause);
    }

    /**
     * Public constructor.
     *
     * @param mappingModel The mapping model for the message on which the exception was encoutered.
     * @param message      Exception message.
     */
    public EDIParseException(Edimap mappingModel, String message) {
        super(getMessagePrefix(mappingModel) + "  " + message);
    }

    /**
     * Public constructor.
     *
     * @param mappingModel The mapping model for the message on which the exception was encoutered.
     * @param message      Exception message.
     * @param cause        Exception cause.
     */
    public EDIParseException(Edimap mappingModel, String message, Exception cause) {
        super(getMessagePrefix(mappingModel) + "  " + message, cause);
    }

    /**
     * Public constructor.
     *
     * @param message       Exception message.
     * @param cause         Exception cause
     * @param mappingNode   the Segment, Field or Component where error occured.
     * @param segmentNumber the segment number where the error occured.
     * @param segmentLine   the segment line where the error occured.
     */
    public EDIParseException(String message, Exception cause, MappingNode mappingNode, int segmentNumber, String[] segmentLine) {
        super(message, cause);
        this.errorNode = mappingNode;
        this.segmentNumber = segmentNumber;
        this.segmentline = segmentLine;
    }

    /**
     * Public constructor.
     *
     * @param mappingModel  The mapping model for the message on which the exception was encoutered.
     * @param message       Exception message.
     * @param mappingNode   the Segment, Field or Component where error occured.
     * @param segmentNumber the segment number where the error occured.
     * @param segmentLine   the segment line where the error occured.
     */
    public EDIParseException(Edimap mappingModel, String message, MappingNode mappingNode, int segmentNumber, String[] segmentLine) {
        super(getMessagePrefix(mappingModel) + "  " + message);
        this.errorNode = mappingNode;
        this.segmentNumber = segmentNumber;
        this.segmentline = segmentLine;
    }

    /**
     * Public constructor.
     *
     * @param mappingModel  The mapping model for the message on which the exception was encoutered.
     * @param message       Exception message.
     * @param cause         Exception cause.
     * @param mappingNode   the Segment, Field or Component where error occured.
     * @param segmentNumber the segment number where the error occured.
     * @param segmentLine   the segment line where the error occured.
     */
    public EDIParseException(Edimap mappingModel, String message, Exception cause, MappingNode mappingNode, int segmentNumber, String[] segmentLine) {
        super(getMessagePrefix(mappingModel) + "  " + message, cause);
        this.errorNode = mappingNode;
        this.segmentNumber = segmentNumber;
        this.segmentline = segmentLine;
    }

    private static String getMessagePrefix(Edimap mappingModel) {
        return "EDI message processing failed [" + mappingModel.getDescription().getName() + "][" + mappingModel.getDescription().getVersion() + "].";
    }

    public MappingNode getErrorNode() {
        return errorNode;
    }

    public int getSegmentNumber() {
        return segmentNumber;
    }

    public String[] getSegmentline() {
        return segmentline;
    }
}