org.eclipse.ocl.helper

Interface Choice

public interface Choice

Description of a syntax completion choice. A choice is characterized by a kind (indicating the type of model construct that it represents), a name, and a description (which is useful for constructing text for a content-assist window). The choice also can provide the actual model element that it represents, in case the client knows how to interpret it.

Note that this interface is not intended to be implemented by clients.

Author:

Christian W. Damus (cdamus)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Obtains my description, suitable for display in a UI tool tip or pop-up help window.
java.lang.Object	getElement() Obtains the model element (property, operation, type, etc.) that is the choice in question.
ChoiceKind	getKind() Queries the kind of syntax completion suggestion that I am.
java.lang.String	getName() Obtains my name, suitable for display in a UI list.

Method Detail

getKind

ChoiceKind getKind()

Queries the kind of syntax completion suggestion that I am.

Returns:

my type

getName

java.lang.String getName()

Obtains my name, suitable for display in a UI list.

Returns:

my name

getDescription

java.lang.String getDescription()

Obtains my description, suitable for display in a UI tool tip or pop-up help window.

Returns:

my description

getElement

java.lang.Object getElement()

Obtains the model element (property, operation, type, etc.) that is the choice in question.

Returns:

the element that I represent