com.facebook.buck.parser.decorators

Class EventReportingProjectBuildFileParser

java.lang.Object

com.facebook.buck.parser.api.ForwardingProjectBuildFileParserDecorator

com.facebook.buck.parser.decorators.EventReportingProjectBuildFileParser

All Implemented Interfaces:

FileParser<BuildFileManifest>, ProjectBuildFileParser, AutoCloseable

public class EventReportingProjectBuildFileParser
extends ForwardingProjectBuildFileParserDecorator

Decorator for ProjectBuildFileParser that is responsible for reporting parse lifecycle events like start and finish.

This decouples status reporting functionality so that it can be used with different underlying ProjectBuildFileParsers.

Field Summary

Fields inherited from class com.facebook.buck.parser.api.ForwardingProjectBuildFileParserDecorator

delegate

Method Summary

Modifier and Type	Method and Description
void	close()
BuildFileManifest	getManifest(Path buildFile) Collect all information from a particular, along with metadata about the information, for example which other files were also parsed.
static EventReportingProjectBuildFileParser	of(ProjectBuildFileParser delegate, BuckEventBus eventBus) Static factory method for producing instances of EventReportingProjectBuildFileParser.

Methods inherited from class com.facebook.buck.parser.api.ForwardingProjectBuildFileParserDecorator

getIncludedFiles, globResultsMatchCurrentState, reportProfile

Methods inherited from class java.lang.Object

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

Method Detail

getManifest

public BuildFileManifest getManifest(Path buildFile)
                              throws BuildFileParseException,
                                     InterruptedException,
                                     IOException

Description copied from interface: FileParser

Collect all information from a particular, along with metadata about the information, for example which other files were also parsed.

Specified by:

getManifest in interface FileParser<BuildFileManifest>

Overrides:

getManifest in class ForwardingProjectBuildFileParserDecorator

Parameters:

buildFile - should be an absolute path to a file. Must have rootPath as its prefix.

Throws:

BuildFileParseException

InterruptedException

IOException

close

public void close()
           throws BuildFileParseException,
                  InterruptedException,
                  IOException

Specified by:

close in interface FileParser<BuildFileManifest>

Specified by:

close in interface AutoCloseable

Overrides:

close in class ForwardingProjectBuildFileParserDecorator

Throws:

BuildFileParseException

InterruptedException

IOException

of

public static EventReportingProjectBuildFileParser of(ProjectBuildFileParser delegate,
                                                      BuckEventBus eventBus)

Static factory method for producing instances of EventReportingProjectBuildFileParser.