View Javadoc

1   /*
2    $Id: Compiler.java,v 1.25 2005/06/09 19:51:59 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   */
46  
47  package org.codehaus.groovy.tools;
48  
49  import java.io.File;
50  
51  import org.codehaus.groovy.control.CompilationFailedException;
52  import org.codehaus.groovy.control.CompilationUnit;
53  import org.codehaus.groovy.control.CompilerConfiguration;
54  import org.codehaus.groovy.control.SourceUnit;
55  
56  
57  
58  
59  /***
60   *  A convenience front end for getting standard compilations done.
61   *  All compile() routines generate classes to the filesystem.
62   *
63   *  @author <a href="mailto:cpoirier@dreaming.org">Chris Poirier</a>
64   *
65   *  @version $Id: Compiler.java,v 1.25 2005/06/09 19:51:59 blackdrag Exp $
66   */
67  
68  public class Compiler
69  {
70      public static Compiler DEFAULT = new Compiler();
71      
72      private CompilerConfiguration configuration = null;  // Optional configuration data
73      
74     /***
75      *  Initializes the Compiler with default configuration.
76      */
77      
78      public Compiler()
79      {
80          configuration = null;
81      }
82      
83      
84     /***
85      *  Initializes the Compiler with the specified configuration.
86      */
87      
88      public Compiler( CompilerConfiguration configuration )
89      {
90          this.configuration = configuration;
91      }
92  
93      
94     
95     /***
96      *  Compiles a single File.
97      */
98     
99      public void compile( File file ) throws CompilationFailedException
100     {
101         CompilationUnit unit = new CompilationUnit( configuration );
102         unit.addSource( file );
103         unit.compile();
104     }
105     
106     
107     
108    /***
109     *  Compiles a series of Files.
110     */
111     
112     public void compile( File[] files ) throws CompilationFailedException
113     {
114         CompilationUnit unit = new CompilationUnit( configuration );
115         unit.addSources( files );
116         unit.compile();
117     }
118 
119     
120     
121    /***
122     *  Compiles a series of Files from file names.
123     */
124     
125     public void compile( String[] files ) throws CompilationFailedException
126     {
127         CompilationUnit unit = new CompilationUnit( configuration );
128         unit.addSources( files );
129         unit.compile();
130     }
131 
132     
133     
134    /***
135     *  Compiles a string of code.
136     */
137     
138     public void compile( String name, String code ) throws CompilationFailedException
139     {
140         CompilationUnit unit = new CompilationUnit( configuration );
141         unit.addSource( new SourceUnit(name, code, configuration, unit.getClassLoader(), unit.getErrorCollector()) );
142         unit.compile();
143     }
144 
145 }
146 
147 
148 
149