View Javadoc

1   /*
2    * EL4J, the Extension Library for the J2EE, adds incremental enhancements to
3    * the spring framework, http://el4j.sf.net
4    * Copyright (C) 2006 by ELCA Informatique SA, Av. de la Harpe 22-24,
5    * 1000 Lausanne, Switzerland, http://www.elca.ch
6    *
7    * EL4J is published under the GNU Lesser General Public License (LGPL)
8    * Version 2.1. See http://www.gnu.org/licenses/
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13   * GNU Lesser General Public License for more details.
14   *
15   * For alternative licensing, please contact info@elca.ch
16   */
17  package ch.elca.el4j.services.xmlmerge;
18  
19  import org.jdom.Element;
20  
21  /**
22   * Thrown when there is something wrong with an element.
23   *
24   * @svnLink $Revision: 3874 $;$Date: 2009-08-04 14:25:40 +0200 (Di, 04. Aug 2009) $;$Author: swismer $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/xml_merge/common/src/main/java/ch/elca/el4j/services/xmlmerge/ElementException.java $
25   *
26   * @author Laurent Bovet (LBO)
27   * @author Alex Mathey (AMA)
28   */
29  public class ElementException extends AbstractXmlMergeException {
30  
31  	/**
32  	 * An element instance.
33  	 */
34  	Element m_element;
35  
36  	/**
37  	 * Constructor.
38  	 *
39  	 * @param element Element which caused the exception
40  	 */
41  	public ElementException(Element element) {
42  		super(makeMessage(element));
43  		this.m_element = element;
44  	}
45  
46  	/**
47  	 * Constructor with message.
48  	 *
49  	 * @param element Element which caused the exception
50  	 * @param message Exception message
51  	 */
52  	public ElementException(Element element, String message) {
53  		super(message);
54  		this.m_element = element;
55  	}
56  	
57  	/**
58  	 * Constructor with cause.
59  	 *
60  	 * @param element Element which caused the exception
61  	 * @param cause Exception cause
62  	 */
63  	public ElementException(Element element, Throwable cause) {
64  		super(makeMessage(element), cause);
65  	}
66  
67  	/**
68  	 * @return Returns the element.
69  	 */
70  	public Element getElement() {
71  		return m_element;
72  	}
73  
74  	/**
75  	 * @param element Is the element to set.
76  	 */
77  	public void setElement(Element element) {
78  		m_element = element;
79  	}
80   
81  	/**
82  	 * Announces that there is a problem with the given element.
83  	 * @param element A given element
84  	 * @return String announcing that there is a problem with the given element
85  	 */
86  	private static String makeMessage(Element element) {
87  		return "Problem with element " + element;
88  	}
89  	
90  }