org.gradle.foundation.output.definitions

Interface FileLinkDefinition

All Known Implementing Classes:

ExtensionFileLinkDefinition, OptionalLineNumberFileLinkDefinition, PrefixedFileLinkDefinition, TestReportFileLinkDefinition

public interface FileLinkDefinition

.

Author:

mhunsicker

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
String	getSearchExpression()
int	parseFileLink(String fullSearchText, String matchedText, int start, int end, boolean verifyFileExists, List<FileLink> fileLinks) This is called for each match.

Method Detail

getName

String getName()

Returns:

a name that really only useful for debugging

getSearchExpression

String getSearchExpression()

Returns:

the regular expression used to find a potential FileLink

parseFileLink

int parseFileLink(String fullSearchText,
                String matchedText,
                int start,
                int end,
                boolean verifyFileExists,
                List<FileLink> fileLinks)

This is called for each match. Parse this to turn it into a FileLink.

Parameters:

fullSearchText - the full text that was searched

matchedText - the text that was matched

start - the index into the entire searched text where the matchedText starts

end - the index into the entire searched text where the matchedText ends

Returns:

a FileLink or null if this is a false positive