1. /*

  2.  * Copyright  2001-2004 The Apache Software Foundation

  3.  *

  4.  *  Licensed under the Apache License, Version 2.0 (the "License");

  5.  *  you may not use this file except in compliance with the License.

  6.  *  You may obtain a copy of the License at

  7.  *

  8.  *      http://www.apache.org/licenses/LICENSE-2.0

  9.  *

  10.  *  Unless required by applicable law or agreed to in writing, software

  11.  *  distributed under the License is distributed on an "AS IS" BASIS,

  12.  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  13.  *  See the License for the specific language governing permissions and

  14.  *  limitations under the License.

  15.  *

  16.  */

  17. 

  18. package org.apache.tools.ant.taskdefs.compilers;

  19. 

  20. import org.apache.tools.ant.BuildException;

  21. import org.apache.tools.ant.taskdefs.Javac;

  22. 

  23. /**

  24.  * The interface that all compiler adapters must adhere to.

  25.  *

  26.  * <p>A compiler adapter is an adapter that interprets the javac's

  27.  * parameters in preparation to be passed off to the compiler this

  28.  * adapter represents.  As all the necessary values are stored in the

  29.  * Javac task itself, the only thing all adapters need is the javac

  30.  * task, the execute command and a parameterless constructor (for

  31.  * reflection).</p>

  32.  *

  33.  * @since Ant 1.3

  34.  */

  35. 

  36. public interface CompilerAdapter {

  37. 

  38.     /**

  39.      * Sets the compiler attributes, which are stored in the Javac task.

  40.      */

  41.     void setJavac(Javac attributes);

  42. 

  43.     /**

  44.      * Executes the task.

  45.      *

  46.      * @return has the compilation been successful

  47.      */

  48.     boolean execute() throws BuildException;

  49. }