Package liquibase.configuration

Class ConfigurationDefinition.Building<DataType>

java.lang.Object

liquibase.configuration.ConfigurationDefinition.Building<DataType>

Enclosing class:

ConfigurationDefinition<DataType>

public static class ConfigurationDefinition.Building<DataType>
extends Object

Method Summary

Modifier and Type	Method	Description
ConfigurationDefinition.Building<DataType>	addAliases(Collection<String> aliases)
ConfigurationDefinition.Building<DataType>	addAliasKey(String alias)
ConfigurationDefinition<DataType>	build()	Finishes building this definition AND registers it with LiquibaseConfiguration.registerDefinition(ConfigurationDefinition).
ConfigurationDefinition<DataType>	buildTemporary()	Finishes building this definition WITHOUT registering it with LiquibaseConfiguration.registerDefinition(ConfigurationDefinition).
ConfigurationDefinition.Building<DataType>	referenceScoped()	Marks this definition reference-scopable: while the reference connection of a two-connection command (e.g.
ConfigurationDefinition.Building<DataType>	setCommonlyUsed(boolean commonlyUsed)
ConfigurationDefinition.Building<DataType>	setDefaultValue(DataType defaultValue)
ConfigurationDefinition.Building<DataType>	setDefaultValue(DataType defaultValue, String defaultValueDescription)
ConfigurationDefinition.Building<DataType>	setDescription(String description)
ConfigurationDefinition.Building<DataType>	setHidden(boolean hidden)
ConfigurationDefinition.Building<DataType>	setInternal(boolean internal)
ConfigurationDefinition.Building<DataType>	setValueHandler(ConfigurationValueConverter<DataType> handler)
ConfigurationDefinition.Building<DataType>	setValueObfuscator(ConfigurationValueObfuscator<DataType> handler)

Methods inherited from class java.lang.Object

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

Method Details

addAliasKey

public ConfigurationDefinition.Building<DataType> addAliasKey(String alias)

setDescription

public ConfigurationDefinition.Building<DataType> setDescription(String description)

setDefaultValue

public ConfigurationDefinition.Building<DataType> setDefaultValue(DataType defaultValue,
 String defaultValueDescription)

setDefaultValue

public ConfigurationDefinition.Building<DataType> setDefaultValue(DataType defaultValue)

setValueHandler

public ConfigurationDefinition.Building<DataType> setValueHandler(ConfigurationValueConverter<DataType> handler)

setValueObfuscator

public ConfigurationDefinition.Building<DataType> setValueObfuscator(ConfigurationValueObfuscator<DataType> handler)

setCommonlyUsed

public ConfigurationDefinition.Building<DataType> setCommonlyUsed(boolean commonlyUsed)

setInternal

public ConfigurationDefinition.Building<DataType> setInternal(boolean internal)

setHidden

public ConfigurationDefinition.Building<DataType> setHidden(boolean hidden)

referenceScoped

public ConfigurationDefinition.Building<DataType> referenceScoped()

Marks this definition reference-scopable: while the reference connection of a two-connection command (e.g. diff) is opening, it resolves from its <namespace>.reference.<suffix> sibling instead of the primary key. An unset sibling inherits the primary value; a sibling of ConfigurationDefinition.REFERENCE_DEFAULT_SENTINEL opts out (resolves as if unset). No effect on single-connection commands or the primary connection.

Caveats: the reference value resolves only while the reference connection is opening, so read it synchronously in DatabaseConnection.open(...) (a later/async read sees the primary value); only the canonical key is scoped, not aliases; and it does not apply to auth activated by the credential value itself (e.g. a referencePassword resolved by a ConfiguredValueModifier), which is already per-connection. Intended for String-typed selectors: the ConfigurationDefinition.REFERENCE_DEFAULT_SENTINEL opt-out is matched on the raw sibling value before type conversion, so a non-String DataType (e.g. an enum) would not see the sentinel honored.

addAliases

public ConfigurationDefinition.Building<DataType> addAliases(Collection<String> aliases)

build

public ConfigurationDefinition<DataType> build()

Finishes building this definition AND registers it with LiquibaseConfiguration.registerDefinition(ConfigurationDefinition). To not register this definition, use buildTemporary()

buildTemporary

public ConfigurationDefinition<DataType> buildTemporary()

Finishes building this definition WITHOUT registering it with LiquibaseConfiguration.registerDefinition(ConfigurationDefinition). To automatically register this definition, use build()