X-Git-Url: http://git.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IWorkingCopy.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IWorkingCopy.java index da5c9d5..72f4a48 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IWorkingCopy.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/IWorkingCopy.java @@ -1,15 +1,13 @@ /******************************************************************************* - * Copyright (c) 2000, 2001, 2002 International Business Machines Corp. and others. + * Copyright (c) 2000, 2003 IBM Corporation and others. * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Common Public License v0.5 + * are made available under the terms of the Common Public License v1.0 * which accompanies this distribution, and is available at - * http://www.eclipse.org/legal/cpl-v05.html + * http://www.eclipse.org/legal/cpl-v10.html * * Contributors: - * IBM Corporation - initial API - * IBM Corporation, 2002/03/01- added notion of shared working copy - * IBM Corporation, 2002/26/01- added notion of IProblemRequestor - ******************************************************************************/ + * IBM Corporation - initial API and implementation + *******************************************************************************/ package net.sourceforge.phpdt.core; import org.eclipse.core.resources.IMarker; @@ -68,13 +66,16 @@ public interface IWorkingCopy { * a subsequent change in the resource *
false
- in this case a JavaModelException
is thrown+ * Since 2.1, a working copy can be created on a not-yet existing compilation + * unit. In particular, such a working copy can then be committed in order to create + * the corresponding compilation unit. + *
* @param force a flag to handle the cases when the contents of the original resource have changed * since this working copy was created * @param monitor the given progress monitor * @exception JavaModelException if this working copy could not commit. Reasons include: *CoreException
occurred while updating an underlying resource
* destroy()
is the same as the number of calls to
* getSharedWorkingCopy(IProgressMonitor, IBufferFactory)
.
- * A REMOVED IJavaElementDelta is then reported on this working copy.
+ * + * When it is destroyed, a REMOVED IJavaElementDelta is reported on this + * working copy. + *
*/ void destroy(); @@ -150,7 +154,7 @@ public interface IWorkingCopy { IJavaElement[] findElements(IJavaElement element); /** - * Finds the primary type of this compilation unit (i.e. the type with the same name as the + * Finds the primary type of this compilation unit (that is, the type with the same name as the * compilation unit), ornull
if no such a type exists.
*
* @return the found primary type of this compilation unit, or null
if no such a type exists
@@ -162,7 +166,7 @@ public interface IWorkingCopy {
* Returns a shared working copy on this element using the given factory to create
* the buffer, or this element if this element is already a working copy.
* This API can only answer an already existing working copy if it is based on the same
- * original compilation unit AND was using the same buffer factory (i.e. as defined by Object#equals
).
+ * original compilation unit AND was using the same buffer factory (that is, as defined by Object.equals
).
* * The life time of a shared working copy is as follows: *
- * Note that the buffer factory will be used for the life time of this working copy, i.e. if the
+ * Note that the buffer factory will be used for the life time of this working copy, that is if the
* working copy is closed then reopened, this factory will be used.
* The buffer will be automatically initialized with the original's compilation unit content
* upon creation.
@@ -190,10 +194,7 @@ public interface IWorkingCopy {
* reconciling as they are discovered. The requestor can be set to null
indicating
* that the client is not interested in problems.
* @exception JavaModelException if the contents of this element can
- * not be determined. Reasons include:
- *
* Note: if intending to share a working copy amongst several clients, then
* #getSharedWorkingCopy
should be used instead.
- *
+ *
+ * When the working copy instance is created, an ADDED IJavaElementDelta is + * reported on this working copy. + *
+ * Since 2.1, a working copy can be created on a not-yet existing compilation + * unit. In particular, such a working copy can then be committed in order to create + * the corresponding compilation unit. + *
* @exception JavaModelException if the contents of this element can - * not be determined. Reasons include: - *
* Note: if intending to share a working copy amongst several clients, then
* #getSharedWorkingCopy
should be used instead.
- *
+ *
+ * When the working copy instance is created, an ADDED IJavaElementDelta is + * reported on this working copy. + *
+ * Since 2.1, a working copy can be created on a not-yet existing compilation + * unit. In particular, such a working copy can then be committed in order to create + * the corresponding compilation unit. + *
* @param monitor a progress monitor used to report progress while opening this compilation unit * ornull
if no progress should be reported
* @param factory the factory that creates a buffer that is used to get the content of the working copy
@@ -242,10 +254,7 @@ public interface IWorkingCopy {
* reconciling as they are discovered. The requestor can be set to null
indicating
* that the client is not interested in problems.
* @exception JavaModelException if the contents of this element can
- * not be determined. Reasons include:
- *