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) 2005 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.core.exceptions;
18  
19  /**
20   * This exception will be thrown when an object does not exist.
21   *
22   * @svnLink $Revision: 3881 $;$Date: 2009-08-04 15:22:05 +0200 (Di, 04. Aug 2009) $;$Author: swismer $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/core/src/main/java/ch/elca/el4j/core/exceptions/ObjectDoesNotExistException.java $
23   *
24   * @author Martin Zeltner (MZE)
25   * @deprecated Spring data access exception will be used.
26   * @see org.springframework.dao.DataRetrievalFailureException
27   */
28  public class ObjectDoesNotExistException extends BaseException {
29  	/**
30  	 * Message, which has to be formated.
31  	 */
32  	public static final String EXCEPTION_MESSAGE_OBJECTDOESNOTEXIST
33  		= "The desired {0} does not exist.";
34  
35  	/**
36  	 * Name of the object, where the exception occured.
37  	 */
38  	protected String m_objectName;
39  
40  	/**
41  	 * Constructor.
42  	 *
43  	 * @param objectName
44  	 *            Is the name of the object, where the exception occured.
45  	 */
46  	public ObjectDoesNotExistException(String objectName) {
47  		this(objectName, (Throwable) null);
48  	}
49  
50  	/**
51  	 * Constructor.
52  	 *
53  	 * @param objectName
54  	 *            Is the name of the object, where the exception occured.
55  	 * @param cause
56  	 *            Is the cause for this exception.
57  	 */
58  	public ObjectDoesNotExistException(String objectName, Throwable cause) {
59  		super(EXCEPTION_MESSAGE_OBJECTDOESNOTEXIST, cause);
60  		m_objectName = objectName;
61  	}
62  
63  	/**
64  	 * @return Returns the objectName.
65  	 */
66  	public String getObjectName() {
67  		return m_objectName;
68  	}
69  
70  	/**
71  	 * {@inheritDoc}
72  	 */
73  	public Object[] getFormatParameters() {
74  		return new Object[] {m_objectName};
75  	}
76  }