com.facebook.buck.rules.args

Interface Arg

All Superinterfaces:

AddsToRuleKey

All Known Subinterfaces:

ToolArg

All Known Implementing Classes:

CompositeArg, CxxThinLTOIndexArg, FileListableLinkerInputArg, FormatArg, ProxyArg, RelativeLinkArg, RustLibraryArg, SanitizedArg, SourcePathArg, StringArg, WorkerMacroArg, WriteToFileArg

public interface Arg
extends AddsToRuleKey

An abstraction for modeling the arguments that contribute to a command run by a BuildRule, and also carry information for computing a rule key.

Method Summary

Modifier and Type	Method and Description
void	appendToCommandLine(java.util.function.Consumer<String> consumer, SourcePathResolverAdapter pathResolver) Feed the contents of the Arg to the supplied consumer.
boolean	equals(Object other)
static Optional<String>	flattenToSpaceSeparatedString(Optional<Arg> arg, SourcePathResolverAdapter pathResolver)
int	hashCode()
default String	singleCommandLineArg(SourcePathResolverAdapter pathResolverAdapter) Resolve this argument to single string, fail if this arg corresponds to none or more than one argument.
static String	stringify(Arg arg, SourcePathResolverAdapter pathResolver) Converts an Arg to a String by concatting all the command-line appended strings.
static <K> com.google.common.collect.ImmutableMap<K,String>	stringify(com.google.common.collect.ImmutableMap<K,? extends Arg> argMap, SourcePathResolverAdapter pathResolver)
static com.google.common.collect.ImmutableList<String>	stringify(Iterable<? extends Arg> args, SourcePathResolverAdapter pathResolver)
static com.google.common.collect.ImmutableList<String>	stringifyList(Arg input, SourcePathResolverAdapter pathResolver)
String	toString()

Method Detail

flattenToSpaceSeparatedString

static Optional<String> flattenToSpaceSeparatedString(Optional<Arg> arg,
                                                      SourcePathResolverAdapter pathResolver)

appendToCommandLine

void appendToCommandLine(java.util.function.Consumer<String> consumer,
                         SourcePathResolverAdapter pathResolver)

Feed the contents of the Arg to the supplied consumer. This call may feed any number of elements (including zero) into the consumer. This is only ever safe to call when the rule is running, as it may do things like resolving source paths.

singleCommandLineArg

default String singleCommandLineArg(SourcePathResolverAdapter pathResolverAdapter)

Resolve this argument to single string, fail if this arg corresponds to none or more than one argument.

toString

String toString()

Overrides:

toString in class Object

Returns:

a String representation suitable to use for debugging.

equals

boolean equals(Object other)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

stringifyList

static com.google.common.collect.ImmutableList<String> stringifyList(Arg input,
                                                                     SourcePathResolverAdapter pathResolver)

stringify

static com.google.common.collect.ImmutableList<String> stringify(Iterable<? extends Arg> args,
                                                                 SourcePathResolverAdapter pathResolver)

stringify

static String stringify(Arg arg,
                        SourcePathResolverAdapter pathResolver)

Converts an Arg to a String by concatting all the command-line appended strings.

stringify

static <K> com.google.common.collect.ImmutableMap<K,String> stringify(com.google.common.collect.ImmutableMap<K,? extends Arg> argMap,
                                                                      SourcePathResolverAdapter pathResolver)