

package org.visualtrading.xml.nanoxml;


/**
 * An XMLParseException is thrown when an error occures while parsing an XML string. <P> $Revision: 1.2 $<BR> $Date:
 * 2005/01/26 21:43:45 $<P>
 *
 * @author Marc De Scheemaecker
 * @version $Name:  $, $Revision: 1.2 $
 * @see nanoxml.XMLElement
 */
public class XMLParseException
        extends RuntimeException {

// ------------------------------ FIELDS ------------------------------

    /**
     * Indicates that no line number has been associated with this exception.
     */
    public static final int NO_LINE = -1;


    /**
     * The line number in the source code where the error occurred, or <code>NO_LINE</code> if the line number is
     * unknown.
     * <p/>
     * <dl><dt><b>Invariants:</b></dt><dd> <ul><li><code>lineNr &gt 0 || lineNr == NO_LINE</code> </ul></dd></dl>
     */
    private int lineNr;

// --------------------------- CONSTRUCTORS ---------------------------

    /**
     * Creates an exception.
     *
     * @param name    The name of the element where the error is located.
     * @param message A message describing what went wrong.
     *                <p/>
     *                </dl><dl><dt><b>Preconditions:</b></dt><dd> <ul><li><code>message != null</code> </ul></dd></dl>
     *                <p/>
     *                <dl><dt><b>Postconditions:</b></dt><dd> <ul><li>getLineNr() => NO_LINE </ul></dd></dl><dl>
     */
    public XMLParseException(String name,
                             String message) {
        super("XML Parse Exception during parsing of "
              + ((name == null) ? "the XML definition"
                 : ("a " + name + " element"))
              + ": " + message);
        this.lineNr = XMLParseException.NO_LINE;
    }


    /**
     * Creates an exception.
     *
     * @param name    The name of the element where the error is located.
     * @param lineNr  The number of the line in the input.
     * @param message A message describing what went wrong.
     *                <p/>
     *                </dl><dl><dt><b>Preconditions:</b></dt><dd> <ul><li><code>message != null</code> <li><code>lineNr
     *                &gt; 0</code> </ul></dd></dl>
     *                <p/>
     *                <dl><dt><b>Postconditions:</b></dt><dd> <ul><li>getLineNr() => lineNr </ul></dd></dl><dl>
     */
    public XMLParseException(String name,
                             int lineNr,
                             String message) {
        super("XML Parse Exception during parsing of "
              + ((name == null) ? "the XML definition"
                 : ("a " + name + " element"))
              + " at line " + lineNr + ": " + message);
        this.lineNr = lineNr;
    }

// --------------------- GETTER / SETTER METHODS ---------------------

    /**
     * Where the error occurred, or <code>NO_LINE</code> if the line number is unknown.
     *
     * @see nanoxml.XMLParseException#NO_LINE
     */
    public int getLineNr() {
        return this.lineNr;
    }

}
