com.facebook.buck.util.config

Class Configs

java.lang.Object

com.facebook.buck.util.config.Configs

public final class Configs
extends Object

Utility functions for working with Configs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BUCK_CONFIG_OVERRIDE_FILE_NAME

Method Summary

Modifier and Type	Method and Description
static Config	createConfigFromFiles(Path root, com.google.common.collect.ImmutableList<Path> configFiles) Generates a config by merging configs from specified locations on disk in order of the list supplied.
static Config	createDefaultConfig(Path root) Convienence constructor
static Config	createDefaultConfig(Path root, com.google.common.collect.ImmutableList<Path> configFiles, RawConfig configOverrides) Generates a config by merging configs from specified locations on disk in order of the list supplied.
static Config	createDefaultConfig(Path root, RawConfig configOverrides) Generates a Buck config by merging configs from specified locations on disk.
static com.google.common.collect.ImmutableList<Path>	getDefaultConfigurationFiles(AbsPath root) Abs-path version of getDefaultConfigurationFiles(Path).
static com.google.common.collect.ImmutableList<Path>	getDefaultConfigurationFiles(Path root) Gets all configuration files that should be used for parsing the project configuration
static Path	getMainConfigurationFile(Path root)
static com.google.common.collect.ImmutableList<Path>	getRepoConfigurationFiles(Path root) Gets the repository defined configuration files (excluding configuration directories) that should be used for parsing the project configuration.
static com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,String>>	parseConfigFile(Path file)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUCK_CONFIG_OVERRIDE_FILE_NAME

public static final String DEFAULT_BUCK_CONFIG_OVERRIDE_FILE_NAME

See Also:

Constant Field Values

Method Detail

createDefaultConfig

public static Config createDefaultConfig(Path root)
                                  throws IOException

Convienence constructor

Throws:

IOException

createDefaultConfig

public static Config createDefaultConfig(Path root,
                                         RawConfig configOverrides)
                                  throws IOException

Generates a Buck config by merging configs from specified locations on disk.

In order:

1. Files (in lexicographical order) in /etc/buckconfig.d
2. /etc/buckconfig
3. Files (in lexicographical order) in <HOME>/buckconfig.d
4. Files (in lexicographical order) in <PROJECT ROOT >/buckconfig.d
5. <HOME>/.buckconfig
6. <PROJECT ROOT>/.buckconfig
7. <PROJECT ROOT>/.buckconfig.local
8. Any overrides (usually from the command line)

Parameters:

root - Project root.

configOverrides - Config overrides to merge in after the other sources.

Returns:

the resulting Config.

Throws:

IOException - on any exceptions during the underlying filesystem operations.

createDefaultConfig

public static Config createDefaultConfig(Path root,
                                         com.google.common.collect.ImmutableList<Path> configFiles,
                                         RawConfig configOverrides)
                                  throws IOException

Generates a config by merging configs from specified locations on disk in order of the list supplied. The elements at the end of the list have higher precedence.

Parameters:

root - Project root.

configFiles - the files to load configs from, in order of precedence.

configOverrides - Config overrides to merge in after the other sources.

Returns:

the resulting Config.

Throws:

IOException - on any exceptions during the underlying filesystem operations.

createConfigFromFiles

public static Config createConfigFromFiles(Path root,
                                           com.google.common.collect.ImmutableList<Path> configFiles)
                                    throws IOException

Generates a config by merging configs from specified locations on disk in order of the list supplied. The elements at the end of the list have higher precedence.

Parameters:

root - Project root.

configFiles - the files to load configs from, in order of precedence.

Returns:

the resulting RawConfig.

Throws:

IOException - on any exceptions during the underlying filesystem operations.

getMainConfigurationFile

public static Path getMainConfigurationFile(Path root)

getDefaultConfigurationFiles

public static com.google.common.collect.ImmutableList<Path> getDefaultConfigurationFiles(Path root)
                                                                                  throws IOException

Gets all configuration files that should be used for parsing the project configuration

Parameters:

root - The root of the project to search

Returns:

Files that exist that conform to buck's configuration file precedence. Settings from files at the end of this list should override ones that come before.

Throws:

IOException

getDefaultConfigurationFiles

public static com.google.common.collect.ImmutableList<Path> getDefaultConfigurationFiles(AbsPath root)
                                                                                  throws IOException

Abs-path version of getDefaultConfigurationFiles(Path).

Throws:

IOException

getRepoConfigurationFiles

public static com.google.common.collect.ImmutableList<Path> getRepoConfigurationFiles(Path root)

Gets the repository defined configuration files (excluding configuration directories) that should be used for parsing the project configuration.

Parameters:

root - The root of the project to search

Returns:

Files that exist that conform to buck's configuration file precedence. Settings from files at the end of this list should override ones that come before.

parseConfigFile

public static com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,String>> parseConfigFile(Path file)
                                                                                                                            throws IOException

Throws:

IOException