org.eclipse.jdt.core
Class CompletionContext

java.lang.Object
  org.eclipse.jdt.internal.codeassist.InternalCompletionContext
      org.eclipse.jdt.core.CompletionContext

public final class CompletionContext

extends org.eclipse.jdt.internal.codeassist.InternalCompletionContext

Completion context. Represent the context in which the completion occurs.

Since:

3.1

See Also:

CompletionRequestor.acceptContext(CompletionContext)

Field Summary

Fields inherited from class org.eclipse.jdt.internal.codeassist.InternalCompletionContext

expectedTypesKeys, expectedTypesSignatures, javadoc

Constructor Summary

CompletionContext()

Method Summary

char[][]	getExpectedTypesKeys() Return keys of expected types of a potential completion proposal at the completion position.
char[][]	getExpectedTypesSignatures() Return signatures of expected types of a potential completion proposal at the completion position.
boolean	isInJavadoc() Tell user whether completion takes place in a javadoc comment or not.
boolean	isInJavadocFormalReference() Tell user whether completion takes place in a formal reference of a javadoc tag or not.
boolean	isInJavadocText() Tell user whether completion takes place in text area of a javadoc comment or not.

Methods inherited from class org.eclipse.jdt.internal.codeassist.InternalCompletionContext

setExpectedTypesKeys, setExpectedTypesSignatures, setJavadoc

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompletionContext

public CompletionContext()

Method Detail

isInJavadoc

public boolean isInJavadoc()

Tell user whether completion takes place in a javadoc comment or not.

Returns:

boolean true if completion takes place in a javadoc comment, false otherwise.

Since:

3.2

isInJavadocText

public boolean isInJavadocText()

Tell user whether completion takes place in text area of a javadoc comment or not.

Returns:

boolean true if completion takes place in a text area of a javadoc comment, false otherwise.

Since:

3.2

isInJavadocFormalReference

public boolean isInJavadocFormalReference()

Tell user whether completion takes place in a formal reference of a javadoc tag or not. Tags with formal reference are:

• @see
• @throws
• @exception
• {@link Object}
• {@linkplain Object}
• {@value} when compiler compliance is set at leats to 1.5

Returns:

boolean true if completion takes place in formal reference of a javadoc tag, false otherwise.

Since:

3.2

getExpectedTypesSignatures

public char[][] getExpectedTypesSignatures()

Return signatures of expected types of a potential completion proposal at the completion position. It's not mandatory to a completion proposal to respect this expectation.

Returns:

signatures expected types of a potential completion proposal at the completion position or null if there is no expected types.

See Also:

Signature

getExpectedTypesKeys

public char[][] getExpectedTypesKeys()

Return keys of expected types of a potential completion proposal at the completion position. It's not mandatory to a completion proposal to respect this expectation.

Returns:

keys of expected types of a potential completion proposal at the completion position or null if there is no expected types.

See Also:

ASTParser.createASTs(ICompilationUnit[], String[], org.eclipse.jdt.core.dom.ASTRequestor, org.eclipse.core.runtime.IProgressMonitor)