org.gradle.foundation.output

Class LiveOutputParser

java.lang.Object

org.gradle.foundation.output.LiveOutputParser

public class LiveOutputParser
extends Object

This is a special type of OutputParser. It handles tracking live output. The unique thing about live output is that we're not guaranteed to get whole lines. Also, we don't want to parse parts that have already been parsed. This holds onto the output until a newline is reached, then parses it. It also tracks the overall index into the output (even though its only parsing a part of it).

Author:

mhunsicker

Constructor Summary

Constructors

Constructor and Description
LiveOutputParser(FileLinkDefinitionLord fileLinkDefinitionLord, boolean verifyFileExists)

Method Summary

Methods

Modifier and Type	Method and Description
List<FileLink>	appendText(String text)
FileLink	getFileLink(int index) This gets the fileLink at the specified index in the text.
List<FileLink>	getFileLinks()
FileLink	getNextFileLink(int caretLocation) Returns the next file link relative to the caret location.
FileLink	getPreviousFileLink(int caretLocation) Returns the previous file link relative to the caret location.
String	getText()
void	reset() Removes all text and FileLinks.

Methods inherited from class java.lang.Object

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

Constructor Detail

LiveOutputParser

public LiveOutputParser(FileLinkDefinitionLord fileLinkDefinitionLord,
                boolean verifyFileExists)

Method Detail

reset

public void reset()

Removes all text and FileLinks. This is so you can use this on new text

appendText

public List<FileLink> appendText(String text)

getFileLinks

public List<FileLink> getFileLinks()

getFileLink

public FileLink getFileLink(int index)

This gets the fileLink at the specified index in the text.

Parameters:

index - the index into the overall text.

Returns:

a FileLink if one exists at the index. null if not.

getText

public String getText()

getPreviousFileLink

public FileLink getPreviousFileLink(int caretLocation)

Returns the previous file link relative to the caret location. This will cycle around and get the last one if you're before the first link.

getNextFileLink

public FileLink getNextFileLink(int caretLocation)

Returns the next file link relative to the caret location. This will cycle around and get the first one if you're after the last link.