com.linkedin.feathr.core.configbuilder

Interface ConfigBuilder

All Known Implementing Classes:

TypesafeConfigBuilder

public interface ConfigBuilder

Interface for building FeatureDefConfig and JoinConfig. Instance of a class implementing this interface can be obtained from the static factory method.

Method Summary

Modifier and Type	Method and Description
FeatureDefConfig	buildFeatureDefConfig(ConfigDataProvider provider) Builds a FeatureDefConfig by specifying a ConfigDataProvider that provides FeatureDef config data
FeatureDefConfig	buildFeatureDefConfig(java.util.List<java.lang.String> resourceNames) Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ResourceConfigDataProvider can be used as a ConfigDataProvider
FeatureDefConfig	buildFeatureDefConfig(java.io.Reader in) Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ReaderConfigDataProvider can be used as a ConfigDataProvider
FeatureDefConfig	buildFeatureDefConfig(java.lang.String resourceName) Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ResourceConfigDataProvider can be used as a ConfigDataProvider
FeatureDefConfig	buildFeatureDefConfig(java.net.URL url) Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where UrlConfigDataProvider can be used as a ConfigDataProvider
FeatureDefConfig	buildFeatureDefConfigFromManifest(java.lang.String manifestResourceName) Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ManifestConfigDataProvider can be used as a ConfigDataProvider
FeatureDefConfig	buildFeatureDefConfigFromString(java.lang.String configStr) Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where StringConfigDataProvider can be used as a ConfigDataProvider
FeatureDefConfig	buildFeatureDefConfigFromUrls(java.util.List<java.net.URL> urls) Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where UrlConfigDataProvider can be used as a ConfigDataProvider
java.util.List<FeatureDefConfig>	buildFeatureDefConfigList(ConfigDataProvider provider) Builds several FeatureDefConfigs by specifying a ConfigDataProvider that provides FeatureDef config data.
JoinConfig	buildJoinConfig(ConfigDataProvider provider) Builds a JoinConfig by specifying a ConfigDataProvider that provides Join config data
JoinConfig	buildJoinConfig(java.lang.String resourceName) Deprecated. Use buildJoinConfig(ConfigDataProvider) where ResourceConfigDataProvider can be used as a ConfigDataProvider
JoinConfig	buildJoinConfig(java.net.URL url) Deprecated. Use buildJoinConfig(ConfigDataProvider) where UrlConfigDataProvider can be used as a ConfigDataProvider
static ConfigBuilder	get() Factory method for getting an instance of ConfigBuilder

Method Detail

get

static ConfigBuilder get()

Factory method for getting an instance of ConfigBuilder

Returns:

ConfigBuilder object

buildFeatureDefConfig

FeatureDefConfig buildFeatureDefConfig(ConfigDataProvider provider)

Builds a FeatureDefConfig by specifying a ConfigDataProvider that provides FeatureDef config data

Parameters:

provider - ConfigDataProvider

Returns:

FeatureDefConfig

Throws:

ConfigBuilderException

buildFeatureDefConfigList

java.util.List<FeatureDefConfig> buildFeatureDefConfigList(ConfigDataProvider provider)

Builds several FeatureDefConfigs by specifying a ConfigDataProvider that provides FeatureDef config data. This method will not merge FeatureDefConfigs shared across different configs. Instead, it will construct individual configs for each resource provided within the ConfigDataProvider.

Parameters:

provider - ConfigDataProvider

Returns:

List

Throws:

ConfigBuilderException

buildJoinConfig

JoinConfig buildJoinConfig(ConfigDataProvider provider)

Builds a JoinConfig by specifying a ConfigDataProvider that provides Join config data

Parameters:

provider - ConfigDataProvider

Returns:

JoinConfig

Throws:

ConfigBuilderException

buildFeatureDefConfigFromUrls

@Deprecated
FeatureDefConfig buildFeatureDefConfigFromUrls(java.util.List<java.net.URL> urls)

Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where UrlConfigDataProvider can be used as a ConfigDataProvider

Builds a single Frame FeatureDef Config from a list of configuration files referenced by URLs.

Parameters:

urls - List of URLs for configuration files

Returns:

FeatureDefConfig config object

Throws:

ConfigBuilderException

buildFeatureDefConfig

@Deprecated
FeatureDefConfig buildFeatureDefConfig(java.net.URL url)

Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where UrlConfigDataProvider can be used as a ConfigDataProvider

Builds a Frame FeatureDef Config from a configuration file referenced by URL.

Parameters:

url - URL for the config file

Returns:

FeatureDefConfig config object

Throws:

ConfigBuilderException

buildFeatureDefConfig

@Deprecated
FeatureDefConfig buildFeatureDefConfig(java.util.List<java.lang.String> resourceNames)

Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ResourceConfigDataProvider can be used as a ConfigDataProvider

Builds a single Frame FeatureDef Config from a list of configuration files on the classpath.

Parameters:

resourceNames - Names of the config files

Returns:

FeatureDefConfig config object

Throws:

ConfigBuilderException

buildFeatureDefConfig

@Deprecated
FeatureDefConfig buildFeatureDefConfig(java.lang.String resourceName)

Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ResourceConfigDataProvider can be used as a ConfigDataProvider

Builds a Frame FeatureDef Config from a configuration file on the classpath

Parameters:

resourceName - Name of the config file on the classpath

Returns:

FeatureDefConfig config object

Throws:

ConfigBuilderException

buildFeatureDefConfigFromString

@Deprecated
FeatureDefConfig buildFeatureDefConfigFromString(java.lang.String configStr)

Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where StringConfigDataProvider can be used as a ConfigDataProvider

Builds a Frame FeatureDef Config from a configuration string

Parameters:

configStr - configuration expressed in a string

Returns:

FeatureDefConfig config object

Throws:

ConfigBuilderException

buildFeatureDefConfig

@Deprecated
FeatureDefConfig buildFeatureDefConfig(java.io.Reader in)

Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ReaderConfigDataProvider can be used as a ConfigDataProvider

Builds a Frame FeatureDef Config from a java.io.Reader

Parameters:

in - A java.io.Reader instance

Returns:

FeatureDefConfig config object

Throws:

ConfigBuilderException

buildFeatureDefConfigFromManifest

@Deprecated
FeatureDefConfig buildFeatureDefConfigFromManifest(java.lang.String manifestResourceName)

Deprecated. Use buildFeatureDefConfig(ConfigDataProvider) where ManifestConfigDataProvider can be used as a ConfigDataProvider

Builds a Frame FeatureDef Config from a config manifest specified as a resource

Parameters:

manifestResourceName -

Returns:

FeatureDefConfig config object

Throws:

ConfigBuilderException

buildJoinConfig

@Deprecated
JoinConfig buildJoinConfig(java.net.URL url)

Deprecated. Use buildJoinConfig(ConfigDataProvider) where UrlConfigDataProvider can be used as a ConfigDataProvider

Build a Join Config from a configuration accessed via a URL

Parameters:

url - A java.net.URL

Returns:

JoinConfig config object

Throws:

ConfigBuilderException

buildJoinConfig

@Deprecated
JoinConfig buildJoinConfig(java.lang.String resourceName)

Deprecated. Use buildJoinConfig(ConfigDataProvider) where ResourceConfigDataProvider can be used as a ConfigDataProvider

Build a Join Config from a configuration file on the classpath

Parameters:

resourceName - Name of the configuration file expressed as a resource

Returns:

JoinConfig config object

Throws:

ConfigBuilderException