org.eclipse.m2e.wtp/src/org/eclipse/m2e/wtp/AbstractDependencyConfigurator.java

/*******************************************************************************

 * Copyright (c) 2008 Sonatype, Inc.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/

package org.eclipse.m2e.wtp;


import org.apache.maven.project.MavenProject;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.m2e.core.embedder.MavenRuntimeManager;
import org.eclipse.m2e.core.internal.markers.IMavenMarkerManager;
import org.eclipse.m2e.core.project.IMavenProjectRegistry;

/**
* Base class to configure dependent worskpace projects.
* 
* @provisional This class has been added as part of a work in progress. 
* It is not guaranteed to work or remain the same in future releases. 
* For more information contact <a href="mailto:m2e-wtp-dev@eclipse.org">m2e-wtp-dev@eclipse.org</a>.
* 
* @author Eugene Kuleshov
*/
public abstract class AbstractDependencyConfigurator {

  public static final String ATTR_ID = "id"; //$NON-NLS-1$
  
  public static final String ATTR_PRIORITY = "priority"; //$NON-NLS-1$

  public static final String ATTR_NAME = "name"; //$NON-NLS-1$
  
  public static final String ATTR_CLASS = "class"; //$NON-NLS-1$
  
  private int priority;
  private String id;
  private String name;

  protected IMavenProjectRegistry projectManager;
  protected MavenRuntimeManager runtimeManager;
  protected IMavenMarkerManager markerManager; 
  
  public void setProjectManager(IMavenProjectRegistry projectManager) {
    this.projectManager = projectManager;
  }
  
  public void setRuntimeManager(MavenRuntimeManager runtimeManager) {
    this.runtimeManager = runtimeManager;
  }

  public void setMarkerManager(IMavenMarkerManager markerManager) {
    this.markerManager = markerManager;
  }
  
  public abstract void configureDependency(MavenProject mavenProject, IProject mavenIProject, MavenProject dependencyProject, 
      IProject dependencyIProject, IProgressMonitor monitor) throws MarkedException;

  public void setInitializationData(IConfigurationElement config, String propertyName, Object data) {
    this.id = config.getAttribute(ATTR_ID);
    this.name = config.getAttribute(ATTR_NAME);
    String priorityString = config.getAttribute(ATTR_PRIORITY);
    try {
      priority = Integer.parseInt(priorityString);
    } catch (Exception ex) {
      priority = Integer.MAX_VALUE;
    }
  }

  protected void addNature(IProject project, String natureId, IProgressMonitor monitor) throws CoreException {
    if (!project.hasNature(natureId)) {
      IProjectDescription description = project.getDescription();
      String[] prevNatures = description.getNatureIds();
      String[] newNatures = new String[prevNatures.length + 1];
      System.arraycopy(prevNatures, 0, newNatures, 1, prevNatures.length);
      newNatures[0] = natureId;
      description.setNatureIds(newNatures);
      project.setDescription(description, monitor);
    }
  }

  @Override
  public String toString() {
    return id + ":" + name + "(" + priority + ")";   //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$
  }

  public void init() {
    //do nothing here, extenders may override
  }
  
}