core/plugins/org.eclipse.dltk.ui/src/org/eclipse/dltk/ui/text/completion/IScriptCompletionProposalFactory.java

/*******************************************************************************
 * Copyright (c) 2011 NumberFour AG
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     NumberFour AG - initial API and Implementation (Alex Panchenko)
 *******************************************************************************/
package org.eclipse.dltk.ui.text.completion;

import org.eclipse.dltk.annotations.ExtensionPoint;
import org.eclipse.dltk.core.CompletionProposal;
import org.eclipse.dltk.internal.ui.text.completion.ScriptCompletionProposalFactoryRegistry;

/**
 * Interface to plug-in factories for converting {@link CompletionProposal}
 * generated by the {@link org.eclipse.dltk.codeassist.ICompletionEngine} to
 * {@link IScriptCompletionProposal} used to display proposals to the user.
 * 
 * @since 3.0
 */
@ExtensionPoint(point = ScriptCompletionProposalFactoryRegistry.EXT_POINT, element = "proposalFactory", attribute = "class")
public interface IScriptCompletionProposalFactory {
	/**
	 * Creates the UI completion proposal or returns <code>null</code> if not
	 * applicable
	 * 
	 * @param collector
	 * @param proposal
	 * @return
	 */
	IScriptCompletionProposal create(
			ScriptCompletionProposalCollector collector,
			CompletionProposal proposal);
}