Package liquibase.command

Class CommandArgumentDefinition.Building<DataType>

java.lang.Object

liquibase.command.CommandArgumentDefinition.Building<DataType>

Enclosing class:

CommandArgumentDefinition<DataType>

public static class CommandArgumentDefinition.Building<DataType>
extends Object

A new CommandArgumentDefinition under construction from CommandBuilder

Method Summary

Modifier and Type	Method	Description
CommandArgumentDefinition.Building<DataType>	addAlias(String alias)	Adds an alias for this command argument; an alias added this way is not shown in the help output.
CommandArgumentDefinition.Building<DataType>	addForcePrintAlias(String alias)	Adds an alias for this command argument that will be printed to the help output inline with the existing parameter (for which this is an alias).
CommandArgumentDefinition<DataType>	build()	Complete construction and register the definition with the rest of the system.
CommandArgumentDefinition.Building<DataType>	defaultValue(DataType defaultValue)	Convenience version of defaultValue(Object, String) but using String.valueOf(Object) for the description.
CommandArgumentDefinition.Building<DataType>	defaultValue(DataType defaultValue, String description)	Set the default value for this argument as well as the description of the default value.
CommandArgumentDefinition.Building<DataType>	description(String description)	Add a description
CommandArgumentDefinition.Building<DataType>	hidden()	Mark argument as hidden.
CommandArgumentDefinition.Building<DataType>	optional()	Mark argument as optional.
CommandArgumentDefinition.Building<DataType>	required()	Mark argument as required.
CommandArgumentDefinition.Building<DataType>	setValueHandler(ConfigurationValueConverter<DataType> valueHandler)	Set the #getValueConverter() to use.
CommandArgumentDefinition.Building<DataType>	setValueObfuscator(ConfigurationValueObfuscator<DataType> valueObfuscator)	Set the #getValueObfuscator() to use.
CommandArgumentDefinition.Building<DataType>	supersededBy(CommandArgumentDefinition<?> commandArgumentDefinition)	Specifies a CommandArgument that can replace this one if it is not available.

Methods inherited from class java.lang.Object

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

Method Details

required

public CommandArgumentDefinition.Building<DataType> required()

Mark argument as required.

See Also:

• optional()

supersededBy

public CommandArgumentDefinition.Building<DataType> supersededBy(CommandArgumentDefinition<?> commandArgumentDefinition)

Specifies a CommandArgument that can replace this one if it is not available.

optional

public CommandArgumentDefinition.Building<DataType> optional()

Mark argument as optional.

See Also:

• required()

hidden

public CommandArgumentDefinition.Building<DataType> hidden()

Mark argument as hidden.

description

public CommandArgumentDefinition.Building<DataType> description(String description)

Add a description

defaultValue

public CommandArgumentDefinition.Building<DataType> defaultValue(DataType defaultValue,
 String description)

Set the default value for this argument as well as the description of the default value.

defaultValue

public CommandArgumentDefinition.Building<DataType> defaultValue(DataType defaultValue)

Convenience version of defaultValue(Object, String) but using String.valueOf(Object) for the description.

setValueHandler

public CommandArgumentDefinition.Building<DataType> setValueHandler(ConfigurationValueConverter<DataType> valueHandler)

Set the #getValueConverter() to use.

setValueObfuscator

public CommandArgumentDefinition.Building<DataType> setValueObfuscator(ConfigurationValueObfuscator<DataType> valueObfuscator)

Set the #getValueObfuscator() to use.

addAlias

public CommandArgumentDefinition.Building<DataType> addAlias(String alias)

Adds an alias for this command argument; an alias added this way is not shown in the help output.

addForcePrintAlias

public CommandArgumentDefinition.Building<DataType> addForcePrintAlias(String alias)

Adds an alias for this command argument that will be printed to the help output inline with the existing parameter (for which this is an alias).

build

public CommandArgumentDefinition<DataType> build()
                                          throws IllegalArgumentException

Complete construction and register the definition with the rest of the system.

Throws:

IllegalArgumentException - is an invalid configuration was specified