1 /*
2 $Id: CompilationFailedException.java,v 1.1 2004/04/19 07:29:44 cpoirier 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 */
46
47 package org.codehaus.groovy.control;
48
49 import java.io.PrintWriter;
50 import java.io.StringWriter;
51
52 import org.codehaus.groovy.GroovyException;
53
54
55
56
57 /***
58 * Thrown when compilation fails from source errors.
59 *
60 * @author <a href="mailto:cpoirier@dreaming.org">Chris Poirier</a>
61 *
62 * @version $Id: CompilationFailedException.java,v 1.1 2004/04/19 07:29:44 cpoirier Exp $
63 */
64
65 public class CompilationFailedException extends GroovyException
66 {
67
68 //---------------------------------------------------------------------------
69 // CONSTRUCTION AND SUCH
70
71 protected int phase; // The phase in which the failures occurred
72 protected ProcessingUnit unit; // The *Unit object this exception wraps
73
74
75 /***
76 * Initializes the exception with the phase and ProcessingUnit.
77 */
78
79 public CompilationFailedException( int phase, ProcessingUnit unit )
80 {
81 super( Phases.getDescription(phase) + " failed" );
82 this.phase = phase;
83 this.unit = unit;
84 }
85
86
87 /***
88 * Formats the error data as a String.
89 */
90
91 public String toString()
92 {
93 StringWriter data = new StringWriter();
94 PrintWriter writer = new PrintWriter(data);
95 Janitor janitor = new Janitor();
96
97 try
98 {
99 unit.write( writer, janitor );
100 }
101 finally
102 {
103 janitor.cleanup();
104 }
105
106 return data.toString();
107 }
108
109
110
111 /***
112 * Returns the ProcessingUnit in which the error occurred.
113 */
114
115 public ProcessingUnit getUnit()
116 {
117 return this.unit;
118 }
119
120 }
121
122
123
124