io.opentelemetry.sdk.common.export

Class ConfigBuilder<T>

java.lang.Object

io.opentelemetry.sdk.common.export.ConfigBuilder<T>

Type Parameters:

T - the type of the implementation.

Direct Known Subclasses:

BatchSpanProcessor.Builder, IntervalMetricReader.Builder, SimpleSpanProcessor.Builder, TraceConfig.Builder

public abstract class ConfigBuilder<T>
extends Object

Base class for all the config builder classes (SimpleSpanProcessor, BatchSpanProcessor, etc).

The type parameter on this class should be set to the type of the implementation of this abstract class. For example, if your subclass is a Foo.Builder, then you would declare it as

Foo.Builder extends ConfigBuilder<Foo.Builder>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ConfigBuilder.NamingConvention

Constructor Summary

Constructors

Constructor and Description
ConfigBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract T	fromConfigMap(Map<String,String> configMap, ConfigBuilder.NamingConvention namingConvention) Sets the configuration values from the given configuration map for only the available keys.
protected static Boolean	getBooleanProperty(String name, Map<String,String> map) Get a boolean property from the map, null if it cannot be found or it has a wrong type.
protected static Double	getDoubleProperty(String name, Map<String,String> map) Get a double property from the map, null if it cannot be found or it has a wrong type.
protected static Integer	getIntProperty(String name, Map<String,String> map) Get an integer property from the map, null if it cannot be found or it has a wrong type.
protected static Long	getLongProperty(String name, Map<String,String> map) Get a long property from the map, null if it cannot be found or it has a wrong type.
protected static String	getStringProperty(String name, Map<String,String> map) Get a String property from the map, null if it cannot be found.
T	readEnvironmentVariables() Sets the configuration values from environment variables.
T	readProperties(Properties properties) Sets the configuration values from the given Properties object.
T	readSystemProperties() Sets the configuration values from system properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigBuilder

public ConfigBuilder()

Method Detail

fromConfigMap

protected abstract T fromConfigMap(Map<String,String> configMap,
                                   ConfigBuilder.NamingConvention namingConvention)

Sets the configuration values from the given configuration map for only the available keys.

readProperties

public T readProperties(Properties properties)

Sets the configuration values from the given Properties object.

readEnvironmentVariables

public T readEnvironmentVariables()

Sets the configuration values from environment variables.

readSystemProperties

public T readSystemProperties()

Sets the configuration values from system properties.

getBooleanProperty

@Nullable
protected static Boolean getBooleanProperty(String name,
                                                      Map<String,String> map)

Get a boolean property from the map, null if it cannot be found or it has a wrong type.

Parameters:

name - The property name

map - The map where to look for the property

Returns:

the Boolean value of the property, null in case of error or if the property cannot be found.

getIntProperty

@Nullable
protected static Integer getIntProperty(String name,
                                                  Map<String,String> map)

Get an integer property from the map, null if it cannot be found or it has a wrong type.

Parameters:

name - The property name

map - The map where to look for the property

Returns:

the Integer value of the property, null in case of error or if the property cannot be found.

getLongProperty

@Nullable
protected static Long getLongProperty(String name,
                                                Map<String,String> map)

Get a long property from the map, null if it cannot be found or it has a wrong type.

Parameters:

name - The property name

map - The map where to look for the property

Returns:

the Long value of the property, null in case of error or if the property cannot be found.

getStringProperty

@Nullable
protected static String getStringProperty(String name,
                                                    Map<String,String> map)

Get a String property from the map, null if it cannot be found.

Parameters:

name - The property name

map - The map where to look for the property

Returns:

the String value of the property, null if the property cannot be found.

getDoubleProperty

@Nullable
protected static Double getDoubleProperty(String name,
                                                    Map<String,String> map)

Get a double property from the map, null if it cannot be found or it has a wrong type.

Parameters:

name - The property name

map - The map where to look for the property

Returns:

the Double value of the property, null in case of error or if the property cannot be found.