Package com.intellij.psi.search

Interface IndexPatternOccurrence

public interface IndexPatternOccurrence

Represents the occurrence of an index pattern in the comments of a source code file.

See Also:

IndexPatternSearch, IndexPatternProvider

Method Summary

Modifier and Type	Method and Description
default java.util.List<TextRange>	getAdditionalTextRanges() Additional ranges associated with matched range (e.g.
PsiFile	getFile() Returns the file in which the occurrence was found.
IndexPattern	getPattern() Returns the instance of the pattern which was matched.
TextRange	getTextRange() Returns the text range which was matched by the pattern.

Method Detail

getFile

PsiFile getFile()

Returns the file in which the occurrence was found.

Returns:

the file in which the occurrence was found.

getTextRange

TextRange getTextRange()

Returns the text range which was matched by the pattern.

Returns:

the text range which was matched by the pattern.

getAdditionalTextRanges

default java.util.List<TextRange> getAdditionalTextRanges()

Additional ranges associated with matched range (e.g. for multi-line matching)

getPattern

IndexPattern getPattern()

Returns the instance of the pattern which was matched.

Returns:

the instance of the pattern which was matched.