hadoop-tools/hadoop-azure/src/main/java/org/apache/hadoop/fs/azurebfs/diagnostics/LongConfigurationBasicValidator.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.fs.azurebfs.diagnostics;

import org.apache.hadoop.classification.InterfaceStability;
import org.apache.hadoop.fs.azurebfs.contracts.diagnostics.ConfigurationValidator;
import org.apache.hadoop.fs.azurebfs.contracts.exceptions.InvalidConfigurationValueException;

/**
 * Long configuration value Validator.
 */
@InterfaceStability.Evolving
public class LongConfigurationBasicValidator extends ConfigurationBasicValidator<Long> implements ConfigurationValidator {
  private final long min;
  private final long max;

  public LongConfigurationBasicValidator(final long min, final long max, final long defaultVal, final String configKey, final boolean throwIfInvalid) {
    super(configKey, defaultVal, throwIfInvalid);
    this.min = min;
    this.max = max;
  }

  public Long validate(final String configValue) throws InvalidConfigurationValueException {
    Long result = super.validate(configValue);
    if (result != null) {
      return result;
    }

    try {
      result = Long.parseLong(configValue);
      // throw an exception if a 'within bounds' value is missing
      if (getThrowIfInvalid() && (result < this.min || result > this.max)) {
        throw new InvalidConfigurationValueException(getConfigKey());
      }

      // set the value to the nearest bound if it's out of bounds
      if (result < this.min) {
        return this.min;
      } else if (result > this.max) {
        return this.max;
      }
    } catch (NumberFormatException ex) {
      throw new InvalidConfigurationValueException(getConfigKey(), ex);
    }

    return result;
  }
}