com.facebook.buck.rules.args

Class SanitizedArg

java.lang.Object

com.facebook.buck.rules.args.SanitizedArg

All Implemented Interfaces:

AddsToRuleKey, Arg

public class SanitizedArg
extends Object
implements Arg

An Arg which must be sanitized before contributing to a RuleKey.

 ImmutableMap<String, String> toolchainRoots =
     ImmutableMap.of("/opt/toolchain", "$TOOLCHAIN_ROOT");
 Path toolchainRoot = Paths.get("/opt/toolchain");
 Arg arg =
     new SanitizedArg(
         Functions.forMap(toolchainRoots),
         "/opt/toolchain/bin/tool");
 

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.
static SanitizedArg	create(java.util.function.Function<? super String,String> sanitizer, String unsanitized) Create a SanitizedArg by applying the given sanitizer function to an arg string.
boolean	equals(Object o)
static com.google.common.collect.ImmutableList<Arg>	from(java.util.function.Function<? super String,String> sanitizer, Iterable<String> args) Create a list of SanitizedArgs by applying the given sanitizer function to a list of arg strings and filtering empty args
static com.google.common.collect.ImmutableList<Arg>	fromArgs(java.util.function.Function<? super String,String> sanitizer, Iterable<Arg> args) Create a list of SanitizedArg from list of Arg by applying the given sanitizer StringArg and filtering empty StringArg.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.rules.args.Arg

flattenToSpaceSeparatedString, singleCommandLineArg, stringify, stringify, stringify, stringifyList

Method Detail

appendToCommandLine

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

Description copied from interface: Arg

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.

Specified by:

appendToCommandLine in interface Arg

toString

public String toString()

Specified by:

toString in interface Arg

Overrides:

toString in class Object

Returns:

a String representation suitable to use for debugging.

equals

public boolean equals(Object o)

Specified by:

equals in interface Arg

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Arg

Overrides:

hashCode in class Object

create

public static SanitizedArg create(java.util.function.Function<? super String,String> sanitizer,
                                  String unsanitized)

Create a SanitizedArg by applying the given sanitizer function to an arg string.

from

public static com.google.common.collect.ImmutableList<Arg> from(java.util.function.Function<? super String,String> sanitizer,
                                                                Iterable<String> args)

Create a list of SanitizedArgs by applying the given sanitizer function to a list of arg strings and filtering empty args

fromArgs

public static com.google.common.collect.ImmutableList<Arg> fromArgs(java.util.function.Function<? super String,String> sanitizer,
                                                                    Iterable<Arg> args)

Create a list of SanitizedArg from list of Arg by applying the given sanitizer StringArg and filtering empty StringArg.