Package org.apache.hadoop.fs.azurebfs.diagnostics

Class BooleanConfigurationBasicValidator

java.lang.Object

org.apache.hadoop.fs.azurebfs.diagnostics.BooleanConfigurationBasicValidator

All Implemented Interfaces:

org.apache.hadoop.fs.azurebfs.contracts.diagnostics.ConfigurationValidator

@Public
@Evolving
public class BooleanConfigurationBasicValidator
extends Object

Boolean configuration value validator.

Constructor Summary

Constructors

Constructor	Description
BooleanConfigurationBasicValidator(String configKey, boolean defaultVal, boolean throwIfInvalid)

Method Summary

Modifier and Type	Method	Description
String	getConfigKey()
Boolean	getDefaultVal()
boolean	getThrowIfInvalid()
Boolean	validate(String configValue)	This method handles the base case where the configValue is null, based on the throwIfInvalid it either throws or returns the defaultVal, otherwise it returns null indicating that the configValue needs to be validated further.

Methods inherited from class java.lang.Object

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

Constructor Details

BooleanConfigurationBasicValidator

public BooleanConfigurationBasicValidator(String configKey,
 boolean defaultVal,
 boolean throwIfInvalid)

Method Details

validate

public Boolean validate(String configValue)
                 throws InvalidConfigurationValueException

This method handles the base case where the configValue is null, based on the throwIfInvalid it either throws or returns the defaultVal, otherwise it returns null indicating that the configValue needs to be validated further.

Specified by:

validate in interface org.apache.hadoop.fs.azurebfs.contracts.diagnostics.ConfigurationValidator

Parameters:

configValue - the configuration value set by the user

Returns:

the defaultVal in case the configValue is null and not required to be set, null in case the configValue not null

Throws:

InvalidConfigurationValueException - in case the configValue is null and required to be set

getDefaultVal

public Boolean getDefaultVal()

getConfigKey

public String getConfigKey()

getThrowIfInvalid

public boolean getThrowIfInvalid()