rdt/org.eclipse.ptp.rdt.core/src/org/eclipse/ptp/internal/rdt/core/model/IModelBuilderService.java

/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * 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:
 *    IBM Corporation - Initial API and implementation
 *******************************************************************************/ 

package org.eclipse.ptp.internal.rdt.core.model;

import org.eclipse.cdt.core.model.ITranslationUnit;
import org.eclipse.cdt.core.model.IWorkingCopy;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;

/**
 * Provides services to build a CModel.
 * 
 * <strong>EXPERIMENTAL</strong>. This class or interface has been added as
 * part of a work in progress. There is no guarantee that this API will work or
 * that it will remain the same. Please do not use this API without consulting
 * with the RDT team.
 * 
 * @author vkong
 */
public interface IModelBuilderService {
	/**
	 * Builds a CModel of the given working copy.
	 * @param workingCopy
	 * @param monitor
	 * @return model of the given working copy.
	 * @throws CoreException
	 */
	ITranslationUnit getModel(IWorkingCopy workingCopy, IProgressMonitor monitor) throws CoreException;
}