com.facebook.buck.parser.api

Class BuildFileManifest

java.lang.Object

com.facebook.buck.parser.api.BuildFileManifest

All Implemented Interfaces:

ComputeResult, FileManifest

public abstract class BuildFileManifest
extends Object
implements ComputeResult, FileManifest

Describes the content of a build file, which includes defined targets and their metadata.

Constructor Summary

Constructors

Constructor and Description
BuildFileManifest()

Method Summary

Modifier and Type	Method and Description
abstract com.google.common.collect.ImmutableMap<String,Object>	getConfigs()
abstract Optional<com.google.common.collect.ImmutableMap<String,Optional<String>>>	getEnv()
abstract com.google.common.collect.ImmutableList<ParsingError>	getErrors()
abstract com.google.common.collect.ImmutableList<GlobSpecWithResult>	getGlobManifest()
abstract com.google.common.collect.ImmutableSortedSet<String>	getIncludes()
abstract com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Object>>	getTargets()
static BuildFileManifest	of(com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Object>> targets, com.google.common.collect.ImmutableSortedSet<String> includes, com.google.common.collect.ImmutableMap<String,Object> configs, Optional<com.google.common.collect.ImmutableMap<String,Optional<String>>> env, com.google.common.collect.ImmutableList<GlobSpecWithResult> globManifest, com.google.common.collect.ImmutableList<ParsingError> errors)

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildFileManifest

public BuildFileManifest()

Method Detail

getTargets

public abstract com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Object>> getTargets()

Returns:

a list of targets defined in the build file.

getIncludes

public abstract com.google.common.collect.ImmutableSortedSet<String> getIncludes()

Specified by:

getIncludes in interface FileManifest

Returns:

a set of extension files read during parsing.

getConfigs

public abstract com.google.common.collect.ImmutableMap<String,Object> getConfigs()

Specified by:

getConfigs in interface FileManifest

Returns:

a map from configuration section to configuration key to the value returned during parsing.

getEnv

public abstract Optional<com.google.common.collect.ImmutableMap<String,Optional<String>>> getEnv()

Specified by:

getEnv in interface FileManifest

Returns:

an optional map from environment variable to a value read during parsing (if any).

getGlobManifest

public abstract com.google.common.collect.ImmutableList<GlobSpecWithResult> getGlobManifest()

Returns:

A list of the glob operations performed with their results.

getErrors

public abstract com.google.common.collect.ImmutableList<ParsingError> getErrors()

Specified by:

getErrors in interface FileManifest

Returns:

A list of fatal errors occurred during parsing a file, i.e. errors that might render manifest incomplete. It is up for the parser to decide if still wants to fill this object with unaffected targets

of

public static BuildFileManifest of(com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,Object>> targets,
                                   com.google.common.collect.ImmutableSortedSet<String> includes,
                                   com.google.common.collect.ImmutableMap<String,Object> configs,
                                   Optional<com.google.common.collect.ImmutableMap<String,Optional<String>>> env,
                                   com.google.common.collect.ImmutableList<GlobSpecWithResult> globManifest,
                                   com.google.common.collect.ImmutableList<ParsingError> errors)