com.facebook.buck.parser.api

Interface FileParser<T extends FileManifest>

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

PackageFileParser, ProjectBuildFileParser

All Known Implementing Classes:

ConcurrentProjectBuildFileParser, EventReportingProjectBuildFileParser, ForwardingProjectBuildFileParserDecorator, HybridProjectBuildFileParser, PythonDslProjectBuildFileParser, SkylarkPackageFileParser, SkylarkProjectBuildFileParser, TargetCountVerificationParserDecorator

public interface FileParser<T extends FileManifest>
extends AutoCloseable

Generic file parser, meant to be extended for more specific parsers.

Method Summary

Modifier and Type	Method and Description
void	close()
com.google.common.collect.ImmutableSortedSet<String>	getIncludedFiles(Path parseFile) Collects the loaded files and extensions when parsing the parseFile build spec.
T	getManifest(Path parseFile) Collect all information from a particular, along with metadata about the information, for example which other files were also parsed.

Method Detail

getManifest

T getManifest(Path parseFile)
       throws BuildFileParseException,
              InterruptedException,
              IOException

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

Parameters:

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

Throws:

BuildFileParseException

InterruptedException

IOException

getIncludedFiles

com.google.common.collect.ImmutableSortedSet<String> getIncludedFiles(Path parseFile)
                                                               throws BuildFileParseException,
                                                                      InterruptedException,
                                                                      IOException

Collects the loaded files and extensions when parsing the parseFile build spec.

Parameters:

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

Throws:

BuildFileParseException

InterruptedException

IOException

close

void close()
    throws BuildFileParseException,
           InterruptedException,
           IOException

Specified by:

close in interface AutoCloseable

Throws:

BuildFileParseException

InterruptedException

IOException