org.apache.maven.plugin.eclipse.writers.EclipseClasspathWriter 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
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.
package org.apache.maven.plugin.eclipse.writers;
/*
* Copyright 2001-2005 The Apache Software Foundation.
*
* Licensed 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.
*/
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.eclipse.EclipseSourceDir;
import org.apache.maven.plugin.eclipse.Messages;
import org.apache.maven.plugin.ide.IdeDependency;
import org.apache.maven.plugin.ide.IdeUtils;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
import org.codehaus.plexus.util.xml.XMLWriter;
/**
* Writes eclipse .classpath file.
*
* @author Trygve Laugstøl
* @author Kenney Westerhof
* @author Fabrizio Giustina
* @version $Id: EclipseClasspathWriter.java 391954 2006-04-06 10:21:29Z fgiust $
*/
public class EclipseClasspathWriter
extends AbstractEclipseResourceWriter
{
/**
* Eclipse build path variable M2_REPO
*/
private static final String M2_REPO = "M2_REPO"; //$NON-NLS-1$
private File eclipseProjectDir;
/**
* Attribute for sourcepath.
*/
private static final String ATTR_SOURCEPATH = "sourcepath"; //$NON-NLS-1$
private MavenProject project;
/**
* Attribute for output.
*/
private static final String ATTR_OUTPUT = "output"; //$NON-NLS-1$
/**
* Attribute for path.
*/
private static final String ATTR_PATH = "path"; //$NON-NLS-1$
/**
* Attribute for kind - Container (con), Variable (var)..etc.
*/
private static final String ATTR_KIND = "kind"; //$NON-NLS-1$
/**
* Element for classpathentry.
*/
private static final String ELT_CLASSPATHENTRY = "classpathentry"; //$NON-NLS-1$
/**
* Element for classpath.
*/
private static final String ELT_CLASSPATH = "classpath"; //$NON-NLS-1$
/**
* File name that stores project classpath settings.
*/
private static final String FILE_DOT_CLASSPATH = ".classpath"; //$NON-NLS-1$
public EclipseClasspathWriter( Log log, File eclipseProjectDir, MavenProject project, IdeDependency[] deps )
{
super( log, eclipseProjectDir, project, deps );
}
public void write( File projectBaseDir, EclipseSourceDir[] sourceDirs, List classpathContainers,
ArtifactRepository localRepository, File buildOutputDirectory )
throws MojoExecutionException
{
FileWriter w;
try
{
w = new FileWriter( new File( getEclipseProjectDirectory(), FILE_DOT_CLASSPATH ) );
}
catch ( IOException ex )
{
throw new MojoExecutionException( Messages.getString( "EclipsePlugin.erroropeningfile" ), ex ); //$NON-NLS-1$
}
XMLWriter writer = new PrettyPrintXMLWriter( w );
writer.startElement( ELT_CLASSPATH );
String defaultOutput = IdeUtils.toRelativeAndFixSeparator( projectBaseDir, buildOutputDirectory, false );
// ----------------------------------------------------------------------
// Source roots and resources
// ----------------------------------------------------------------------
for ( int j = 0; j < sourceDirs.length; j++ )
{
EclipseSourceDir dir = sourceDirs[j];
writer.startElement( ELT_CLASSPATHENTRY );
writer.addAttribute( ATTR_KIND, "src" ); //$NON-NLS-1$
writer.addAttribute( ATTR_PATH, dir.getPath() );
if ( dir.getOutput() != null && !defaultOutput.equals( dir.getOutput() ) )
{
writer.addAttribute( ATTR_OUTPUT, dir.getOutput() );
}
writer.endElement();
}
// ----------------------------------------------------------------------
// The default output
// ----------------------------------------------------------------------
writer.startElement( ELT_CLASSPATHENTRY );
writer.addAttribute( ATTR_KIND, ATTR_OUTPUT );
writer.addAttribute( ATTR_PATH, defaultOutput );
writer.endElement();
// ----------------------------------------------------------------------
// Container classpath entries
// ----------------------------------------------------------------------
for ( Iterator it = classpathContainers.iterator(); it.hasNext(); )
{
writer.startElement( ELT_CLASSPATHENTRY );
writer.addAttribute( ATTR_KIND, "con" ); //$NON-NLS-1$
writer.addAttribute( ATTR_PATH, (String) it.next() );
writer.endElement(); // name
}
// ----------------------------------------------------------------------
// The dependencies
// ----------------------------------------------------------------------
for ( int j = 0; j < deps.length; j++ )
{
IdeDependency dep = deps[j];
if ( dep.isAddedToClasspath() )
{
addDependency( writer, dep, localRepository );
}
}
writer.endElement();
IOUtil.close( w );
}
private void addDependency( XMLWriter writer, IdeDependency dep, ArtifactRepository localRepository )
throws MojoExecutionException
{
String path;
String kind;
String sourcepath = null;
String javadocpath = null;
if ( dep.isReferencedProject() )
{
path = "/" + dep.getArtifactId(); //$NON-NLS-1$
kind = "src"; //$NON-NLS-1$
}
else
{
File artifactPath = dep.getFile();
if ( artifactPath == null )
{
getLog().error( Messages.getString( "EclipsePlugin.artifactpathisnull", dep.getId() ) ); //$NON-NLS-1$
return;
}
if ( dep.isSystemScoped() )
{
path = IdeUtils.toRelativeAndFixSeparator( getEclipseProjectDirectory(), artifactPath, false );
if ( getLog().isDebugEnabled() )
{
getLog().debug( Messages.getString( "EclipsePlugin.artifactissystemscoped", //$NON-NLS-1$
new Object[] { dep.getArtifactId(), path } ) );
}
kind = "lib"; //$NON-NLS-1$
}
else
{
File localRepositoryFile = new File( localRepository.getBasedir() );
String fullPath = artifactPath.getPath();
path = "M2_REPO/" //$NON-NLS-1$
+ IdeUtils.toRelativeAndFixSeparator( localRepositoryFile, new File( fullPath ), false );
if ( dep.getSourceAttachment() != null )
{
sourcepath = "M2_REPO/" //$NON-NLS-1$
+ IdeUtils.toRelativeAndFixSeparator( localRepositoryFile, dep.getSourceAttachment(), false );
}
if ( dep.getJavadocAttachment() != null )
{
// NB eclipse (3.1) doesn't support variables in javadoc paths, so we need to add the
// full path for the maven repo
javadocpath = StringUtils.replace( IdeUtils.getCanonicalPath( dep.getJavadocAttachment() ),
"\\", "/" ); //$NON-NLS-1$ //$NON-NLS-2$
}
kind = "var"; //$NON-NLS-1$
}
}
writer.startElement( "classpathentry" ); //$NON-NLS-1$
writer.addAttribute( "kind", kind ); //$NON-NLS-1$
writer.addAttribute( "path", path ); //$NON-NLS-1$
if ( sourcepath != null )
{
writer.addAttribute( "sourcepath", sourcepath ); //$NON-NLS-1$
}
else if ( javadocpath != null )
{
writer.startElement( "attributes" ); //$NON-NLS-1$
writer.startElement( "attribute" ); //$NON-NLS-1$
writer.addAttribute( "value", "jar:file:/" + javadocpath + "!/" ); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
writer.addAttribute( "name", "javadoc_location" ); //$NON-NLS-1$ //$NON-NLS-2$
writer.endElement();
writer.endElement();
}
writer.endElement();
}
}