Committing the first phase of the phpDocBuilder.
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / ui / IWorkingCopyProvider.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 package net.sourceforge.phpdt.ui;
12
13 /**
14  * Interface used for Java element content providers to indicate that the
15  * content provider can return working copy elements for members below
16  * compilation units.
17  * 
18  * <p>
19  * This interface is not intended to be implemented by clients.
20  * </p>
21  * 
22  * @see net.sourceforge.phpdt.ui.StandardJavaElementContentProvider
23  * @see net.sourceforge.phpdt.core.IWorkingCopy
24  * 
25  * @since 2.0
26  */
27 public interface IWorkingCopyProvider {
28
29         /**
30          * Returns <code>true</code> if the content provider returns working copy
31          * elements; otherwise <code>false</code> is returned.
32          * 
33          * @return whether working copy elements are provided.
34          */
35         public boolean providesWorkingCopies();
36 }