org.apache.flink.cdc.common.configuration.ConfigOptions Maven / Gradle / Ivy
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 org.apache.flink.cdc.common.configuration;
import org.apache.flink.cdc.common.annotation.PublicEvolving;
import org.apache.flink.cdc.common.configuration.description.Description;
import org.apache.flink.cdc.common.utils.Preconditions;
import java.time.Duration;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
* {@code ConfigOptions} are used to build a {@link ConfigOption}. The option is typically built in
* one of the following pattern:
*
* {@code
* // simple string-valued option with a default value
* ConfigOption tempDirs = ConfigOptions
* .key("tmp.dir")
* .stringType()
* .defaultValue("/tmp");
*
* // simple integer-valued option with a default value
* ConfigOption parallelism = ConfigOptions
* .key("application.parallelism")
* .intType()
* .defaultValue(100);
*
* // option of list of integers with a default value
* ConfigOption parallelism = ConfigOptions
* .key("application.ports")
* .intType()
* .asList()
* .defaultValue(8000, 8001, 8002);
*
* // option with no default value
* ConfigOption userName = ConfigOptions
* .key("user.name")
* .stringType()
* .noDefaultValue();
*
* // option with deprecated keys to check
* ConfigOption threshold = ConfigOptions
* .key("cpu.utilization.threshold")
* .doubleType()
* .defaultValue(0.9)
* .withDeprecatedKeys("cpu.threshold");
* }
*/
@PublicEvolving
public class ConfigOptions {
/**
* Starts building a new {@link ConfigOption}.
*
* @param key The key for the config option.
* @return The builder for the config option with the given key.
*/
public static OptionBuilder key(String key) {
Preconditions.checkNotNull(key);
return new OptionBuilder(key);
}
// ------------------------------------------------------------------------
/**
* The option builder is used to create a {@link ConfigOption}. It is instantiated via {@link
* ConfigOptions#key(String)}.
*/
public static final class OptionBuilder {
/**
* Workaround to reuse the {@link TypedConfigOptionBuilder} for a {@link Map Map<String,
* String>}.
*/
@SuppressWarnings("unchecked")
private static final Class> PROPERTIES_MAP_CLASS =
(Class>) (Class) Map.class;
/** The key for the config option. */
private final String key;
/**
* Creates a new OptionBuilder.
*
* @param key The key for the config option
*/
OptionBuilder(String key) {
this.key = key;
}
/** Defines that the value of the option should be of {@link Boolean} type. */
public TypedConfigOptionBuilder booleanType() {
return new TypedConfigOptionBuilder<>(key, Boolean.class);
}
/** Defines that the value of the option should be of {@link Integer} type. */
public TypedConfigOptionBuilder intType() {
return new TypedConfigOptionBuilder<>(key, Integer.class);
}
/** Defines that the value of the option should be of {@link Long} type. */
public TypedConfigOptionBuilder longType() {
return new TypedConfigOptionBuilder<>(key, Long.class);
}
/** Defines that the value of the option should be of {@link Float} type. */
public TypedConfigOptionBuilder floatType() {
return new TypedConfigOptionBuilder<>(key, Float.class);
}
/** Defines that the value of the option should be of {@link Double} type. */
public TypedConfigOptionBuilder doubleType() {
return new TypedConfigOptionBuilder<>(key, Double.class);
}
/** Defines that the value of the option should be of {@link String} type. */
public TypedConfigOptionBuilder stringType() {
return new TypedConfigOptionBuilder<>(key, String.class);
}
/** Defines that the value of the option should be of {@link Duration} type. */
public TypedConfigOptionBuilder durationType() {
return new TypedConfigOptionBuilder<>(key, Duration.class);
}
/**
* Defines that the value of the option should be of {@link Enum} type.
*
* @param enumClass Concrete type of the expected enum.
*/
public > TypedConfigOptionBuilder enumType(Class enumClass) {
return new TypedConfigOptionBuilder<>(key, enumClass);
}
/**
* Defines that the value of the option should be a set of properties, which can be
* represented as {@code Map}.
*/
public TypedConfigOptionBuilder> mapType() {
return new TypedConfigOptionBuilder<>(key, PROPERTIES_MAP_CLASS);
}
}
/**
* Builder for {@link ConfigOption} with a defined atomic type.
*
* @param atomic type of the option
*/
public static class TypedConfigOptionBuilder {
private final String key;
private final Class clazz;
TypedConfigOptionBuilder(String key, Class clazz) {
this.key = key;
this.clazz = clazz;
}
/** Defines that the option's type should be a list of previously defined atomic type. */
public ListConfigOptionBuilder asList() {
return new ListConfigOptionBuilder<>(key, clazz);
}
/**
* Creates a ConfigOption with the given default value.
*
* @param value The default value for the config option
* @return The config option with the default value.
*/
public ConfigOption defaultValue(T value) {
return new ConfigOption<>(key, clazz, ConfigOption.EMPTY_DESCRIPTION, value, false);
}
/**
* Creates a ConfigOption without a default value.
*
* @return The config option without a default value.
*/
public ConfigOption noDefaultValue() {
return new ConfigOption<>(
key, clazz, Description.builder().text("").build(), null, false);
}
}
/**
* Builder for {@link ConfigOption} of list of type {@link E}.
*
* @param list element type of the option
*/
public static class ListConfigOptionBuilder {
private final String key;
private final Class clazz;
ListConfigOptionBuilder(String key, Class clazz) {
this.key = key;
this.clazz = clazz;
}
/**
* Creates a ConfigOption with the given default value.
*
* @param values The list of default values for the config option
* @return The config option with the default value.
*/
@SafeVarargs
public final ConfigOption> defaultValues(E... values) {
return new ConfigOption<>(
key, clazz, ConfigOption.EMPTY_DESCRIPTION, Arrays.asList(values), true);
}
/**
* Creates a ConfigOption without a default value.
*
* @return The config option without a default value.
*/
public ConfigOption> noDefaultValue() {
return new ConfigOption<>(key, clazz, ConfigOption.EMPTY_DESCRIPTION, null, true);
}
}
// ------------------------------------------------------------------------
/** Not intended to be instantiated. */
private ConfigOptions() {}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy