Mercurial > hg > release > icedtea-web-1.5
view netx/net/sourceforge/nanoxml/XMLParseException.java @ 1038:6660f78e2691
Fixed doclint errors
author | Jiri Vanek <jvanek@redhat.com> |
---|---|
date | Fri, 17 Apr 2015 10:48:22 +0200 |
parents | 07e06846b07a |
children |
line wrap: on
line source
/* XMLParseException.java * * $Revision: 1.1 $ * $Date: 2002/08/03 04:05:32 $ * $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 net.sourceforge.nanoxml; /** * An XMLParseException is thrown when an error occures while parsing an XML * string. * <p> * $Revision: 1.1 $<br> * $Date: 2002/08/03 04:05:32 $</p> * * @see net.sourceforge.nanoxml.XMLElement * * @author Marc De Scheemaecker * @version $Name: $, $Revision: 1.1 $ */ 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} * </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><dt><b>Preconditions:</b></dt><dd> * <ul><li>{@code message != null}</li> * </ul></dd></dl> * * <dl><dt><b>Postconditions:</b></dt><dd> * <ul><li>{@code getLineNr() => NO_LINE}</li> * </ul></dd></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><dt><b>Preconditions:</b></dt><dd> * <ul><li>{@code message != null}</li> * <li>{@code lineNr > 0}</li> * </ul></dd></dl> * * <dl><dt><b>Postconditions:</b></dt><dd> * <ul><li>{@code getLineNr() => lineNr}</li> * </ul></dd></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} if the line number is * unknown. * * @see net.sourceforge.nanoxml.XMLParseException#NO_LINE */ public int getLineNr() { return this.lineNr; } }