001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.exceptions;
051:
052: import org.jaffa.util.MessageHelper;
053:
054: /** This is the base class for all Jaffa exceptions.
055: */
056: public abstract class CustomException extends Exception {
057:
058: /** Holds value of property arguments. */
059: protected Object[] m_arguments;
060:
061: /** Creates an exception with the errorCode.
062: * @param errorCode the errorCode
063: */
064: protected CustomException(String errorCode) {
065: this (errorCode, null);
066: }
067:
068: /** Creates an exception with the errorCode and a cause.
069: * @param errorCode the errorCode.
070: * @param arguments the arguments, if any, that need to be merged into the error message from the resource bundle.
071: */
072: protected CustomException(String errorCode, Object[] arguments) {
073: this (errorCode, arguments, null);
074: }
075:
076: /** Creates an exception with the errorCode and a cause.
077: * @param errorCode the errorCode.
078: * @param arguments the arguments, if any, that need to be merged into the error message from the resource bundle.
079: * @param cause the cause.
080: */
081: protected CustomException(String errorCode, Object[] arguments,
082: Throwable cause) {
083: super (errorCode, cause);
084: m_arguments = arguments;
085: }
086:
087: /** Getter for property arguments.
088: * @return Value of property arguments.
089: */
090: public Object[] getArguments() {
091: return m_arguments;
092: }
093:
094: /** This will look up the errorCode in the default resource bundle and return an appropriate message.
095: * The errorCode will be returned as is, if no default resource bundle is specified in the framework.properties file or if no message is found for the error code.
096: * @return the message from the default resource bundle for the errorCode.
097: */
098: public String getLocalizedMessage() {
099: String message = MessageHelper.findMessage(getMessage(),
100: m_arguments);
101: return message == null ? getMessage() : message;
102: }
103:
104: /** Returns the message from the base class.
105: * @return the message from the base class.
106: */
107: public String getMessage() {
108: return super.getMessage();
109: }
110:
111: }
|