com.facebook.buck.parser

Class ParsingContext

java.lang.Object

com.facebook.buck.parser.ParsingContext

public abstract class ParsingContext
extends Object

Contains objects and information that may be used during processing a parsing request.

Note that some of the objects in this context may not be used during all of the requests. For this reason this context is created using a builder pattern where only necessary parameters are passed. Some of the parameters are mandatory and they must be passed to the builder() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParsingContext.Builder

Constructor Summary

Constructors

Constructor and Description
ParsingContext()

Method Summary

Modifier and Type	Method and Description
static ParsingContext.Builder	builder(Cell cell, com.google.common.util.concurrent.ListeningExecutorService executor)
boolean	enableTargetCompatibilityChecks()
boolean	excludeUnsupportedTargets() Whether targets with constraints that are not compatible with the target platform should be excluded.
ParserConfig.ApplyDefaultFlavorsMode	getApplyDefaultFlavorsMode() Controls how flavors are appended to the build targets.
abstract Cell	getCell() Cell for which the parsing request is performed
abstract com.google.common.util.concurrent.ListeningExecutorService	getExecutor() An executor used during parsing request to perform async computations
SpeculativeParsing	getSpeculativeParsing() Whether speculative parsing is enabled.
boolean	isProfilingEnabled() Whether to enable profiling during parsing request.
boolean	useUnconfiguredSelectorResolver()
ParsingContext	withApplyDefaultFlavorsMode(ParserConfig.ApplyDefaultFlavorsMode value)
ParsingContext	withCell(Cell value)
ParsingContext	withExcludeUnsupportedTargets(boolean value)
ParsingContext	withSpeculativeParsing(SpeculativeParsing value)
ParsingContext	withUseUnconfiguredSelectorResolver(boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ParsingContext

public ParsingContext()

Method Detail

getCell

public abstract Cell getCell()

Cell for which the parsing request is performed

getExecutor

public abstract com.google.common.util.concurrent.ListeningExecutorService getExecutor()

An executor used during parsing request to perform async computations

isProfilingEnabled

@Value.Default
public boolean isProfilingEnabled()

Whether to enable profiling during parsing request.

getSpeculativeParsing

@Value.Default
public SpeculativeParsing getSpeculativeParsing()

Whether speculative parsing is enabled.

Speculative parsing a special mode of parsing when dependencies of a target are scheduled for parsing ahead of the actual requests for parsing of those targets. This may lead to over-parsing is some case and thus needs to be used in situations when all of the dependencies of requested targets are used later.

excludeUnsupportedTargets

@Value.Default
public boolean excludeUnsupportedTargets()

Whether targets with constraints that are not compatible with the target platform should be excluded.

getApplyDefaultFlavorsMode

@Value.Default
public ParserConfig.ApplyDefaultFlavorsMode getApplyDefaultFlavorsMode()

Controls how flavors are appended to the build targets.

See Also:

ParserConfig.ApplyDefaultFlavorsMode

enableTargetCompatibilityChecks

@Value.Default
public boolean enableTargetCompatibilityChecks()

useUnconfiguredSelectorResolver

@Value.Default
public boolean useUnconfiguredSelectorResolver()

withCell

public final ParsingContext withCell(Cell value)

withSpeculativeParsing

public final ParsingContext withSpeculativeParsing(SpeculativeParsing value)

withExcludeUnsupportedTargets

public final ParsingContext withExcludeUnsupportedTargets(boolean value)

withApplyDefaultFlavorsMode

public final ParsingContext withApplyDefaultFlavorsMode(ParserConfig.ApplyDefaultFlavorsMode value)

withUseUnconfiguredSelectorResolver

public final ParsingContext withUseUnconfiguredSelectorResolver(boolean value)

builder

public static ParsingContext.Builder builder(Cell cell,
                                             com.google.common.util.concurrent.ListeningExecutorService executor)