com.facebook.buck.parser

Interface FileParsePipeline<T extends FileManifest>

Type Parameters:

T - The type of node this pipeline will produce (raw nodes, target nodes, etc)

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BuildFileRawNodeParsePipeline, GenericFileParsePipeline, PackageFileParsePipeline

public interface FileParsePipeline<T extends FileManifest>
extends AutoCloseable

Abstract node parsing pipeline. Allows implementors to define their own logic for creating nodes of type T.

Method Summary

Modifier and Type	Method and Description
default T	getFile(Cell cell, AbsPath buildFile) Obtain all TargetNodes from a build file.
com.google.common.util.concurrent.ListenableFuture<T>	getFileJob(Cell cell, AbsPath buildFile) Asynchronously obtain all TargetNodes from a build file.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getFile

default T getFile(Cell cell,
                  AbsPath buildFile)
           throws BuildFileParseException

Obtain all TargetNodes from a build file. This may block if the file is not cached.

Parameters:

cell - the Cell that the build file belongs to.

buildFile - absolute path to the file to process.

Returns:

all targets from the file

Throws:

BuildFileParseException - for syntax errors.

getFileJob

com.google.common.util.concurrent.ListenableFuture<T> getFileJob(Cell cell,
                                                                 AbsPath buildFile)
                                                          throws BuildTargetException

Asynchronously obtain all TargetNodes from a build file. This will leverage previously cached raw contents of the file (if present) but will always loop over the contents, so repeated calls (with the same args) are not free.

returned future may throw BuildFileParseException and HumanReadableException.

Parameters:

cell - the Cell that the build file belongs to.

buildFile - absolute path to the file to process.

Returns:

future.

Throws:

BuildTargetException