com.facebook.buck.core.config

Class BuckConfig

java.lang.Object

com.facebook.buck.core.config.BuckConfig

public class BuckConfig
extends Object

Structured representation of data read from a .buckconfig file.

Constructor Summary

Constructors

Constructor and Description
BuckConfig(Config config, ProjectFilesystem projectFilesystem, Architecture architecture, Platform platform, com.google.common.collect.ImmutableMap<String,String> environment, java.util.function.Function<String,UnconfiguredBuildTarget> buildTargetParser)

Method Summary

Modifier and Type	Method and Description
Path	checkPathExistsAndResolve(String pathString, String errorMsg)
boolean	equals(Object obj)
Architecture	getArchitecture()
Optional<Boolean>	getBoolean(String sectionName, String propertyName)
boolean	getBooleanValue(String sectionName, String propertyName, boolean defaultValue)
Optional<BuildTarget>	getBuildTarget(String section, String field, TargetConfiguration targetConfiguration)
BuildTarget	getBuildTargetForFullyQualifiedTarget(String target, TargetConfiguration targetConfiguration)
Config	getConfig()
com.google.common.collect.ImmutableMap<String,String>	getEntriesForSection(String section)
<T extends Enum<T>> Optional<T>	getEnum(String section, String field, Class<T> clazz)
com.google.common.collect.ImmutableMap<String,String>	getEnvironment()
<T extends Enum<T>> Map<T,Double>	getExperimentGroups(String section, String field, Class<T> enumClass) Returns the probabilities for each group in an experiment.
ProjectFilesystem	getFilesystem()
Optional<Float>	getFloat(String sectionName, String propertyName)
com.google.common.collect.ImmutableList<BuildTarget>	getFullyQualifiedBuildTargets(String section, String key, TargetConfiguration targetConfiguration)
OptionalInt	getInteger(String sectionName, String propertyName)
com.google.common.collect.ImmutableList<String>	getListWithoutComments(String section, String field)
com.google.common.collect.ImmutableList<String>	getListWithoutComments(String section, String field, char splitChar)
String	getLocalhost()
Optional<Long>	getLong(String sectionName, String propertyName)
com.google.common.collect.ImmutableMap<String,String>	getMap(String section, String field)
Optional<BuildTarget>	getMaybeBuildTarget(String section, String field, TargetConfiguration targetConfiguration)
Optional<UnconfiguredBuildTarget>	getMaybeUnconfiguredBuildTarget(String section, String field)
Optional<com.google.common.collect.ImmutableList<String>>	getOptionalListWithoutComments(String section, String field)
Optional<com.google.common.collect.ImmutableList<String>>	getOptionalListWithoutComments(String section, String field, char splitChar)
Optional<com.google.common.collect.ImmutableList<Path>>	getOptionalPathList(String section, String field, boolean resolve)
<T> T	getOrThrow(String section, String field, Optional<T> value)
Optional<Path>	getPath(String sectionName, String name)
Optional<Path>	getPath(String sectionName, String name, boolean isCellRootRelative)
PathSourcePath	getPathSourcePath(Path path)
PathSourcePath	getPathSourcePath(Path path, String errorMessage)
Platform	getPlatform()
Optional<String>	getRawValue(String sectionName, String propertyName)
BuildTarget	getRequiredBuildTarget(String section, String field, TargetConfiguration targetConfiguration)
Path	getRequiredPath(String section, String field)
Optional<com.google.common.collect.ImmutableMap<String,String>>	getSection(String sectionName)
com.google.common.collect.ImmutableSet<String>	getSections()
Optional<SourcePath>	getSourcePath(String section, String field, TargetConfiguration targetConfiguration)
UnconfiguredBuildTarget	getUnconfiguredBuildTargetForFullyQualifiedTarget(String target)
Optional<URI>	getUrl(String section, String field)
Optional<String>	getValue(String sectionName, String propertyName)
<T extends ConfigView<BuckConfig>> T	getView(Class<T> cls) Get a ConfigView of this config.
int	hashCode()
boolean	hasUserDefinedValue(String sectionName, String propertyName)
Path	resolveNonNullPathOutsideTheProjectFilesystem(Path path)
Path	resolvePathThatMayBeOutsideTheProjectFilesystem(Path path)
String	toString()
BuckConfig	withBuildTargetParser(java.util.function.Function<String,UnconfiguredBuildTarget> buildTargetParser) Returns a clone of the current config with a the argument CellPathResolver.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuckConfig

public BuckConfig(Config config,
                  ProjectFilesystem projectFilesystem,
                  Architecture architecture,
                  Platform platform,
                  com.google.common.collect.ImmutableMap<String,String> environment,
                  java.util.function.Function<String,UnconfiguredBuildTarget> buildTargetParser)

Method Detail

withBuildTargetParser

public BuckConfig withBuildTargetParser(java.util.function.Function<String,UnconfiguredBuildTarget> buildTargetParser)

Returns a clone of the current config with a the argument CellPathResolver.

getView

public <T extends ConfigView<BuckConfig>> T getView(Class<T> cls)

Get a ConfigView of this config.

Type Parameters:

T - Type of the config view.

Parameters:

cls - Class of the config view.

getArchitecture

public Architecture getArchitecture()

getEntriesForSection

public com.google.common.collect.ImmutableMap<String,String> getEntriesForSection(String section)

getListWithoutComments

public com.google.common.collect.ImmutableList<String> getListWithoutComments(String section,
                                                                              String field)

getListWithoutComments

