com.facebook.buck.rules.coercer

Class BuildConfigFields

java.lang.Object

com.facebook.buck.rules.coercer.BuildConfigFields

All Implemented Interfaces:

Iterable<BuildConfigFields.Field>

@Value.Enclosing
public abstract class BuildConfigFields
extends Object
implements Iterable<BuildConfigFields.Field>

List of fields to add to a generated BuildConfig.java file. Each field knows its Java type, variable name, and value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildConfigFields.Field An individual field in a BuildConfigFields.

Constructor Summary

Constructors

Constructor and Description
BuildConfigFields()

Method Summary

Modifier and Type	Method and Description
static BuildConfigFields	fromFieldDeclarations(Iterable<String> declarations)
static BuildConfigFields	fromFields(Iterable<BuildConfigFields.Field> fields)
String	generateBuildConfigDotJava(UnflavoredBuildTarget source, String javaPackage, boolean useConstantExpressions) Creates the Java code for a BuildConfig.java file in the specified javaPackage.
abstract Map<String,BuildConfigFields.Field>	getNameToField()
Iterator<BuildConfigFields.Field>	iterator()
static BuildConfigFields	of()
static BuildConfigFields	of(Map<String,? extends BuildConfigFields.Field> nameToField)
BuildConfigFields	putAll(BuildConfigFields fields)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BuildConfigFields

public BuildConfigFields()

Method Detail

getNameToField

public abstract Map<String,BuildConfigFields.Field> getNameToField()

of

public static BuildConfigFields of(Map<String,? extends BuildConfigFields.Field> nameToField)

of

public static BuildConfigFields of()

fromFieldDeclarations

public static BuildConfigFields fromFieldDeclarations(Iterable<String> declarations)

fromFields

public static BuildConfigFields fromFields(Iterable<BuildConfigFields.Field> fields)

Returns:

a BuildConfigFields that contains the specified fields in iteration order.

putAll

public BuildConfigFields putAll(BuildConfigFields fields)

Returns:

A new BuildConfigFields with all of the fields from this object, combined with all of the fields from the specified fields. If both objects have fields with the same name, the entry from the fields parameter wins.

generateBuildConfigDotJava

public String generateBuildConfigDotJava(UnflavoredBuildTarget source,
                                         String javaPackage,
                                         boolean useConstantExpressions)

Creates the Java code for a BuildConfig.java file in the specified javaPackage.

Parameters:

source - The build target of the rule that is responsible for generating this BuildConfig.java file.

javaPackage - The Java package for the generated file.

useConstantExpressions - Whether the value of each field in the generated Java code should be the literal value from the BuildConfigFields.Field (i.e., a constant expression) or a non-constant-expression that is guaranteed to evaluate to the literal value.

iterator

public Iterator<BuildConfigFields.Field> iterator()

Specified by:

iterator in interface Iterable<BuildConfigFields.Field>

Returns:

iterator that enumerates the fields used to construct this BuildConfigFields. The Iterator.remove() method of the return value is not supported.

toString

public String toString()

Overrides:

toString in class Object

Returns:

value that represents the data stored in this object such that it can be used to represent this object in a RuleKey.