com.facebook.buck.core.rules.actions.lib.args

Interface CommandLineArgs

All Superinterfaces:

AddsToRuleKey, CommandLineArgsApi, com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable, com.google.devtools.build.lib.skylarkinterface.SkylarkValue

All Known Implementing Classes:

ImmutableRunInfo, RunInfo

public interface CommandLineArgs
extends AddsToRuleKey, CommandLineArgsApi

Container for a list of objects that can be stringified into command line arguments for an action that executes a program.

In the future this will also let us more efficiently concatenate command line arguments that are passed around as providers, as the CommandLineArgs objects may store the immutable objects more efficiently, and just construct a stream to interate over those internal collections.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CommandLineArgs.ArgAndFormatString Simple container that holds a single argument, and a formatting string that should be run after CommandLineArgs.ArgAndFormatString.getObject() has been stringified (containing a single %s).

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FORMAT_STRING

Method Summary

Modifier and Type	Method and Description
java.util.stream.Stream<CommandLineArgs.ArgAndFormatString>	getArgsAndFormatStrings()
com.google.common.collect.ImmutableSortedMap<String,String>	getEnvironmentVariables()
int	getEstimatedArgsCount() Get the approximate number of arguments that will be returned for getArgsAndFormatStrings()
void	visitInputsAndOutputs(java.util.function.Consumer<Artifact> inputs, java.util.function.Consumer<OutputArtifact> outputs) Add any artifacts from getArgsAndFormatStrings() to inputs and outputs, inferring based on type

Methods inherited from interface com.facebook.buck.core.rules.actions.lib.args.CommandLineArgsApi

isImmutable, repr

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkValue

isHashable

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable

debugPrint, str

Field Detail

DEFAULT_FORMAT_STRING

static final String DEFAULT_FORMAT_STRING

See Also:

Constant Field Values

Method Detail

getEnvironmentVariables

com.google.common.collect.ImmutableSortedMap<String,String> getEnvironmentVariables()

Returns:

Get a map of all environment variables that need to be added to execute this program.

getArgsAndFormatStrings

java.util.stream.Stream<CommandLineArgs.ArgAndFormatString> getArgsAndFormatStrings()

Returns:

Get a stream of all raw argument objects that can be stringified with something like CommandLineArgStringifier.asString(ArtifactFilesystem, boolean, Object)

getEstimatedArgsCount

int getEstimatedArgsCount()

Get the approximate number of arguments that will be returned for getArgsAndFormatStrings()

This can be handy to pre-size destination collections

Returns:

the approximate number of arguments. If retrieving the accurate count is efficient, a correct number is preferred. However if getting a correct number is impossible or expensive, an approximation is acceptable.

visitInputsAndOutputs

void visitInputsAndOutputs(java.util.function.Consumer<Artifact> inputs,
                           java.util.function.Consumer<OutputArtifact> outputs)

Add any artifacts from getArgsAndFormatStrings() to inputs and outputs, inferring based on type