org.gradle.foundation.output.definitions

Class PrefixedFileLinkDefinition

java.lang.Object

org.gradle.foundation.output.definitions.PrefixedFileLinkDefinition

All Implemented Interfaces:

FileLinkDefinition

Direct Known Subclasses:

OptionalLineNumberFileLinkDefinition

public class PrefixedFileLinkDefinition
extends java.lang.Object
implements FileLinkDefinition

This is a basic FileLinkDefinition that uses a prefix, file extension to identify files. This also allows you to specify an optional line number delimiter. This will handle files where the error always has a specific prefix ([ant:javac]) and always has a known extension (.java). It also handles a delimiter after the path to specify a line number (the delimiter cannot be before the path). Here's a sample line output from an ant compile error: [ant:javac] /home/someguy/path/etc/etc.java:186: cannot find symbol Here's a sample line output from gradle when it encounters an exception: Build file '/home/someguy/path/etc/etc/build.gradle'

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
PrefixedFileLinkDefinition(java.lang.String name, java.lang.String prefix, java.lang.String extension)
PrefixedFileLinkDefinition(java.lang.String name, java.lang.String prefix, java.lang.String extension, java.lang.String lineNumberDelimiter)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	generateLineNumberExpression(java.lang.String lineNumberDelimiter)
static java.lang.String	getConsecutiveNumbers(java.lang.String text) This returns the first grouping of consecutive numbers.
static int	getLineNumber(java.lang.String textAfterPath, java.lang.String lineNumberDelimiter)
java.lang.String	getName()
java.lang.String	getSearchExpression()
int	parseFileLink(java.lang.String fullSearchTest, java.lang.String matchedText, int start, int end, boolean verifyFileExists, java.util.List<FileLink> fileLinks) This is called for each match.
static java.lang.String	quoteLiteral(java.lang.String literal)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PrefixedFileLinkDefinition

public PrefixedFileLinkDefinition(java.lang.String name,
                          java.lang.String prefix,
                          java.lang.String extension)

PrefixedFileLinkDefinition

public PrefixedFileLinkDefinition(java.lang.String name,
                          java.lang.String prefix,
                          java.lang.String extension,
                          java.lang.String lineNumberDelimiter)

Parameters:

name - the name of this file link definition. Used by tests mostly.

prefix - the text that is before the file path. It should be enough to make it fairly unique

extension - the expected file extension. If we don't find this extension, we do not consider the text a file's path. If there are multiple extensions, you'll have to add multiples of these.

lineNumberDelimiter - optional delimiter text for line number. Whatever is after this will be assumed to be a line number. We'll only parse the numbers after this so there can be other stuff after the line number. Pass in null to ignore.

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface FileLinkDefinition

Returns:

a name that really only useful for debugging

generateLineNumberExpression

protected java.lang.String generateLineNumberExpression(java.lang.String lineNumberDelimiter)

quoteLiteral

public static java.lang.String quoteLiteral(java.lang.String literal)

getSearchExpression

public java.lang.String getSearchExpression()

Specified by:

getSearchExpression in interface FileLinkDefinition

Returns:

the regular expression used to find a potential FileLink

parseFileLink

public int parseFileLink(java.lang.String fullSearchTest,
                java.lang.String matchedText,
                int start,
                int end,
                boolean verifyFileExists,
                java.util.List<FileLink> fileLinks)

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

Specified by:

parseFileLink in interface FileLinkDefinition

Parameters:

fullSearchTest - 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

getLineNumber

public static int getLineNumber(java.lang.String textAfterPath,
                java.lang.String lineNumberDelimiter)

getConsecutiveNumbers

public static java.lang.String getConsecutiveNumbers(java.lang.String text)

This returns the first grouping of consecutive numbers. This is used to extract line numbers from a line that may have additional things immediately after the number. This assumes the first character is already a number. If it is not, you'll get a blank string being returned.

Parameters:

text - the text to search

Returns:

a string consisting of only numbers.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object