public com.google.common.collect.ImmutableList<String> getListWithoutComments(String section,
                                                                              String field,
                                                                              char splitChar)

getOptionalListWithoutComments

public Optional<com.google.common.collect.ImmutableList<String>> getOptionalListWithoutComments(String section,
                                                                                                String field)

getOptionalListWithoutComments

public Optional<com.google.common.collect.ImmutableList<String>> getOptionalListWithoutComments(String section,
                                                                                                String field,
                                                                                                char splitChar)

getOptionalPathList

public Optional<com.google.common.collect.ImmutableList<Path>> getOptionalPathList(String section,
                                                                                   String field,
                                                                                   boolean resolve)

getUnconfiguredBuildTargetForFullyQualifiedTarget

public UnconfiguredBuildTarget getUnconfiguredBuildTargetForFullyQualifiedTarget(String target)

getBuildTargetForFullyQualifiedTarget

public BuildTarget getBuildTargetForFullyQualifiedTarget(String target,
                                                         TargetConfiguration targetConfiguration)

getFullyQualifiedBuildTargets

public com.google.common.collect.ImmutableList<BuildTarget> getFullyQualifiedBuildTargets(String section,
                                                                                          String key,
                                                                                          TargetConfiguration targetConfiguration)

getBuildTarget

public Optional<BuildTarget> getBuildTarget(String section,
                                            String field,
                                            TargetConfiguration targetConfiguration)

Returns:

the parsed BuildTarget in the given section and field, if set.

getMaybeBuildTarget

public Optional<BuildTarget> getMaybeBuildTarget(String section,
                                                 String field,
                                                 TargetConfiguration targetConfiguration)

Returns:

the parsed BuildTarget in the given section and field, if set and a valid build target.

This is useful if you use getTool to get the target, if any, but allow filesystem references.

getMaybeUnconfiguredBuildTarget

public Optional<UnconfiguredBuildTarget> getMaybeUnconfiguredBuildTarget(String section,
                                                                         String field)

Returns:

the parsed UnconfiguredBuildTarget in the given section and field, if set and a valid build target.

This is useful if you use getTool to get the target, if any, but allow filesystem references.

getRequiredBuildTarget

public BuildTarget getRequiredBuildTarget(String section,
                                          String field,
                                          TargetConfiguration targetConfiguration)

Returns:

the parsed BuildTarget in the given section and field.

getEnum

public <T extends Enum<T>> Optional<T> getEnum(String section,
                                               String field,
                                               Class<T> clazz)

getSourcePath

public Optional<SourcePath> getSourcePath(String section,
                                          String field,
                                          TargetConfiguration targetConfiguration)

Returns:

a SourcePath identified by a @{link BuildTarget} or Path reference by the given section:field, if set.

getPathSourcePath

public PathSourcePath getPathSourcePath(Path path)

Returns:

a SourcePath identified by a Path.

getPathSourcePath

public PathSourcePath getPathSourcePath(Path path,
                                        String errorMessage)

Parameters:

errorMessage - the error message to throw if path is not found

Returns:

a SourcePath identified by a Path.

resolvePathThatMayBeOutsideTheProjectFilesystem

public Path resolvePathThatMayBeOutsideTheProjectFilesystem(Path path)

resolveNonNullPathOutsideTheProjectFilesystem

public Path resolveNonNullPathOutsideTheProjectFilesystem(Path path)

getLocalhost

public String getLocalhost()

getPlatform

public Platform getPlatform()

hasUserDefinedValue

public boolean hasUserDefinedValue(String sectionName,
                                   String propertyName)

getSection

public Optional<com.google.common.collect.ImmutableMap<String,String>> getSection(String sectionName)

getValue

public Optional<String> getValue(String sectionName,
                                 String propertyName)

Returns:

the string value for the config settings, where present empty values are Optional.empty().

getRawValue

public Optional<String> getRawValue(String sectionName,
                                    String propertyName)

Returns:

the string value for the config settings, where present empty values are Optional[].

getInteger

public OptionalInt getInteger(String sectionName,
                              String propertyName)

getLong

public Optional<Long> getLong(String sectionName,
                              String propertyName)

getFloat

public Optional<Float> getFloat(String sectionName,
                                String propertyName)

getBoolean

public Optional<Boolean> getBoolean(String sectionName,
                                    String propertyName)

getBooleanValue

public boolean getBooleanValue(String sectionName,
                               String propertyName,
                               boolean defaultValue)

getUrl

public Optional<URI> getUrl(String section,
                            String field)

getMap

public com.google.common.collect.ImmutableMap<String,String> getMap(String section,
                                                                    String field)

getExperimentGroups

public <T extends Enum<T>> Map<T,Double> getExperimentGroups(String section,
                                                             String field,
                                                             Class<T> enumClass)

Returns the probabilities for each group in an experiment.

getOrThrow

public <T> T getOrThrow(String section,
                        String field,
                        Optional<T> value)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getEnvironment

public com.google.common.collect.ImmutableMap<String,String> getEnvironment()

getPath

public Optional<Path> getPath(String sectionName,
                              String name)

Returns:

the path for the given section and property.

getRequiredPath

public Path getRequiredPath(String section,
                            String field)

getPath

public Optional<Path> getPath(String sectionName,
                              String name,
                              boolean isCellRootRelative)

checkPathExistsAndResolve

public Path checkPathExistsAndResolve(String pathString,
                                      String errorMsg)

getSections

public com.google.common.collect.ImmutableSet<String> getSections()

getConfig

public Config getConfig()

getFilesystem

public ProjectFilesystem getFilesystem()