Coverage Report - org.jaxen.saxpath.XPathSyntaxException

Classes in this Package	Line Coverage	Branch Coverage	Complexity
XPathSyntaxException	95%	100%	1.1666666666666667;1.167

1		/*
2		* $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/saxpath/XPathSyntaxException.java,v 1.5 2005/05/03 13:09:50 elharo Exp $
3		* $Revision: 1.5 $
4		* $Date: 2005/05/03 13:09:50 $
5		*
6		* ====================================================================
7		*
8		* Copyright (C) 2000-2002 bob mcwhirter & James Strachan.
9		* All rights reserved.
10		*
11		* Redistribution and use in source and binary forms, with or without
12		* modification, are permitted provided that the following conditions
13		* are met:
14		*
15		* 1. Redistributions of source code must retain the above copyright
16		* notice, this list of conditions, and the following disclaimer.
17		*
18		* 2. Redistributions in binary form must reproduce the above copyright
19		* notice, this list of conditions, and the disclaimer that follows
20		* these conditions in the documentation and/or other materials
21		* provided with the distribution.
22		*
23		* 3. The name "Jaxen" must not be used to endorse or promote products
24		* derived from this software without prior written permission. For
25		* written permission, please contact license@jaxen.org.
26		*
27		* 4. Products derived from this software may not be called "Jaxen", nor
28		* may "Jaxen" appear in their name, without prior written permission
29		* from the Jaxen Project Management (pm@jaxen.org).
30		*
31		* In addition, we request (but do not require) that you include in the
32		* end-user documentation provided with the redistribution and/or in the
33		* software itself an acknowledgement equivalent to the following:
34		* "This product includes software developed by the
35		* Jaxen Project (http://www.jaxen.org/)."
36		* Alternatively, the acknowledgment may be graphical using the logos
37		* available at http://www.jaxen.org/
38		*
39		* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
40		* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41		* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42		* DISCLAIMED. IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
43		* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
46		* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
47		* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48		* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49		* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50		* SUCH DAMAGE.
51		*
52		* ====================================================================
53		* This software consists of voluntary contributions made by many
54		* individuals on behalf of the Jaxen Project and was originally
55		* created by bob mcwhirter <bob@werken.com> and
56		* James Strachan <jstrachan@apache.org>. For more information on the
57		* Jaxen Project, please see <http://www.jaxen.org/>.
58		*
59		* $Id: XPathSyntaxException.java,v 1.5 2005/05/03 13:09:50 elharo Exp $
60		*/
61
62		package org.jaxen.saxpath;
63
64
65		/**
66		* Represents a syntax error in an XPath expression.
67		* This is a compile-time error that is detectable irrespective of
68		* the context in which the XPath expression is evaluated.
69		*/
70		public class XPathSyntaxException extends org.jaxen.saxpath.SAXPathException
71		{
72		private String xpath;
73		private int position;
74
75		/**
76		* Creates a new XPathSyntaxException
77		*
78		* @param xpath the incorrect XPath expression
79		* @param position the index of the character at which the syntax error was detected
80		* @param message the detail message
81		*/
82		public XPathSyntaxException(String xpath,
83		int position,
84		String message)
85		{
86	45	super( message );
87	45	this.position = position;
88	45	this.xpath = xpath;
89	45	}
90
91		/**
92		* <p>
93		* Returns the index of the character at which the syntax error was detected
94		* in the XPath expression.
95		* </p>
96		*
97		* @return the character index in the XPath expression
98		* at which the syntax error was detected
99		*/
100		public int getPosition()
101		{
102	34	return this.position;
103		}
104
105		/**
106		* <p>
107		* Returns the syntactically incorrect XPath expression.
108		* </p>
109		*
110		* @return the syntactically incorrect XPath expression
111		*/
112		public String getXPath()
113		{
114	34	return this.xpath;
115		}
116
117		public String toString()
118		{
119	0	return getClass() + ": " + getXPath() + ": " + getPosition() + ": " + getMessage();
120		}
121
122		/**
123		* <p>
124		* Returns a string in the form <code>" ^"</code> which, when placed on the line
125		* below the XPath expression in a monospaced font, should point to the
126		* location of the error.
127		* </p>
128		*
129		* @return the position marker
130		*/
131		public String getPositionMarker()
132		{
133	1	int pos = getPosition();
134	1	StringBuffer buf = new StringBuffer(pos+1);
135	3	for ( int i = 0 ; i < pos ; ++i )
136		{
137	2	buf.append(" ");
138		}
139
140	1	buf.append("^");
141
142	1	return buf.toString();
143
144		}
145
146		/**
147		* <p>
148		* Returns a long formatted description of the error,
149		* including line breaks.
150		* </p>
151		*
152		* @return a longer description of the error on multiple lines
153		*/
154		public String getMultilineMessage()
155		{
156	1	StringBuffer buf = new StringBuffer();
157
158	1	buf.append( getMessage() );
159		// FIXME platform dependent line separator
160	1	buf.append( "\n" );
161	1	buf.append( getXPath() );
162	1	buf.append( "\n" );
163
164	1	buf.append( getPositionMarker() );
165
166	1	return buf.toString();
167		}
168
169		}