Attachment 33271 Details for Bug 119603 – 119603.diff.txt

[patch] 119603.diff.txt

119603.diff.txt (text/plain), 12.53 KB, created by Tom Hofmann

on 2006-01-19 11:25:21 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Tom Hofmann

Created: 2006-01-19 11:25:21 EST

Size: 12.53 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.jdt.ui
>Index: ui/org/eclipse/jdt/ui/text/java/AbstractProposalFilter.java
>===================================================================
>RCS file: ui/org/eclipse/jdt/ui/text/java/AbstractProposalFilter.java
>diff -N ui/org/eclipse/jdt/ui/text/java/AbstractProposalFilter.java
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ ui/org/eclipse/jdt/ui/text/java/AbstractProposalFilter.java	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,67 @@
>+/*******************************************************************************
>+ * Copyright (c) 2006 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.jdt.ui.text.java;
>+
>+import org.eclipse.core.runtime.IConfigurationElement;
>+
>+import org.eclipse.jface.text.contentassist.ICompletionProposal;
>+
>+/**
>+ * Abstract base class for filters contributed to the
>+ * <code>org.eclipse.jdt.ui.javaCompletionProposalFilters</code> extension point.
>+ * 
>+ * Subclasses need to implement {@link #filter(ICompletionProposal)} and may override
>+ * {@link #beginFiltering(ContentAssistInvocationContext) beginFiltering} and
>+ * {@link #endFiltering() endFiltering}.
>+ * 
>+ * 
>+ * @since 3.2
>+ */
>+public abstract class AbstractProposalFilter {
>+	
>+	/**
>+	 * Creates a new filter. Note that subclasses must provide a zero-argument constructor to be
>+	 * instantiatable via {@link IConfigurationElement#createExecutableExtension(String)}.
>+	 */
>+	protected AbstractProposalFilter() {
>+	}
>+
>+	/**
>+	 * Called once before the content assist session.
>+	 * 
>+	 * Clients may override, the default implementation does nothing.
>+	 * 
>+	 * 
>+	 * @param context the context of the content assist invocation
>+	 */
>+	public void beginFiltering(ContentAssistInvocationContext context) {
>+	}
>+	
>+	/**
>+	 * Called once after the content assist session.
>+	 * 
>+	 * Clients may override, the default implementation does nothing.
>+	 * 
>+	 */
>+	public void endFiltering() {
>+	}
>+	
>+	/**
>+	 * Returns <code>true</code> if a proposal is filtered, i.e. should not be displayed,
>+	 * <code>false</code> if it passes the filter.
>+	 * 
>+	 * @param proposal the proposal to be filtered
>+	 * @return <code>true</code> to filter (remove) <code>proposal</code>, <code>false</code>
>+	 * to let it pass
>+	 */
>+	public abstract boolean filter(ICompletionProposal proposal);
>+
>+}
>Index: ui/org/eclipse/jdt/ui/text/java/AbstractProposalSorter.java
>===================================================================
>RCS file: ui/org/eclipse/jdt/ui/text/java/AbstractProposalSorter.java
>diff -N ui/org/eclipse/jdt/ui/text/java/AbstractProposalSorter.java
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ ui/org/eclipse/jdt/ui/text/java/AbstractProposalSorter.java	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,82 @@
>+/*******************************************************************************
>+ * Copyright (c) 2006 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.jdt.ui.text.java;
>+
>+import java.util.Comparator;
>+
>+import org.eclipse.core.runtime.IConfigurationElement;
>+
>+import org.eclipse.jface.text.contentassist.ICompletionProposal;
>+
>+/**
>+ * Abstract base class for sorters contributed to the
>+ * <code>org.eclipse.jdt.ui.javaCompletionProposalFilters</code> extension point.
>+ * 
>+ * Subclasses need to implement {@link #compare(ICompletionProposal, ICompletionProposal)} and may
>+ * override {@link #beginSorting(ContentAssistInvocationContext) beginSorting} and
>+ * {@link #endSorting() endSorting}.
>+ * 
>+ * 
>+ * @since 3.2
>+ */
>+public abstract class AbstractProposalSorter implements Comparator {
>+	
>+	/**
>+	 * Creates a new sorter. Note that subclasses must provide a zero-argument constructor to be
>+	 * instantiatable via {@link IConfigurationElement#createExecutableExtension(String)}.
>+	 */
>+	protected AbstractProposalSorter() {
>+	}
>+
>+	/**
>+	 * This method may be removed if the class is ever converted to extend
>+	 * <code>Comparator&lt;ICompletionProposal&gt;</code>.
>+	 * 
>+	 * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
>+	 */
>+	public final int compare(Object o1, Object o2) {
>+		ICompletionProposal p1= (ICompletionProposal) o1;
>+		ICompletionProposal p2= (ICompletionProposal) o2;
>+		
>+		return compare(p1, p2);
>+	}
>+	
>+	/**
>+	 * Called once before the content assist session.
>+	 * 
>+	 * Clients may override, the default implementation does nothing.
>+	 * 
>+	 * 
>+	 * @param context the context of the content assist invocation
>+	 */
>+	public void beginSorting(ContentAssistInvocationContext context) {
>+	}
>+	
>+	/**
>+	 * Called once after the content assist session.
>+	 * 
>+	 * Clients may override, the default implementation does nothing.
>+	 * 
>+	 */
>+	public void endSorting() {
>+	}
>+	
>+	/**
>+	 * Implements the same contract as {@link Comparator#compare(Object, Object)} but with
>+	 * completion proposals as parameters.
>+	 * 
>+	 * @param p1 the first proposal to be compared
>+	 * @param p2 the second proposal to be compared
>+	 * @return a negative integer, zero, or a positive integer as the first argument is less than,
>+	 * equal to, or greater than the second.
>+	 */
>+	public abstract int compare(ICompletionProposal p1, ICompletionProposal p2);
>+}
>Index: schema/javaCompletionProposalFilters.exsd
>===================================================================
>RCS file: schema/javaCompletionProposalFilters.exsd
>diff -N schema/javaCompletionProposalFilters.exsd
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ schema/javaCompletionProposalFilters.exsd	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,187 @@
>+<?xml version='1.0' encoding='UTF-8'?>
>+
>+<schema targetNamespace="org.eclipse.jdt.ui">
>+<annotation>
>+ <appInfo>
>+ <meta.schema plugin="org.eclipse.jdt.ui" id="javaCompletionProposalFilters" name="Java Completion Proposal Filters and Sorters"/>
>+ </appInfo>
>+ <documentation>
>+ This extension point allows to contribute sorters and filters that may modify the completion proposals displayed in the Java editor.
>+&lt;p&gt;XXX this API is provisional and may change anytime during the course of 3.2&lt;/p&gt;
>+ </documentation>
>+ </annotation>
>+
>+ <element name="extension">
>+ <annotation>
>+ <appInfo>
>+ <meta.element labelAttribute="name"/>
>+ </appInfo>
>+ </annotation>
>+ <complexType>
>+ <choice>
>+ <element ref="proposalSorter"/>
>+ <element ref="proposalFilter"/>
>+ </choice>
>+ <attribute name="point" type="string" use="required">
>+ <annotation>
>+ <documentation>
>+ The fully qualified identifier of the target extension point.
>+ </documentation>
>+ </annotation>
>+ </attribute>
>+ <attribute name="id" type="string">
>+ <annotation>
>+ <documentation>
>+ The identifier of the extension instance, unique within the declaring plug-in (the plug-in&apos;s identifier will be prepended to form a platform-wide unique id).
>+ </documentation>
>+ </annotation>
>+ </attribute>
>+ <attribute name="name" type="string">
>+ <annotation>
>+ <documentation>
>+ The optional name of the extension instance.
>+ </documentation>
>+ <appInfo>
>+ <meta.attribute translatable="true"/>
>+ </appInfo>
>+ </annotation>
>+ </attribute>
>+ </complexType>
>+ </element>
>+
>+ <element name="proposalSorter">
>+ <annotation>
>+ <appInfo>
>+ <meta.element labelAttribute="name"/>
>+ </appInfo>
>+ <documentation>
>+ A proposal sorter contribution.
>+ </documentation>
>+ </annotation>
>+ <complexType>
>+ <attribute name="id" type="string" use="required">
>+ <annotation>
>+ <documentation>
>+ The unique identifier of the sorter.
>+ </documentation>
>+ </annotation>
>+ </attribute>
>+ <attribute name="name" type="string">
>+ <annotation>
>+ <documentation>
>+ The name of the sorter.
>+ </documentation>
>+ <appInfo>
>+ <meta.attribute translatable="true"/>
>+ </appInfo>
>+ </annotation>
>+ </attribute>
>+ <attribute name="class" type="string" use="required">
>+ <annotation>
>+ <documentation>
>+ The name of the class that implements the contributed sorter. The
>+class must be a public implementation of
>+&lt;samp&gt;java.util.Comparator&lt;/samp&gt;
>+and must have a public 0-argument constructor.
>+&lt;p&gt;
>+The sorter&apos;s &lt;tt&gt;compare(Object, Object)&lt;/tt&gt; method will only be called with instances of &lt;code&gt;org.eclipse.jface.text.contentassist.ICompletionProposal&lt;/code&gt;.
>+&lt;/p&gt;
>+ </documentation>
>+ <appInfo>
>+ <meta.attribute kind="java"/>
>+ </appInfo>
>+ </annotation>
>+ </attribute>
>+ </complexType>
>+ </element>
>+
>+ <element name="proposalFilter">
>+ <annotation>
>+ <appInfo>
>+ <meta.element labelAttribute="name"/>
>+ </appInfo>
>+ <documentation>
>+ A proposal filter contribution.
>+ </documentation>
>+ </annotation>
>+ <complexType>
>+ <attribute name="id" type="string" use="required">
>+ <annotation>
>+ <documentation>
>+ The unique identifier of the filter.
>+ </documentation>
>+ </annotation>
>+ </attribute>
>+ <attribute name="name" type="string">
>+ <annotation>
>+ <documentation>
>+ The name of the filter.
>+ </documentation>
>+ <appInfo>
>+ <meta.attribute translatable="true"/>
>+ </appInfo>
>+ </annotation>
>+ </attribute>
>+ <attribute name="class" type="string" use="required">
>+ <annotation>
>+ <documentation>
>+ The name of the class that implements the contributed sorter. The
>+class must be a public implementation of
>+&lt;samp&gt;java.util.Comparator&lt;/samp&gt;
>+and must have a public 0-argument constructor.
>+ </documentation>
>+ <appInfo>
>+ <meta.attribute kind="java"/>
>+ </appInfo>
>+ </annotation>
>+ </attribute>
>+ </complexType>
>+ </element>
>+
>+ <annotation>
>+ <appInfo>
>+ <meta.section type="since"/>
>+ </appInfo>
>+ <documentation>
>+ 3.2
>+ </documentation>
>+ </annotation>
>+
>+ <annotation>
>+ <appInfo>
>+ <meta.section type="examples"/>
>+ </appInfo>
>+ <documentation>
>+ 
>+ </documentation>
>+ </annotation>
>+
>+ <annotation>
>+ <appInfo>
>+ <meta.section type="apiInfo"/>
>+ </appInfo>
>+ <documentation>
>+ [Enter API information here.]
>+ </documentation>
>+ </annotation>
>+
>+ <annotation>
>+ <appInfo>
>+ <meta.section type="implementation"/>
>+ </appInfo>
>+ <documentation>
>+ [Enter information about supplied implementation of this extension point.]
>+ </documentation>
>+ </annotation>
>+
>+ <annotation>
>+ <appInfo>
>+ <meta.section type="copyright"/>
>+ </appInfo>
>+ <documentation>
>+ Copyright (c) 2006 IBM Corporation and others.&lt;br&gt;
>+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 &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
>+ </documentation>
>+ </annotation>
>+
>+</schema>

Actions: View | Diff

Attachments on bug 119603: 33271