com.azure.core.util.configuration

Class Configuration

java.lang.Object

com.azure.core.util.configuration.Configuration

All Implemented Interfaces:

Cloneable

public class Configuration
extends Object
implements Cloneable

Contains configuration information that is used during construction of client libraries.

Field Summary

Fields

Modifier and Type	Field and Description
static Configuration	NONE Noop Configuration object used to opt out of using global configurations when constructing client libraries.

Constructor Summary

Constructors

Constructor and Description
Configuration() Constructs an empty configuration.

Method Summary

Modifier and Type	Method and Description
Configuration	clone()
boolean	contains(String name) Determines if the configuration exists.
String	get(String name) Gets the value of the configuration.
<T> T	get(String name, Function<String,T> converter) Gets the converted value of the configuration.
<T> T	get(String name, T defaultValue) Gets the value of the configuration converted to T.
Configuration	put(String name, String value) Adds a configuration with the given value.
String	remove(String name) Removes the configuration.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final Configuration NONE

Noop Configuration object used to opt out of using global configurations when constructing client libraries.

Constructor Detail

Configuration

public Configuration()

Constructs an empty configuration.

Method Detail

get

public String get(String name)

Gets the value of the configuration.

Parameters:

name - Name of the configuration.

Returns:

Value of the configuration if found, otherwise null.

get

public <T> T get(String name,
                 T defaultValue)

Gets the value of the configuration converted to T. If no configuration is found the default is returned.

Type Parameters:

T - Generic type that the configuration is converted to if found.

Parameters:

name - Name of the configuration.

defaultValue - Value to return if the configuration isn't found.

Returns:

The converted configuration if found, otherwise the default value is returned.

get

public <T> T get(String name,
                 Function<String,T> converter)

Gets the converted value of the configuration.

Type Parameters:

T - Generic type that the configuration is converted to if found.

Parameters:

name - Name of the configuration.

converter - Converter used to map the configuration to T.

Returns:

The converted configuration if found, otherwise null.

put

public Configuration put(String name,
                         String value)

Adds a configuration with the given value. If a configuration with the same name already exists this will update it to the passed value.

Parameters:

name - Name of the configuration.

value - Value of the configuration.

Returns:

the updated Configuration object.

remove

public String remove(String name)

Removes the configuration.

Parameters:

name - Name of the configuration.

Returns:

If the configuration was removed the value of it, otherwise null.

contains

public boolean contains(String name)

Determines if the configuration exists.

Parameters:

name - Name of the configuration.

Returns:

True if the configuration exists, otherwise false.

clone

public Configuration clone()

Overrides:

clone in class Object

Returns:

a clone of the Configuration object.