Project: ant4eclipse
/**********************************************************************
 * Copyright (c) 2005-2009 ant4eclipse project team. 
 * 
 * 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 
 * 
 * Contributors: 
 *     Nils Hartmann, Daniel Kasmeroglu, Gerd Wuetherich 
 **********************************************************************/
package org.ant4eclipse.lib.platform.model.resource.role; 
 
import org.ant4eclipse.lib.platform.model.resource.EclipseProject; 
 
/**
 * <p> 
 * The {@link ProjectRoleIdentifier} defines the common interface for project role identifiers. A project role 
 * identifier can be used to assign a specific role to an eclipse project when the project is reed from the underlying 
 * workspace. 
 * </p> 
 *  
 * @author Daniel Kasmeroglu ([email protected]
 */
 
public interface ProjectRoleIdentifier { 
 
  /**
   * <p> 
   * Returns <code>true</code> if the supplied project provides support for a specific role. 
   * </p> 
   *  
   * @param project 
   *          the eclipse project that should be tested. 
   *  
   * @return <code>true</code> if the role is applicable for the eclipse project. 
   */
 
  boolean isRoleSupported(EclipseProject project); 
 
  /**
   * <p> 
   * Creates the specific {@link ProjectRole} for the given {@link EclipseProject}. During the parsing process you must 
   * be aware that accessing other EclipseProject instances through the workspace is prohibited since that project 
   * itself might not have been created yet. 
   * </p> 
   *  
   * @param project 
   *          the eclipse project. 
   */
 
  ProjectRole createRole(EclipseProject project); 
 
  /**
   * This function will be invoked after each project within a workspace has been setup. Therefore each action that 
   * requires to access other projects within the workspace can be implemented here. 
   *  
   * @param project 
   *          The project which role has to be modified if necessary. Not <code>null</code>. 
   */
 
  void postProcess(EclipseProject project); 
 
/* ENDINTERFACE */