Attachment 60979 Details for Bug 168077 – New proposed patch

[patch] New proposed patch

v03.txt (text/plain), 16.84 KB, created by Frederic Fusier

on 2007-03-15 12:53:46 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Frederic Fusier

Created: 2007-03-15 12:53:46 EDT

Size: 16.84 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.jdt.core
>Index: model/org/eclipse/jdt/core/ClasspathContainerInitializer.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ClasspathContainerInitializer.java,v
>retrieving revision 1.34
>diff -u -r1.34 ClasspathContainerInitializer.java
>--- model/org/eclipse/jdt/core/ClasspathContainerInitializer.java	30 Oct 2006 20:23:37 -0000	1.34
>+++ model/org/eclipse/jdt/core/ClasspathContainerInitializer.java	15 Mar 2007 16:52:31 -0000
>@@ -17,8 +17,8 @@
> *******************************************************************************/
> package org.eclipse.jdt.core;
> 
>-import org.eclipse.core.runtime.CoreException;
>-import org.eclipse.core.runtime.IPath;
>+import org.eclipse.core.runtime.*;
>+import org.eclipse.jdt.internal.core.JavaModelStatus;
> 
> /**
> * Abstract base implementation of all classpath container initializer.
>@@ -27,22 +27,44 @@
> * 
> * Clients should subclass this class to implement a specific classpath
> * container initializer. The subclass must have a public 0-argument
>- * constructor and a concrete implementation of <code>initialize</code>.
>+ * constructor and a concrete implementation of {@link #initialize(IPath, IJavaProject)}.
> * 
> * Multiple classpath containers can be registered, each of them declares
> * the container ID they can handle, so as to narrow the set of containers they
>- * can resolve, in other words, a container initializer is guaranteed to only be 
>+ * can resolve, in other words, a container initializer is guaranteed to only be
> * activated to resolve containers which match the ID they registered onto.
> * 
> * In case multiple container initializers collide on the same container ID, the first
> * registered one will be invoked.
>- * 
>+ *
> * @see IClasspathEntry
> * @see IClasspathContainer
> * @since 2.0
> */
> public abstract class ClasspathContainerInitializer {
>-	
>+
>+	/**
>+	 * Status code indicating that an attribute is not supported.
>+	 *
>+	 * @see #getAccessRulesStatus(IPath, IJavaProject)
>+	 * @see #getAttributeStatus(IPath, IJavaProject, String)
>+	 * @see #getSourceAttachmentStatus(IPath, IJavaProject)
>+	 *
>+	 * @since 3.3
>+	 */
>+	public static final int ATTRIBUTE_NOT_SUPPORTED= 1;
>+
>+	/**
>+	 * Status code indicating that an attribute is not modifiable.
>+	 *
>+	 * @see #getAccessRulesStatus(IPath, IJavaProject)
>+	 * @see #getAttributeStatus(IPath, IJavaProject, String)
>+	 * @see #getSourceAttachmentStatus(IPath, IJavaProject)
>+	 *
>+	 * @since 3.3
>+	 */
>+	public static final int ATTRIBUTE_READ_ONLY= 2;
>+
> /**
> * Creates a new classpath container initializer.
> */
>@@ -59,7 +81,7 @@
> * the second segment can be used as an additional hint when performing the resolution.
> * 
> * The initializer is invoked if a container path needs to be resolved for a given project, and no
>- * value for it was recorded so far. The implementation of the initializer would typically set the 
>+ * value for it was recorded so far. The implementation of the initializer would typically set the
> * corresponding container using <code>JavaCore#setClasspathContainer</code>.
> * 
> * A container initialization can be indirectly performed while attempting to resolve a project
>@@ -69,10 +91,10 @@
> * infinite regression of initializations.
> * 
> * A container initialization may also occur indirectly when setting a project classpath, as the operation
>- * needs to resolve the classpath for validation purpose. While the operation is in progress, a referenced 
>- * container initializer may be invoked. If the initializer further tries to access the referring project classpath, 
>- * it will not see the new assigned classpath until the operation has completed. Note that once the Java 
>- * change notification occurs (at the end of the operation), the model has been updated, and the project 
>+ * needs to resolve the classpath for validation purpose. While the operation is in progress, a referenced
>+ * container initializer may be invoked. If the initializer further tries to access the referring project classpath,
>+ * it will not see the new assigned classpath until the operation has completed. Note that once the Java
>+ * change notification occurs (at the end of the operation), the model has been updated, and the project
> * classpath can be queried normally.
> 	 * 
> 	 * This method is called by the Java model to give the party that defined
>@@ -96,23 +118,23 @@
> 	 * </ul>
> 	 * The effects of using other Java model APIs are unspecified.
> 	 * 
>-	 * 
>- * @param containerPath a two-segment path (ID/hint) identifying the container that needs 
>+	 *
>+ * @param containerPath a two-segment path (ID/hint) identifying the container that needs
> * 	to be resolved
> * @param project the Java project in which context the container is to be resolved.
> * This allows generic containers to be bound with project specific values.
> * @throws CoreException if an exception occurs during the initialization
>- * 
>+ *
> * @see JavaCore#getClasspathContainer(IPath, IJavaProject)
> * @see JavaCore#setClasspathContainer(IPath, IJavaProject[], IClasspathContainer[], org.eclipse.core.runtime.IProgressMonitor)
> * @see IClasspathContainer
> */
> public abstract void initialize(IPath containerPath, IJavaProject project) throws CoreException;
>- 
>+
> /**
>- * Returns <code>true</code> if this container initializer can be requested to perform updates 
>+ * Returns <code>true</code> if this container initializer can be requested to perform updates
> * on its own container values. If so, then an update request will be performed using
>- * <code>ClasspathContainerInitializer#requestClasspathContainerUpdate</code>/
>+ * {@link #requestClasspathContainerUpdate(IPath, IJavaProject, IClasspathContainer)}.
> * 
> * @param containerPath the path of the container which requires to be updated
> * @param project the project for which the container is to be updated
>@@ -120,24 +142,24 @@
> * @since 2.1
> */
> public boolean canUpdateClasspathContainer(IPath containerPath, IJavaProject project) {
>- 	
>+
> 		// By default, classpath container initializers do not accept updating containers
>- 	return false; 
>+ 	return false;
> }
> 
> 	/**
>-	 * Request a registered container definition to be updated according to a container suggestion. The container suggestion 
>-	 * only acts as a place-holder to pass along the information to update the matching container definition(s) held by the 
>-	 * container initializer. In particular, it is not expected to store the container suggestion as is, but rather adjust 
>+	 * Request a registered container definition to be updated according to a container suggestion. The container suggestion
>+	 * only acts as a place-holder to pass along the information to update the matching container definition(s) held by the
>+	 * container initializer. In particular, it is not expected to store the container suggestion as is, but rather adjust
> 	 * the actual container definition based on suggested changes.
> 	 * 
> 	 * IMPORTANT: In reaction to receiving an update request, a container initializer will update the corresponding
>-	 * container definition (after reconciling changes) at its earliest convenience, using 
>-	 * <code>JavaCore#setClasspathContainer(IPath, IJavaProject[], IClasspathContainer[], IProgressMonitor)</code>. 
>+	 * container definition (after reconciling changes) at its earliest convenience, using
>+	 * {@link JavaCore#setClasspathContainer(IPath, IJavaProject[], IClasspathContainer[], IProgressMonitor)}.
> 	 * Until it does so, the update will not be reflected in the Java Model.
> 	 * 
> 	 * In order to anticipate whether the container initializer allows to update its containers, the predicate
>-	 * <code>JavaCore#canUpdateClasspathContainer</code> should be used.
>+	 * {@link #canUpdateClasspathContainer(IPath, IJavaProject)} should be used.
> 	 * 
> 	 * @param containerPath the path of the container which requires to be updated
> * @param project the project for which the container is to be updated
>@@ -147,6 +169,7 @@
> 	 * @see ClasspathContainerInitializer#canUpdateClasspathContainer(IPath, IJavaProject)
> 	 * @since 2.1
> 	 */
>+
> public void requestClasspathContainerUpdate(IPath containerPath, IJavaProject project, IClasspathContainer containerSuggestion) throws CoreException {
> 
> 		// By default, classpath container initializers do not accept updating containers
>@@ -155,23 +178,23 @@
> 	/**
> 	 * Returns a readable description for a container path. A readable description for a container path can be
> 	 * used for improving the display of references to container, without actually needing to resolve them.
>-	 * A good implementation should answer a description consistent with the description of the associated 
>-	 * target container (see <code>IClasspathContainer.getDescription()</code>).
>-	 * 
>+	 * A good implementation should answer a description consistent with the description of the associated
>+	 * target container (see {@link IClasspathContainer#getDescription()}).
>+	 *
> 	 * @param containerPath the path of the container which requires a readable description
> 	 * @param project the project from which the container is referenced
> 	 * @return a string description of the container
> 	 * @since 2.1
>-	 */ 
>+	 */
> public String getDescription(IPath containerPath, IJavaProject project) {
>- 	
>+
> 	// By default, a container path is the only available description
> 	return containerPath.makeRelative().toString();
> }
>- 
>+
> /**
>- * Returns a classpath container that is used after this initializer failed to bind a classpath container 
>- * to a <code>IClasspathContainer</code> for the given project. A non-<code>null</code>
>+ * Returns a classpath container that is used after this initializer failed to bind a classpath container
>+ * to a {@link IClasspathContainer} for the given project. A non-<code>null</code>
> * failure container indicates that there will be no more request to initialize the given container
> * for the given project.
> * 
>@@ -179,7 +202,7 @@
> * Clients wishing to get a chance to run the initializer again should override this method
> * and return <code>null</code>.
> * 
>- * 
>+ *
> 	 * @param containerPath the path of the container which failed to initialize
> 	 * @param project the project from which the container is referenced
> 	 * @return the default failure container, or <code>null</code> if wishing to run the initializer again
>@@ -187,32 +210,32 @@
> */
> public IClasspathContainer getFailureContainer(final IPath containerPath, IJavaProject project) {
> 	final String description = getDescription(containerPath, project);
>- 	return 
>+ 	return
> 		new IClasspathContainer() {
>-				public IClasspathEntry[] getClasspathEntries() { 
>-					return new IClasspathEntry[0]; 
>+				public IClasspathEntry[] getClasspathEntries() {
>+					return new IClasspathEntry[0];
> 				}
>-				public String getDescription() { 
>+				public String getDescription() {
> 					return description;
> 				}
>-				public int getKind() { 
>-					return 0; 
>+				public int getKind() {
>+					return 0;
> 				}
>-				public IPath getPath() { 
>-					return containerPath; 
>+				public IPath getPath() {
>+					return containerPath;
> 				}
>-				public String toString() { 
>-					return getDescription(); 
>+				public String toString() {
>+					return getDescription();
> 				}
> 			};
> 	}
> 
> 	/**
> 	 * Returns an object which identifies a container for comparison purpose. This allows
>-	 * to eliminate redundant containers when accumulating classpath entries (e.g. 
>+	 * to eliminate redundant containers when accumulating classpath entries (e.g.
> 	 * runtime classpath computation). When requesting a container comparison ID, one
> 	 * should ensure using its corresponding container initializer. Indeed, a random container
>-	 * initializer cannot be held responsible for determining comparison IDs for arbitrary 
>+	 * initializer cannot be held responsible for determining comparison IDs for arbitrary
> 	 * containers.
> 	 * 
> 	 * @param containerPath the path of the container which is being checked
>@@ -230,5 +253,114 @@
> 			return containerPath.segment(0);
> 		}
> 	}
>+
>+	/**
>+	 * Returns the access rules attribute status according to this initializer.
>+	 * 
>+	 * The returned {@link IStatus status} can have one of the following severities:
>+	 * <ul>
>+	 * <li>{@link IStatus#OK OK}: means that the attribute is supported
>+	 * 	and is modifiable</li>
>+	 * <li>{@link IStatus#ERROR ERROR}: means that either the attribute
>+	 * 	is not supported or is not modifiable. 
>+	 * 	In this case, the {@link IStatus#getCode() code}will have
>+	 * 	respectively the {@link #ATTRIBUTE_NOT_SUPPORTED} value
>+	 * 	or the {@link #ATTRIBUTE_READ_ONLY} value.</li>
>+	 * </ul>
>+	 * 
>+	 * The status message can contain more information.
>+	 * 
>+	 * If the subclass does not override this method, then the default behavior is
>+	 * to return {@link IStatus#OK OK} if and only if the classpath container can
>+	 * be updated (see {@link #canUpdateClasspathContainer(IPath, IJavaProject)}).
>+	 * 
>+	 *
>+	 * @param containerPath the path of the container which requires to be
>+	 * 	updated
>+	 * @param project the project for which the container is to be updated
>+	 * @return returns the source attachment attirbute status
>+	 *
>+	 * @since 3.3
>+	 */
>+	public IStatus getAccessRulesStatus(IPath containerPath, IJavaProject project) {
>+
>+		if (canUpdateClasspathContainer(containerPath, project)) {
>+			return Status.OK_STATUS;
>+		}
>+		return new JavaModelStatus(ATTRIBUTE_READ_ONLY);
>+	}
>+
>+	/**
>+	 * Returns an extra attribute status according to this initializer.
>+	 * 
>+	 * The returned {@link IStatus status} can have one of the following severities:
>+	 * <ul>
>+	 * <li>{@link IStatus#OK OK}: means that the attribute is supported
>+	 * 	and is modifiable</li>
>+	 * <li>{@link IStatus#ERROR ERROR}: means that either the attribute
>+	 * 	is not supported or is not modifiable. 
>+	 * 	In this case, the {@link IStatus#getCode() code}will have
>+	 * 	respectively the {@link #ATTRIBUTE_NOT_SUPPORTED} value
>+	 * 	or the {@link #ATTRIBUTE_READ_ONLY} value.</li>
>+	 * </ul>
>+	 * 
>+	 * The status message can contain more information.
>+	 * 
>+	 * If the subclass does not override this method, then the default behavior is
>+	 * to return {@link IStatus#OK OK} if and only if the classpath container can
>+	 * be updated (see {@link #canUpdateClasspathContainer(IPath, IJavaProject)}).
>+	 * 
>+	 *
>+	 * @param containerPath the path of the container which requires to be
>+	 * 	updated
>+	 * @param project the project for which the container is to be updated
>+	 * @param attributeKey the key of the extra attribute
>+	 * @return returns the source attachment attirbute status
>+	 *
>+	 * @since 3.3
>+	 */
>+	public IStatus getAttributeStatus(IPath containerPath, IJavaProject project, String attributeKey) {
>+
>+		if (canUpdateClasspathContainer(containerPath, project)) {
>+			return Status.OK_STATUS;
>+		}
>+		return new JavaModelStatus(ATTRIBUTE_READ_ONLY);
>+	}
>+
>+	/**
>+	 * Returns the source attachment attribute status according to this initializer.
>+	 * 
>+	 * The returned {@link IStatus status} can have one of the following severities:
>+	 * <ul>
>+	 * <li>{@link IStatus#OK OK}: means that the attribute is supported
>+	 * 	and is modifiable</li>
>+	 * <li>{@link IStatus#ERROR ERROR}: means that either the attribute
>+	 * 	is not supported or is not modifiable. 
>+	 * 	In this case, the {@link IStatus#getCode() code}will have
>+	 * 	respectively the {@link #ATTRIBUTE_NOT_SUPPORTED} value
>+	 * 	or the {@link #ATTRIBUTE_READ_ONLY} value.</li>
>+	 * </ul>
>+	 * 
>+	 * The status message can contain more information.
>+	 * 
>+	 * If the subclass does not override this method, then the default behavior is
>+	 * to return {@link IStatus#OK OK} if and only if the classpath container can
>+	 * be updated (see {@link #canUpdateClasspathContainer(IPath, IJavaProject)}).
>+	 * 
>+	 *
>+	 * @param containerPath the path of the container which requires to be
>+	 * 	updated
>+	 * @param project the project for which the container is to be updated
>+	 * @return returns the source attachment attirbute status
>+	 *
>+	 * @since 3.3
>+	 */
>+	public IStatus getSourceAttachmentStatus(IPath containerPath, IJavaProject project) {
>+
>+		if (canUpdateClasspathContainer(containerPath, project)) {
>+			return Status.OK_STATUS;
>+		}
>+		return new JavaModelStatus(ATTRIBUTE_READ_ONLY);
>+	}
> }
>

Actions: View | Diff

Attachments on bug 168077: 59665 | 60315 | 60773 | 60979