001: /*--
002:
003: Copyright (C) 2000-2003 Anthony Eden.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The name "EdenLib" must not be used to endorse or promote products
019: derived from this software without prior written permission. For
020: written permission, please contact me@anthonyeden.com.
021:
022: 4. Products derived from this software may not be called "EdenLib", nor
023: may "EdenLib" appear in their name, without prior written permission
024: from Anthony Eden (me@anthonyeden.com).
025:
026: In addition, I request (but do not require) that you include in the
027: end-user documentation provided with the redistribution and/or in the
028: software itself an acknowledgement equivalent to the following:
029: "This product includes software developed by
030: Anthony Eden (http://www.anthonyeden.com/)."
031:
032: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
033: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
034: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
035: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
036: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
037: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
038: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
039: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
040: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
041: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
042: POSSIBILITY OF SUCH DAMAGE.
043:
044: For more information on EdenLib, please see <http://edenlib.sf.net/>.
045:
046: */
047:
048: package com.anthonyeden.lib.config;
049:
050: import com.anthonyeden.lib.ChainedException;
051: import com.anthonyeden.lib.util.MessageUtilities;
052:
053: /**
054: * Exception thrown when there is an error while reading, writing or
055: * manipulating Configurations.
056: *
057: * @author Anthony Eden
058: */
059:
060: public class ConfigurationException extends ChainedException {
061:
062: private static final String MESSAGE_PACKAGE = "com.anthonyeden.lib";
063:
064: private Configuration configuration;
065:
066: /**
067: * Construct a ConfigurationException with the given message.
068: *
069: * @param message The message
070: */
071:
072: public ConfigurationException(String message) {
073: this (message, null, null);
074: }
075:
076: /**
077: * Construct a ConfigurationException with the given message.
078: *
079: * @param t The Throwable
080: */
081:
082: public ConfigurationException(Throwable t) {
083: this (t.getMessage(), t);
084: }
085:
086: /**
087: * Construct a ConfigurationException with the given message.
088: *
089: * @param message The message
090: */
091:
092: public ConfigurationException(String message, Throwable t) {
093: this (message, t, null);
094: }
095:
096: /**
097: * Construct a ConfigurationException with the given message.
098: *
099: * @param message The message
100: * @param configuration The Configuration object
101: */
102:
103: public ConfigurationException(String message,
104: Configuration configuration) {
105: this (message, null, configuration);
106: }
107:
108: /**
109: * Construct a ConfigurationException with the given nested
110: * error. The message of the nested error will be used as this
111: * exception's message.
112: *
113: * @param t The nested error
114: * @param configuration The Configuration object
115: */
116:
117: public ConfigurationException(Throwable t,
118: Configuration configuration) {
119: this (t.getMessage(), t, configuration);
120: }
121:
122: /**
123: * Construct a ConfigurationException with the given message
124: * and nested error.
125: *
126: * @param message The message
127: * @param t The nested error
128: * @param configuration The Configuration
129: */
130:
131: public ConfigurationException(String message, Throwable t,
132: Configuration configuration) {
133: super (message, t);
134: this .configuration = configuration;
135: }
136:
137: /**
138: * Overrides the Throwable.getMessage() method and adds additional
139: * configuration location information if it is available.
140: *
141: * @return The message
142: */
143:
144: public String getMessage() {
145: String message = super .getMessage();
146: if (configuration != null) {
147: Location location = configuration.getLocation();
148: if (location != null) {
149: Object[] args = { location.getSourceId(),
150: String.valueOf(location.getLineNumber()),
151: String.valueOf(location.getColumnNumber()) };
152: return message
153: + MessageUtilities.getMessage(getClass(),
154: MESSAGE_PACKAGE, "location", args);
155: }
156: }
157: return message;
158: }
159:
160: }
|