com.facebook.buck.core.model

Class FlavorDomain<T>

java.lang.Object

com.facebook.buck.core.model.FlavorDomain<T>

public class FlavorDomain<T>
extends Object

Provides a named flavor abstraction on top of boolean flavors.

Constructor Summary

Constructors

Constructor and Description
FlavorDomain(String name, com.google.common.collect.ImmutableMap<Flavor,T> translation)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Flavor flavor)
boolean	containsAnyOf(FlavorSet flavors)
boolean	containsAnyOf(Set<Flavor> flavors)
<U extends FlavorConvertible> FlavorDomain<U>	convert(String name, java.util.function.Function<? super T,U> mapper) Provides a convenience for converting from one domain to another.
static <E extends Enum<E> & FlavorConvertible> FlavorDomain<E>	from(String name, Class<E> cls) Create a FlavorDomain from FlavorConverbile Enum.
static <T extends FlavorConvertible> FlavorDomain<T>	from(String name, Iterable<T> objects) Create a FlavorDomain from FlavorConvertible objects.
Optional<Flavor>	getFlavor(BuildTarget buildTarget)
Optional<Flavor>	getFlavor(FlavorSet flavorSet)
Optional<Flavor>	getFlavor(Set<Flavor> flavors)
Optional<Map.Entry<Flavor,T>>	getFlavorAndValue(BuildTarget buildTarget)
Optional<Map.Entry<Flavor,T>>	getFlavorAndValue(FlavorSet flavors)
Optional<Map.Entry<Flavor,T>>	getFlavorAndValue(Set<Flavor> flavors)
com.google.common.collect.ImmutableSet<Flavor>	getFlavors()
String	getName()
T	getRequiredValue(BuildTarget buildTarget)
Optional<T>	getValue(BuildTarget buildTarget)
T	getValue(Flavor flavor)
Optional<T>	getValue(FlavorSet flavors)
Optional<T>	getValue(Set<Flavor> flavors)
com.google.common.collect.ImmutableCollection<T>	getValues()
com.google.common.collect.ImmutableList<T>	getValues(BuildTarget buildTarget)
<U> FlavorDomain<U>	map(java.util.function.Function<? super T,U> mapper) Provides a convenience function to map the values of the domain (retaining the current name).
<U> FlavorDomain<U>	map(String name, java.util.function.Function<? super T,U> mapper) Provides a convenience function to map the values of the domain.
static <T extends FlavorConvertible> FlavorDomain<T>	of(String name, T... objects) Create a FlavorDomain from array/varargs of FlavorConvertible objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlavorDomain

public FlavorDomain(String name,
                    com.google.common.collect.ImmutableMap<Flavor,T> translation)

Method Detail

getName

public String getName()

getFlavors

public com.google.common.collect.ImmutableSet<Flavor> getFlavors()

getValues

public com.google.common.collect.ImmutableCollection<T> getValues()

containsAnyOf

public boolean containsAnyOf(Set<Flavor> flavors)

containsAnyOf

public boolean containsAnyOf(FlavorSet flavors)

map

public <U> FlavorDomain<U> map(java.util.function.Function<? super T,U> mapper)

Provides a convenience function to map the values of the domain (retaining the current name).

map

public <U> FlavorDomain<U> map(String name,
                               java.util.function.Function<? super T,U> mapper)

Provides a convenience function to map the values of the domain.

convert

public <U extends FlavorConvertible> FlavorDomain<U> convert(String name,
                                                             java.util.function.Function<? super T,U> mapper)

Provides a convenience for converting from one domain to another. This is similar to map(), but the new domain has flavors derived from the mapped to FlavorConvertible.

contains

public boolean contains(Flavor flavor)

getFlavor

public Optional<Flavor> getFlavor(Set<Flavor> flavors)

getFlavor

public Optional<Flavor> getFlavor(FlavorSet flavorSet)

getFlavor

public Optional<Flavor> getFlavor(BuildTarget buildTarget)

getFlavorAndValue

public Optional<Map.Entry<Flavor,T>> getFlavorAndValue(Set<Flavor> flavors)

getFlavorAndValue

public Optional<Map.Entry<Flavor,T>> getFlavorAndValue(FlavorSet flavors)

getFlavorAndValue

public Optional<Map.Entry<Flavor,T>> getFlavorAndValue(BuildTarget buildTarget)

getValue

public Optional<T> getValue(Set<Flavor> flavors)

getValue

public Optional<T> getValue(FlavorSet flavors)

getValue

public Optional<T> getValue(BuildTarget buildTarget)

getValues

public com.google.common.collect.ImmutableList<T> getValues(BuildTarget buildTarget)

Returns:

a list of values for the flavors from the given target. Target's flavors that are not present in this domain are ignored.

getRequiredValue

public T getRequiredValue(BuildTarget buildTarget)

getValue

public T getValue(Flavor flavor)

from

public static <T extends FlavorConvertible> FlavorDomain<T> from(String name,
                                                                 Iterable<T> objects)

Create a FlavorDomain from FlavorConvertible objects.

of

@SafeVarargs
public static <T extends FlavorConvertible> FlavorDomain<T> of(String name,
                                                                            T... objects)

Create a FlavorDomain from array/varargs of FlavorConvertible objects.

from

public static <E extends Enum<E> & FlavorConvertible> FlavorDomain<E> from(String name,
                                                                           Class<E> cls)

Create a FlavorDomain from FlavorConverbile Enum.