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.Document;
20  
21  /**
22   * Thrown when something is wrong with a source or output document.
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/DocumentException.java $
25   *
26   * @author Laurent Bovet (LBO)
27   * @author Alex Mathey (AMA)
28   */
29  public class DocumentException extends AbstractXmlMergeException {
30  
31  	/**
32  	 * A document instance.
33  	 */
34  	Document m_document;
35  	
36  	/**
37  	 * Constructor with message.
38  	 *
39  	 * @param document Document which caused the exception
40  	 * @param message Exception message
41  	 */
42  	public DocumentException(Document document, String message) {
43  		super(message);
44  		m_document = document;
45  	}
46  
47  	/**
48  	 * Constructor with cause.
49  	 *
50  	 * @param document Document which caused the exception
51  	 * @param cause Exception cause
52  	 */
53  	public DocumentException(Document document, Throwable cause) {
54  		super(makeMessage(document), cause);
55  		m_document = document;
56  	}
57  
58  	/**
59  	 * Announces that there is a problem with the given document.
60  	 * @param document A given document
61  	 * @return String announcing that there is a problem with the given document
62  	 */
63  	private static String makeMessage(Document document) {
64  		return "Problem with document " + document;
65  	}
66  
67  	/**
68  	 * @return Returns the document.
69  	 */
70  	public Document getDocument() {
71  		return m_document;
72  	}
73  
74  	/**
75  	 * @param document Is the document to set.
76  	 */
77  	public void setDocument(Document document) {
78  		m_document = document;
79  	}
80  	
81  }