/******************************************************************************* * Copyright (c) 2000, 2001, 2002 International Business Machines Corp. and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Common Public License v0.5 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/cpl-v05.html * * Contributors: * IBM Corporation - initial API and implementation ******************************************************************************/ package net.sourceforge.phpdt.core; /** * Common protocol for Java elements that support source code assist and code * resolve. *
* This interface is not intended to be implemented by clients. *
*/ public interface ICodeAssist { /** * Performs code completion at the given offset position in this compilation unit, * reporting results to the given completion requestor. Theoffset
* is the 0-based index of the character, after which code assist is desired.
* An offset
of -1 indicates to code assist at the beginning of this
* compilation unit.
*
* @param offset the given offset position
* @param requestor the given completion requestor
* @exception JavaModelException if code assist could not be performed. Reasons include:requestor
is null
* @since 2.0
* */
void codeComplete(int offset, ICompletionRequestor requestor)
throws JavaModelException;
/**
* Performs code selection on the given selected text in this compilation unit,
* reporting results to the given selection requestor. The offset
* is the 0-based index of the first selected character. The length
* is the number of selected characters.
*
* @param offset the given offset position
* @param length the number of selected characters
*
* @exception JavaModelException if code resolve could not be performed. Reasons include:
* offset
* is the 0-based index of the character, after which code assist is desired.
* An offset
of -1 indicates to code assist at the beginning of this
* compilation unit.
*
* @param offset the given offset position
* @param requestor the given completion requestor
*
* @exception JavaModelException if code assist could not be performed. Reasons include:requestor
is null
* @deprecated - use codeComplete(int, ICompletionRequestor) instead
*/
// void codeComplete(int offset, ICodeCompletionRequestor requestor)
// throws JavaModelException;
}