KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tools > ant > taskdefs > compilers > CompilerAdapter


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18
19 package org.apache.tools.ant.taskdefs.compilers;
20
21 import org.apache.tools.ant.BuildException;
22 import org.apache.tools.ant.taskdefs.Javac;
23
24 /**
25  * The interface that all compiler adapters must adhere to.
26  *
27  * <p>A compiler adapter is an adapter that interprets the javac's
28  * parameters in preparation to be passed off to the compiler this
29  * adapter represents. As all the necessary values are stored in the
30  * Javac task itself, the only thing all adapters need is the javac
31  * task, the execute command and a parameterless constructor (for
32  * reflection).</p>
33  *
34  * @since Ant 1.3
35  */
36
37 public interface CompilerAdapter {
38
39     /**
40      * Sets the compiler attributes, which are stored in the Javac task.
41      * @param attributes the compiler attributes
42      */
43     void setJavac(Javac attributes);
44
45     /**
46      * Executes the task.
47      *
48      * @return has the compilation been successful
49      * @throws BuildException on error
50      */
51     boolean execute() throws BuildException;
52 }
53
Popular Tags