Interface IOccurrencesFinder
-
- All Known Implementing Classes:
AtlOccurrencesFinder
public interface IOccurrencesFinder
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIOccurrencesFinder.OccurrenceLocationElement representing a occurrence
-
Field Summary
Fields Modifier and Type Field Description static intF_EXCEPTION_DECLARATIONstatic intF_READ_OCCURRENCEstatic intF_WRITE_OCCURRENCEstatic intK_BREAK_TARGET_OCCURRENCEstatic intK_EXCEPTION_OCCURRENCEstatic intK_EXIT_POINT_OCCURRENCEstatic intK_IMPLEMENTS_OCCURRENCEstatic intK_OCCURRENCE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetElementName()Returns the name of the element to look for ornullif the finder hasn't been initialized yet.java.lang.StringgetID()Returns the id of this finder.java.lang.StringgetJobLabel()IOccurrencesFinder.OccurrenceLocation[]getOccurrences()Returns the occurrencesintgetSearchKind()java.lang.StringgetUnformattedPluralLabel()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)java.lang.StringgetUnformattedSingularLabel()Returns the singular label for this finder with 2 placeholders: {0} for theelement name{1} for the scope (name of the compilation unit)
-
-
-
Field Detail
-
K_OCCURRENCE
static final int K_OCCURRENCE
- See Also:
- Constant Field Values
-
K_EXCEPTION_OCCURRENCE
static final int K_EXCEPTION_OCCURRENCE
- See Also:
- Constant Field Values
-
K_EXIT_POINT_OCCURRENCE
static final int K_EXIT_POINT_OCCURRENCE
- See Also:
- Constant Field Values
-
K_IMPLEMENTS_OCCURRENCE
static final int K_IMPLEMENTS_OCCURRENCE
- See Also:
- Constant Field Values
-
K_BREAK_TARGET_OCCURRENCE
static final int K_BREAK_TARGET_OCCURRENCE
- See Also:
- Constant Field Values
-
F_WRITE_OCCURRENCE
static final int F_WRITE_OCCURRENCE
- See Also:
- Constant Field Values
-
F_READ_OCCURRENCE
static final int F_READ_OCCURRENCE
- See Also:
- Constant Field Values
-
F_EXCEPTION_DECLARATION
static final int F_EXCEPTION_DECLARATION
- See Also:
- Constant Field Values
-
-
Method Detail
-
getJobLabel
java.lang.String getJobLabel()
-
getUnformattedPluralLabel
java.lang.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
java.lang.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
java.lang.String getElementName()
Returns the name of the element to look for ornullif 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
java.lang.String getID()
Returns the id of this finder.- Returns:
- returns the id of this finder.
-
-