com.sun.tools.jxc.AptBasedTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxb-xjc Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.tools.jxc;

import java.lang.reflect.Method;

import com.sun.mirror.apt.AnnotationProcessorFactory;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.taskdefs.Javac;
import org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter;
import org.apache.tools.ant.types.Commandline;

/**
 * Base class for tasks that eventually invoke APT.
 *
 * @author Kohsuke Kawaguchi
 */
public abstract class AptBasedTask extends Javac {

    public AptBasedTask() {
        setExecutable("apt");
    }

    /**
     * Implemented by the derived class to set up command line switches passed to Apt.
     */
    protected abstract void setupCommandlineSwitches(Commandline cmd);

    /**
     * Common parts between {@link InternalAptAdapter} and {@link ExternalAptAdapter}.
     */
    private abstract class AptAdapter extends DefaultCompilerAdapter {
        protected AptAdapter() {
            setJavac(AptBasedTask.this);
        }

        protected Commandline setupModernJavacCommandlineSwitches(Commandline cmd) {
            super.setupModernJavacCommandlineSwitches(cmd);
            setupCommandlineSwitches(cmd);
            return cmd;
        }
    }

    /**
     * Adapter to invoke Apt internally.
     */
    private final class InternalAptAdapter extends AptAdapter {
        public boolean execute() throws BuildException {
            Commandline cmd = setupModernJavacCommand();

            try {
                Class apt = Class.forName ("com.sun.tools.apt.Main");
                Method process;
                try {
                    process = apt.getMethod ("process",
                                        new Class [] {AnnotationProcessorFactory.class,String[].class});
                } catch (NoSuchMethodException e) {
                    throw new BuildException("JDK 1.5.0_01 or later is necessary",e, location);
                }

                int result = ((Integer) process.invoke(null,
                        new Object[] {createFactory(),cmd.getArguments()}))
                    .intValue ();
                return result == 0;
            } catch (BuildException e) {
                throw e;
            } catch (Exception ex) {
                throw new BuildException("Error starting apt",ex, location);
            }
        }
    }

    /**
     * Creates a facotry that does the actual job.
     */
    protected abstract AnnotationProcessorFactory createFactory();

//    /**
//     * Adapter to invoke Apt externally.
//     */
//    private final class ExternalAptAdapter extends AptAdapter {
//        public boolean execute() throws BuildException {
//            Commandline cmd = setupModernJavacCommand();
//            return executeExternalCompile(cmd.getArguments(),-1)==0;
//        }
//    }

    protected void compile() {
        if (compileList.length == 0) return;

        log(getCompilationMessage() + compileList.length + " source file"
                + (compileList.length == 1 ? "" : "s"));

        if (listFiles) {
            for (int i = 0; i < compileList.length; i++) {
                String filename = compileList[i].getAbsolutePath();
                log(filename);
            }
        }

        AptAdapter apt;
//        if(isForkedJavac())
//            apt = new ExternalAptAdapter();
//        else
            apt = new InternalAptAdapter();

        // compile
        if (!apt.execute()) {
            if (failOnError) {
                throw new BuildException(getFailedMessage(), getLocation());
            } else {
                log(getFailedMessage(), Project.MSG_ERR);
            }
        }
    }

    protected abstract String getCompilationMessage();
    protected abstract String getFailedMessage();
}