added h4 (====) gheader template
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / ui / IWorkingCopyManagerExtension.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package net.sourceforge.phpdt.ui;
13
14 import org.eclipse.ui.IEditorInput;
15
16 import net.sourceforge.phpdt.core.ICompilationUnit;
17
18 /**
19  * Extension interface for <code>IWorkingCopyManager</code>.
20  * @since 2.1
21  */
22 public interface IWorkingCopyManagerExtension {
23         
24         /**
25          * Sets the given working copy for the given editor input. If the given editor input
26          * is not connected to this working copy manager, this call has no effect. <p>
27          * This working copy manager does not assume the ownership of this working copy, i.e.,
28          * the given working copy is not automatically be freed when this manager is shut down.
29          * 
30          * @param input the editor input
31          * @param workingCopy the working copy
32          */
33         void setWorkingCopy(IEditorInput input, ICompilationUnit workingCopy);
34         
35         /**
36          * Removes the working copy set for the given editor input. If there is no
37          * working copy set for this input or this input is not connected to this
38          * working copy manager, this call has no effect.
39          * 
40          * @param input the editor input
41          */
42         void removeWorkingCopy(IEditorInput input);
43 }