org.eclipse.jface.text.quickassist.IQuickFixableAnnotation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface.text Show documentation

This is org.eclipse.jface.text jar used by Scout SDK

The newest version!

/*******************************************************************************
 * Copyright (c) 2006, 2008 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.jface.text.quickassist;

import org.eclipse.core.runtime.AssertionFailedException;

import org.eclipse.jface.text.source.Annotation;


/**
 * Allows an annotation to tell whether there are quick fixes
 * for it and to cache that state.
 * 
 * Caching the state is important to improve overall performance as calling
 * {@link org.eclipse.jface.text.quickassist.IQuickAssistAssistant#canFix(Annotation)}
 * can be expensive.
 * 
 * 
 * This interface can be implemented by clients.
 *
 * @since 3.2
 */
public interface IQuickFixableAnnotation {

	/**
	 * Sets whether there are quick fixes available for
	 * this annotation.
	 *
	 * @param state true if there are quick fixes available, false otherwise
	 */
	void setQuickFixable(boolean state);

	/**
	 * Tells whether the quick fixable state has been set.
	 * 
	 * Normally this means {@link #setQuickFixable(boolean)} has been
	 * called at least once but it can also be hard-coded, e.g. always
	 * return true.
	 * 
	 *
	 * @return true if the state has been set
	 */
	boolean isQuickFixableStateSet();

	/**
	 * Tells whether there are quick fixes for this annotation.
	 * 
	 * Note: This method must only be called
	 * if {@link #isQuickFixableStateSet()} returns true.
	 *
	 * @return true if this annotation offers quick fixes
	 * @throws AssertionFailedException if called when {@link #isQuickFixableStateSet()} is false
	 */
	boolean isQuickFixable() throws AssertionFailedException;

}