/*
* Copyright (c) 2011, the Dart project authors.
*
* Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.html
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.dart.tools.ui.text.dart;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
/**
* A completion proposal with a relevance value. The relevance value is used to sort the completion
* proposals. Proposals with higher relevance should be listed before proposals with lower
* relevance.
* <p>
* This interface can be implemented by clients.
* </p>
*
* @see org.eclipse.jface.text.contentassist.ICompletionProposal Provisional API: This
* class/interface is part of an interim API that is still under development and expected to
* change significantly before reaching stability. It is being made available at this early
* stage to solicit feedback from pioneering adopters on the understanding that any code that
* uses this API will almost certainly be broken (repeatedly) as the API evolves.
*/
public interface IDartCompletionProposal extends ICompletionProposal {
/**
* Returns the relevance of this completion proposal.
* <p>
* The relevance is used to determine if this proposal is more relevant than another proposal.
* </p>
*
* @return the relevance of this completion proposal in the range of [0, 100] where a lower number
* is more relevant than a higher number
*/
int getRelevance();
}