Interface IOccurrencesFinder
- All Known Implementing Classes:
AtlOccurrencesFinder
public interface IOccurrencesFinder
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Element representing a occurrence -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
-
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the element to look for ornull
if the finder hasn't been initialized yet.getID()
Returns the id of this finder.Returns the occurrencesint
Returns the plural label for this finder with 3 placeholders: {0} for theelement name
{1} for the number of results found {2} for the scope (name of the compilation unit)Returns the singular label for this finder with 2 placeholders: {0} for theelement name
{1} for the scope (name of the compilation unit)
-
Field Details
-
K_OCCURRENCE
static final int K_OCCURRENCE- See Also:
-
K_EXCEPTION_OCCURRENCE
static final int K_EXCEPTION_OCCURRENCE- See Also:
-
K_EXIT_POINT_OCCURRENCE
static final int K_EXIT_POINT_OCCURRENCE- See Also:
-
K_IMPLEMENTS_OCCURRENCE
static final int K_IMPLEMENTS_OCCURRENCE- See Also:
-
K_BREAK_TARGET_OCCURRENCE
static final int K_BREAK_TARGET_OCCURRENCE- See Also:
-
F_WRITE_OCCURRENCE
static final int F_WRITE_OCCURRENCE- See Also:
-
F_READ_OCCURRENCE
static final int F_READ_OCCURRENCE- See Also:
-
F_EXCEPTION_DECLARATION
static final int F_EXCEPTION_DECLARATION- See Also:
-
-
Method Details
-
getJobLabel
String getJobLabel() -
getUnformattedPluralLabel
String getUnformattedPluralLabel()Returns the plural label for this finder with 3 placeholders:- {0} for the
element name
- {1} for the number of results found
- {2} for the scope (name of the compilation unit)
- Returns:
- the unformatted label
- {0} for the
-
getUnformattedSingularLabel
String getUnformattedSingularLabel()Returns the singular label for this finder with 2 placeholders:- {0} for the
element name
- {1} for the scope (name of the compilation unit)
- Returns:
- the unformatted label
- {0} for the
-
getElementName
String getElementName()Returns the name of the element to look for ornull
if the finder hasn't been initialized yet.- Returns:
- the name of the element
-
getOccurrences
IOccurrencesFinder.OccurrenceLocation[] getOccurrences()Returns the occurrences- Returns:
- the occurrences
-
getSearchKind
int getSearchKind() -
getID
String getID()Returns the id of this finder.- Returns:
- returns the id of this finder.
-