com.facebook.buck.rules.coercer

Class SourceSet

java.lang.Object

com.facebook.buck.rules.coercer.SourceSet

All Implemented Interfaces:

AddsToRuleKey, TargetTranslatable<SourceSet>

public abstract class SourceSet
extends Object
implements TargetTranslatable<SourceSet>, AddsToRuleKey

A group of ordered sources, stored as either a Set of unnamed SourcePaths or a Map of names to SourcePaths. Commonly used to represent the input srcs parameter of rules where source "names" may be important (e.g. to control layout of C++ headers).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceSet.Type

Field Summary

Fields

Modifier and Type	Field and Description
static SourceSet	EMPTY

Constructor Summary

Constructors

Constructor and Description
SourceSet()

Method Summary

Modifier and Type	Method and Description
protected void	check()
static SourceSet	concat(Iterable<SourceSet> elements) Concatenates elements of the given lists into a single list.
abstract Optional<com.google.common.collect.ImmutableMap<String,SourcePath>>	getNamedSources()
com.google.common.collect.ImmutableList<SourcePath>	getPaths()
abstract SourceSet.Type	getType()
abstract Optional<com.google.common.collect.ImmutableSet<SourcePath>>	getUnnamedSources()
boolean	isEmpty()
static SourceSet	of(SourceSet.Type type, Optional<? extends com.google.common.collect.ImmutableSet<SourcePath>> unnamedSources, Optional<? extends com.google.common.collect.ImmutableMap<String,SourcePath>> namedSources)
static SourceSet	ofNamedSources(com.google.common.collect.ImmutableMap<String,SourcePath> namedSources)
static SourceSet	ofUnnamedSources(com.google.common.collect.ImmutableSet<SourcePath> unnamedSources)
com.google.common.collect.ImmutableMap<String,SourcePath>	toNameMap(BuildTarget buildTarget, SourcePathResolverAdapter pathResolver, String parameterName)
com.google.common.collect.ImmutableMap<String,SourcePath>	toNameMap(BuildTarget buildTarget, SourcePathResolverAdapter pathResolver, String parameterName, java.util.function.Predicate<SourcePath> filter, java.util.function.Function<SourcePath,SourcePath> transform)
Optional<SourceSet>	translateTargets(CellNameResolver cellPathResolver, BaseName targetBaseName, TargetNodeTranslator translator)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final SourceSet EMPTY

Constructor Detail

SourceSet

public SourceSet()

Method Detail

getType

public abstract SourceSet.Type getType()

getUnnamedSources

public abstract Optional<com.google.common.collect.ImmutableSet<SourcePath>> getUnnamedSources()

getNamedSources

public abstract Optional<com.google.common.collect.ImmutableMap<String,SourcePath>> getNamedSources()

check

@Value.Check
protected void check()

ofUnnamedSources

public static SourceSet ofUnnamedSources(com.google.common.collect.ImmutableSet<SourcePath> unnamedSources)

ofNamedSources

public static SourceSet ofNamedSources(com.google.common.collect.ImmutableMap<String,SourcePath> namedSources)

isEmpty

public boolean isEmpty()

toNameMap

public com.google.common.collect.ImmutableMap<String,SourcePath> toNameMap(BuildTarget buildTarget,
                                                                           SourcePathResolverAdapter pathResolver,
                                                                           String parameterName,
                                                                           java.util.function.Predicate<SourcePath> filter,
                                                                           java.util.function.Function<SourcePath,SourcePath> transform)

toNameMap

public com.google.common.collect.ImmutableMap<String,SourcePath> toNameMap(BuildTarget buildTarget,
                                                                           SourcePathResolverAdapter pathResolver,
                                                                           String parameterName)

getPaths

public com.google.common.collect.ImmutableList<SourcePath> getPaths()

translateTargets

public Optional<SourceSet> translateTargets(CellNameResolver cellPathResolver,
                                            BaseName targetBaseName,
                                            TargetNodeTranslator translator)

Specified by:

translateTargets in interface TargetTranslatable<SourceSet>

Returns:

if any changes are required, return the translated object.

concat

public static SourceSet concat(Iterable<SourceSet> elements)

Concatenates elements of the given lists into a single list.

of

public static SourceSet of(SourceSet.Type type,
                           Optional<? extends com.google.common.collect.ImmutableSet<SourcePath>> unnamedSources,
                           Optional<? extends com.google.common.collect.ImmutableMap<String,SourcePath>> namedSources)