com.facebook.buck.parser.api

Class PackageFileManifest

java.lang.Object

com.facebook.buck.parser.api.PackageFileManifest

All Implemented Interfaces:

ComputeResult, FileManifest

public abstract class PackageFileManifest
extends Object
implements ComputeResult, FileManifest

Describes the content of a package file, which includes a package definition and their metadata.

Field Summary

Fields

Modifier and Type	Field and Description
static PackageFileManifest	EMPTY_SINGLETON A singleton instance of a manifest with an empty package metadata.

Constructor Summary

Constructors

Constructor and Description
PackageFileManifest()

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.ImmutableSortedSet<String>	getIncludes()
abstract PackageMetadata	getPackage() Contains the package defined in the build file.
static PackageFileManifest	of(PackageMetadata getPackage, 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<ParsingError> errors)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_SINGLETON

public static final PackageFileManifest EMPTY_SINGLETON

A singleton instance of a manifest with an empty package metadata.

Constructor Detail

PackageFileManifest

public PackageFileManifest()

Method Detail

getPackage

public abstract PackageMetadata getPackage()

Contains the package 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).

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 PackageFileManifest of(PackageMetadata getPackage,
                                     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<ParsingError> errors)