org.gradle.foundation.output

Class FileLinkDefinitionLord

java.lang.Object

org.gradle.foundation.output.FileLinkDefinitionLord

public class FileLinkDefinitionLord
extends Object

This class holds on FileLinkDefinitions used for searching output.

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
FileLinkDefinitionLord()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileExtension(String extension, String lineNumberDelimiter) Call this to add file extensions to look for in the output.
void	addPrefixedFileLink(String name, String prefix, String extension, String lineNumberDelimiter) Creates a file link definition to find file paths in the output that have a known prefix and extension.
List<String>	getFileExtensions()
List<FileLinkDefinition>	getFileLinkDefinitions()
FileLinkDefinition	getMatchingFileLinkDefinition(String text) This returns the FileLinkDefinition whose search pattern 'matches' (as in 'finds', not 'equals') the specified text.
Pattern	getSearchPattern()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLinkDefinitionLord

public FileLinkDefinitionLord()

Method Detail

addFileExtension

public void addFileExtension(String extension,
                    String lineNumberDelimiter)

Call this to add file extensions to look for in the output. This assumes the file path is the first thing on the line.

Parameters:

extension - the file extension

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.

addPrefixedFileLink

public void addPrefixedFileLink(String name,
                       String prefix,
                       String extension,
                       String lineNumberDelimiter)

Creates a file link definition to find file paths in the output that have a known prefix and extension. It also allows for an optional line number after a delimiter. This is useful if you know a certain message always precedes a file path.

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.

getFileExtensions

public List<String> getFileExtensions()

Returns:

a list of known file extensions that are searched for in the output.

getFileLinkDefinitions

public List<FileLinkDefinition> getFileLinkDefinitions()

Returns:

a list of our FileLinkDefinitions

getMatchingFileLinkDefinition

public FileLinkDefinition getMatchingFileLinkDefinition(String text)

This returns the FileLinkDefinition whose search pattern 'matches' (as in 'finds', not 'equals') the specified text. The tricky thing here is that multiple FileLinkDefinitions can match the text. To assist this we've done two things: we first try to match it with the complex patterns (the ones that try to match prefixed and suffixed text around a file's path), then if we don't find one, we'll match it with a simple extension FileLinkDefinitions. The other thing is that we search the definitions in order. This means the order in which the FileLinkDefinitions are added can be important. Add the more definitive ones first.

Parameters:

text - the text to use to find a match.

Returns:

a FileLinkDefinition that matches the text

getSearchPattern

public Pattern getSearchPattern()