View Javadoc

1   /*
2   $Id: GroovyBugError.java,v 1.3 2006/01/19 00:06:46 blackdrag Exp $
3   
4   Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
5   
6   Redistribution and use of this software and associated documentation
7   ("Software"), with or without modification, are permitted provided
8   that the following conditions are met:
9   
10  1. Redistributions of source code must retain copyright
11     statements and notices.  Redistributions must also contain a
12     copy of this document.
13  
14  2. Redistributions in binary form must reproduce the
15     above copyright notice, this list of conditions and the
16     following disclaimer in the documentation and/or other
17     materials provided with the distribution.
18  
19  3. The name "groovy" must not be used to endorse or promote
20     products derived from this Software without prior written
21     permission of The Codehaus.  For written permission,
22     please contact info@codehaus.org.
23  
24  4. Products derived from this Software may not be called "groovy"
25     nor may "groovy" appear in their names without prior written
26     permission of The Codehaus. "groovy" is a registered
27     trademark of The Codehaus.
28  
29  5. Due credit should be given to The Codehaus -
30     http://groovy.codehaus.org/
31  
32  THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33  ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34  NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
36  THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43  OF THE POSSIBILITY OF SUCH DAMAGE.
44  */
45  package org.codehaus.groovy;
46  
47  /***
48   * This class represents an error that is thrown when a bug is 
49   * recognized inside the runtime. Basically it is thrown when
50   * a constraint is not fullfilled that should be fullfiled. 
51   * 
52   * @author Jochen Theodorou
53   */
54  public class GroovyBugError extends AssertionError {
55      
56      // message string
57      private String    message;
58      // optional exception
59      private Exception exception;
60  
61      /***
62       * constructs a bug error using the given text
63       * @param text the error message text
64       */
65      public GroovyBugError( String message ) {
66          this.message = message;
67      }
68      
69      /***
70       * Constructs a bug error using the given exception
71       * @param exception cause of this error
72       */
73      public GroovyBugError( Exception exception ) {
74          this.exception = exception;
75      }
76      
77      /***
78       * Constructs a bug error using the given exception and
79       * a text with additional information about the cause 
80       * @param msg additional information about this error
81       * @param exception cause of this error
82       */
83      public GroovyBugError( String msg, Exception exception )
84      {
85          this.exception = exception;
86          this.message = msg;
87      }
88  
89      /***
90       * Returns a String representation of this class by calling <code>getMessage()</code>.  
91       * @see #getMessage()
92       */
93      public String toString() {
94          return getMessage();
95      }
96      
97      /***
98       * Returns the detail message string of this error. The message 
99       * will consist of the bug text prefixed by "BUG! " if there this
100      * isntance was created using a message. If this error was 
101      * constructed without using a bug text the message of the cause 
102      * is used prefixed by "BUG! UNCAUGHT EXCEPTION: "
103      *  
104      * @return the detail message string of this error.
105      */
106     public String getMessage() {
107         if( message != null )
108         {
109             return "BUG! "+message;
110         }
111         else
112         {
113             return "BUG! UNCAUGHT EXCEPTION: " + exception.getMessage();
114         }
115     }
116     
117     public Throwable getCause() {
118         return this.exception;
119     }    
120     
121     /***
122      * Returns the bug text to describe this error
123      */
124     public String getBugText(){
125         if( message != null ){
126             return message;
127         } else {
128             return exception.getMessage();
129         }
130     }
131     
132     /***
133      * Sets the bug text to describe this error
134      */
135     public void setBugText(String msg) {
136         this.message = msg;
137     }
138 }