org.apache.maven.plugin.eclipse.writers.EclipseAntExternalLaunchConfigurationWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-eclipse-plugin Show documentation

The Eclipse Plugin is used to generate Eclipse IDE files (.project, .classpath and the .settings folder) from a POM.

The newest version!

/*
 * 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.maven.plugin.eclipse.writers;

import java.util.List;

import org.apache.maven.plugin.logging.Log;
import org.codehaus.plexus.util.xml.XMLWriter;

/**
 * Writes an external ant launch file.
 * 
 * @author Kenney Westerhof
 */
public class EclipseAntExternalLaunchConfigurationWriter
    extends EclipseLaunchConfigurationWriter
{
    private String buildfilePath;

    /**
     * @param launcherName Name of the launch file, for instance 'AntBuilder.launch'
     * @param buildfilePath Project relative path to the ant build file, for instance 'eclipse-build.xml'
     * @return this
     */
    public EclipseWriter init( Log log, EclipseWriterConfig config, String launcherName, String buildfilePath )
    {
        this.buildfilePath = buildfilePath;
        return super.init( log, config, launcherName );
    }

    protected void addAttributes( XMLWriter writer )
    {
        // ant specific
        writeAttribute( writer, "process_factory_id", "org.eclipse.ant.ui.remoteAntProcessFactory" );

        writeAttribute( writer, "org.eclipse.ant.ui.DEFAULT_VM_INSTALL", false );

        writeAttribute( writer, "org.eclipse.debug.ui.ATTR_CONSOLE_OUTPUT_ON", false );

        writeAttribute( writer, "org.eclipse.ant.ui.ATTR_TARGETS_UPDATED", true );

        writeAttribute( writer, "org.eclipse.jdt.launching.CLASSPATH_PROVIDER",
                        "org.eclipse.ant.ui.AntClasspathProvider" );

        writeAttribute( writer, "org.eclipse.debug.core.MAPPED_RESOURCE_TYPES", new String[] { "1" } );

        writeAttribute( writer, "org.eclipse.debug.core.MAPPED_RESOURCE_PATHS", new String[] { "/"
            + config.getEclipseProjectName() + "/" + buildfilePath } );
    }

    protected String getLaunchConfigurationType()
    {
        return "org.eclipse.ant.AntBuilderLaunchConfigurationType";
    }

    protected String getBuilderLocation()
    {
        return "${build_project}/" + buildfilePath;
    }

    protected List getMonitoredResources()
    {
        // TODO: return a list of MonitoredResources that encapsulate
        // the resource locations - includes/excludes aren't supported
        // so we need to just add the directories.
        return super.getMonitoredResources();
    }
}