org.apache.tools.ant.taskdefs.compilers.CompilerAdapter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.taskdefs.compilers;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.taskdefs.Javac;
/**
* The interface that all compiler adapters must adhere to.
*
* A compiler adapter is an adapter that interprets the javac's
* parameters in preparation to be passed off to the compiler this
* adapter represents. As all the necessary values are stored in the
* Javac task itself, the only thing all adapters need is the javac
* task, the execute command and a parameterless constructor (for
* reflection).
*
* @since Ant 1.3
*/
public interface CompilerAdapter {
/**
* Sets the compiler attributes, which are stored in the Javac task.
* @param attributes the compiler attributes
*/
void setJavac(Javac attributes);
/**
* Executes the task.
*
* @return has the compilation been successful
* @throws BuildException on error
*/
boolean execute() throws BuildException;
}