/* XMLParseException.java
*
* $Revision: 1950 $
* $Date: 2005-07-28 12:29:12 +0300 (Thu, 28 Jul 2005) $
* $Name$
*
* This file is part of NanoXML 2 Lite.
* Copyright (C) 2000-2002 Marc De Scheemaecker, All Rights Reserved.
*
* This software is provided 'as-is', without any express or implied warranty.
* In no event will the authors be held liable for any damages arising from the
* use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software in
* a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source distribution.
*****************************************************************************/
package org.jnode.nanoxml;
/**
* An XMLParseException is thrown when an error occures while parsing an XML
* string.
* <P>
* $Revision: 1950 $<BR>
* $Date: 2005-07-28 12:29:12 +0300 (Thu, 28 Jul 2005) $<P>
*
* @see org.jnode.nanoxml.XMLElement
*
* @author Marc De Scheemaecker
* @version $Name$, $Revision: 1950 $
*/
public class XMLParseException
extends RuntimeException
{
/**
* 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.
*
* <dl><dt><b>Invariants:</b></dt><dd>
* <ul><li><code>lineNr > 0 || lineNr == NO_LINE</code>
* </ul></dd></dl>
*/
private int lineNr;
/**
* Creates an exception.
*
* @param name The name of the element where the error is located.
* @param message A message describing what went wrong.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>message != null</code>
* </ul></dd></dl>
*
* <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.
*
* </dl><dl><dt><b>Preconditions:</b></dt><dd>
* <ul><li><code>message != null</code>
* <li><code>lineNr > 0</code>
* </ul></dd></dl>
*
* <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;
}
/**
* Where the error occurred, or <code>NO_LINE</code> if the line number is
* unknown.
*
* @see XMLParseException#NO_LINE
*/
public int getLineNr()
{
return this.lineNr;
}
}