ConfigOption (Paimon : Common 0.7.0-incubating API)

java.lang.Object
- org.apache.paimon.options.ConfigOption<T>

类型参数:

T - The type of value associated with the configuration option.
```
@Public
public class ConfigOption<T>
extends Object
```
A ConfigOption describes a configuration parameter. It encapsulates the configuration key, deprecated older versions of the key, and an optional default value for the configuration parameter.
ConfigOptions are built via the ConfigOptions class. Once created, a config option is immutable.

从以下版本开始:

0.4.0

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`T`	`defaultValue()` Returns the default value, or null, if there is no default value.
`Iterable<String>`	`deprecatedKeys()` 已过时。 Replaced by `fallbackKeys()`
`Description`	`description()` Returns the description of this option.
`boolean`	`equals(Object o)`
`Iterable<FallbackKey>`	`fallbackKeys()` Gets the fallback keys, in the order to be checked.
`boolean`	`hasDefaultValue()` Checks if this option has a default value.
`boolean`	`hasDeprecatedKeys()` 已过时。 Replaced by `hasFallbackKeys()`
`boolean`	`hasFallbackKeys()` Checks whether this option has fallback keys.
`int`	`hashCode()`
`String`	`key()` Gets the configuration key.
`String`	`toString()`
`ConfigOption<T>`	`withDeprecatedKeys(String... deprecatedKeys)` Creates a new config option, using this option's key and default value, and adding the given deprecated keys.
`ConfigOption<T>`	`withDescription(Description description)` Creates a new config option, using this option's key and default value, and adding the given description.
`ConfigOption<T>`	`withDescription(String description)` Creates a new config option, using this option's key and default value, and adding the given description.
`ConfigOption<T>`	`withFallbackKeys(String... fallbackKeys)` Creates a new config option, using this option's key and default value, and adding the given fallback keys.

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 方法详细资料
  - withFallbackKeys
```
public ConfigOption<T> withFallbackKeys(String... fallbackKeys)
```
    Creates a new config option, using this option's key and default value, and adding the given fallback keys.
    When obtaining a value from the configuration via Options.get(ConfigOption), the fallback keys will be checked in the order provided to this method. The first key for which a value is found will be used - that value will be returned.
    
    参数:
    
    fallbackKeys - The fallback keys, in the order in which they should be checked.
    
    返回:
    
    A new config options, with the given fallback keys.
  - withDeprecatedKeys
```
public ConfigOption<T> withDeprecatedKeys(String... deprecatedKeys)
```
    Creates a new config option, using this option's key and default value, and adding the given deprecated keys.
    When obtaining a value from the configuration via Options.get(ConfigOption), the deprecated keys will be checked in the order provided to this method. The first key for which a value is found will be used - that value will be returned.
    
    参数:
    
    deprecatedKeys - The deprecated keys, in the order in which they should be checked.
    
    返回:
    
    A new config options, with the given deprecated keys.
  - withDescription
```
public ConfigOption<T> withDescription(String description)
```
    Creates a new config option, using this option's key and default value, and adding the given description. The given description is used when generation the configuration documentation.
    
    参数:
    
    description - The description for this option.
    
    返回:
    
    A new config option, with given description.
  - withDescription
```
public ConfigOption<T> withDescription(Description description)
```
    Creates a new config option, using this option's key and default value, and adding the given description. The given description is used when generation the configuration documentation.
    
    参数:
    
    description - The description for this option.
    
    返回:
    
    A new config option, with given description.
  - key
```
public String key()
```
    Gets the configuration key.
    
    返回:
    
    The configuration key
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
    Checks if this option has a default value.
    
    返回:
    
    True if it has a default value, false if not.
  - defaultValue
```
public T defaultValue()
```
    Returns the default value, or null, if there is no default value.
    
    返回:
    
    The default value, or null.
  - hasDeprecatedKeys
```
@Deprecated
public boolean hasDeprecatedKeys()
```
    已过时。 Replaced by hasFallbackKeys()
    
    Checks whether this option has deprecated keys.
    
    返回:
    
    True if the option has deprecated keys, false if not.
  - deprecatedKeys
```
@Deprecated
public Iterable<String> deprecatedKeys()
```
    已过时。 Replaced by fallbackKeys()
    
    Gets the deprecated keys, in the order to be checked.
    
    返回:
    
    The option's deprecated keys.
  - hasFallbackKeys
```
public boolean hasFallbackKeys()
```
    Checks whether this option has fallback keys.
    
    返回:
    
    True if the option has fallback keys, false if not.
  - fallbackKeys
```
public Iterable<FallbackKey> fallbackKeys()
```
    Gets the fallback keys, in the order to be checked.
    
    返回:
    
    The option's fallback keys.
  - description
```
public Description description()
```
    Returns the description of this option.
    
    返回:
    
    The option's description.
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 ConfigOption<T>

方法概要

从类继承的方法 java.lang.Object

方法详细资料

withFallbackKeys

withDeprecatedKeys

withDescription

withDescription

key

hasDefaultValue

defaultValue

hasDeprecatedKeys

deprecatedKeys

hasFallbackKeys

fallbackKeys

description

equals

hashCode

toString