com.datastax.oss.driver.internal.core.config.DriverOptionConfigBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of java-driver-core
The newest version!
/*
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 com.datastax.oss.driver.internal.core.config;

import com.datastax.oss.driver.api.core.config.DriverOption;
import edu.umd.cs.findbugs.annotations.CheckReturnValue;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.time.Duration;
import java.util.List;
import java.util.Map;

/** @see com.datastax.oss.driver.internal.core.config.typesafe.DefaultDriverConfigLoaderBuilder */
@Deprecated
public interface DriverOptionConfigBuilder {

  @NonNull
  @CheckReturnValue
  default SelfT withBoolean(@NonNull DriverOption option, boolean value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withBooleanList(@NonNull DriverOption option, @NonNull List value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withInt(@NonNull DriverOption option, int value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withIntList(@NonNull DriverOption option, @NonNull List value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withLong(@NonNull DriverOption option, long value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withLongList(@NonNull DriverOption option, @NonNull List value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withDouble(@NonNull DriverOption option, double value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withDoubleList(@NonNull DriverOption option, @NonNull List value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withString(@NonNull DriverOption option, @NonNull String value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withStringList(@NonNull DriverOption option, @NonNull List value) {
    return with(option, value);
  }

  @SuppressWarnings("unchecked")
  @NonNull
  @CheckReturnValue
  default SelfT withStringMap(@NonNull DriverOption option, @NonNull Map value) {
    SelfT v = (SelfT) this;
    for (String key : value.keySet()) {
      v = (SelfT) v.with(option.getPath() + "." + key, value.get(key));
    }
    return v;
  }

  /**
   * Specifies a size in bytes. This is separate from {@link #withLong(DriverOption, long)}, in case
   * implementations want to allow users to provide sizes in a more human-readable way, for example
   * "256 MB".
   */
  @NonNull
  @CheckReturnValue
  default SelfT withBytes(@NonNull DriverOption option, @NonNull String value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withBytes(@NonNull DriverOption option, long value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withBytesList(@NonNull DriverOption option, @NonNull List value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withDuration(@NonNull DriverOption option, @NonNull Duration value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withDurationList(@NonNull DriverOption option, @NonNull List value) {
    return with(option, value);
  }

  @NonNull
  @CheckReturnValue
  default SelfT withClass(@NonNull DriverOption option, @NonNull Class value) {
    return with(option, value.getName());
  }

  /** Unsets an option. */
  @NonNull
  @CheckReturnValue
  default SelfT without(@NonNull DriverOption option) {
    return with(option, null);
  }

  @NonNull
  @CheckReturnValue
  default SelfT with(@NonNull DriverOption option, @Nullable Object value) {
    return with(option.getPath(), value);
  }

  /**
   * Provides a simple path to value mapping, all default methods invoke this method directly. It is
   * not recommended that it is used directly other than by these defaults.
   */
  @NonNull
  @CheckReturnValue
  SelfT with(@NonNull String path, @Nullable Object value);
}