Package com.clickhouse.config

Class ClickHouseDefaultOption

java.lang.Object

com.clickhouse.config.ClickHouseDefaultOption

All Implemented Interfaces:

ClickHouseOption, Serializable

public final class ClickHouseDefaultOption
extends Object
implements ClickHouseOption

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClickHouseDefaultOption(String name, T defaultValue)
ClickHouseDefaultOption(String name, T defaultValue, boolean sensitive)

Method Summary

Modifier and Type	Method	Description
Serializable	getDefaultValue()	Gets default value of the option.
String	getDescription()	Gets description of the option.
String	getKey()	Gets key of the option.
Class<? extends Serializable>	getValueType()	Gets value type of the option.
boolean	isSensitive()	Checks whether the option is sensitive or not.
String	name()	Gets name of the option.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.clickhouse.config.ClickHouseOption

getDefaultValueFromEnvVar, getDefaultValueFromSysProp, getEffectiveDefaultValue, getEffectiveValue, getEnvironmentVariable, getPrefix, getSystemProperty

Constructor Details

ClickHouseDefaultOption

public ClickHouseDefaultOption(String name,
 T defaultValue)

ClickHouseDefaultOption

public ClickHouseDefaultOption(String name,
 T defaultValue,
 boolean sensitive)

Method Details

getDefaultValue

public Serializable getDefaultValue()

Description copied from interface: ClickHouseOption

Gets default value of the option.

Specified by:

getDefaultValue in interface ClickHouseOption

Returns:

default value of the option

getDescription

public String getDescription()

Description copied from interface: ClickHouseOption

Gets description of the option.

Specified by:

getDescription in interface ClickHouseOption

Returns:

description of the option

getKey

public String getKey()

Description copied from interface: ClickHouseOption

Gets key of the option.

Specified by:

getKey in interface ClickHouseOption

Returns:

key of the option

getValueType

public Class<? extends Serializable> getValueType()

Description copied from interface: ClickHouseOption

Gets value type of the option.

Specified by:

getValueType in interface ClickHouseOption

Returns:

value type of the option, defaults to String

isSensitive

public boolean isSensitive()

Description copied from interface: ClickHouseOption

Checks whether the option is sensitive or not. A sensitive option should be used carefully and be masked in logging for security reason.

Specified by:

isSensitive in interface ClickHouseOption

Returns:

true if the option is sensitive; false otherwise

name

public String name()

Description copied from interface: ClickHouseOption

Gets name of the option.

Specified by:

name in interface ClickHouseOption

Returns:

name of the option