Package com.azure.core.util

Class ConfigurationProperty<T>

  • Type Parameters:
    T - Type of property value.
    public final class ConfigurationProperty<T>
extends Object
    Represents configuration property.

    • Method Detail

      • isShared

        public boolean isShared()
        Returns true if property can be shared between clients and Configuration.get(ConfigurationProperty) should look for it in per-client and root sections.
        Returns:
        flag indicating if the property is shared.

      • getValueSanitizer

        public Function<String,​String> getValueSanitizer()
        Returns property value sanitizer that is used to securely log property value.
        Returns:
        function that sanitizes property value.

      • isRequired

        public boolean isRequired()
        Returns true if property is required, used for validation purposes.
        Returns:
        flag indicating if the property is required.

      • getName

        public String getName()
        Gets full property name including relative path to it.
        Returns:
        property name.

      • getConverter

        public Function<String,​T> getConverter()
        Gets converter for property value.
        Returns:
        property value converter.

      • getDefaultValue

        public T getDefaultValue()
        Gets property default value to be used when property is missing in the configuration.
        Returns:
        default value.

      • getAliases

        public Iterable<String> getAliases()
        Gets property aliases - alternative names property can have.
        Returns:
        array of name aliases.

      • getEnvironmentVariableName

        public String getEnvironmentVariableName()
        Gets name of environment variables this property can be configured with.
        Returns:
        environment variable name.

      • getSystemPropertyName

        public String getSystemPropertyName()
        Gets name of system property this property can be configured with.
        Returns:
        system property name.