Package liquibase.command

Class CommandFactory

java.lang.Object

liquibase.command.CommandFactory

All Implemented Interfaces:

SingletonObject

public class CommandFactory
extends Object
implements SingletonObject

Manages the command related implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CommandFactory()

Method Summary

Modifier and Type	Method	Description
<T extends CommandResult> T	execute(LiquibaseCommand<T> command)	Deprecated. Use CommandScope.execute()
LiquibaseCommand	getCommand(String commandName)	Deprecated. use getCommandDefinition(String...)
CommandDefinition	getCommandDefinition(String... commandName)	Returns the complete CommandDefinition for the given commandName.
SortedSet<CommandDefinition>	getCommands(boolean includeInternal)	Returns all known CommandDefinitions.
static CommandFactory	getInstance()
protected void	register(String[] commandName, CommandArgumentDefinition<?> definition)	Called by CommandArgumentDefinition.Building.build() to register that a particular CommandArgumentDefinition is available for a command.
void	resetCommandDefinitions()	Reset the COMMAND_DEFINITIONS cache.
protected void	unregister(String[] commandName)	Unregisters all information about the given CommandStep.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandFactory

protected CommandFactory()

Method Details

getInstance

public static CommandFactory getInstance()

getCommandDefinition

public CommandDefinition getCommandDefinition(String... commandName)
                                       throws IllegalArgumentException

Returns the complete CommandDefinition for the given commandName.

Throws:

IllegalArgumentException - if the commandName is not known

getCommands

public SortedSet<CommandDefinition> getCommands(boolean includeInternal)

Returns all known CommandDefinitions.

Parameters:

includeInternal - if true, also include commands marked as CommandDefinition.getInternal()

register

protected void register(String[] commandName,
 CommandArgumentDefinition<?> definition)

Called by CommandArgumentDefinition.Building.build() to register that a particular CommandArgumentDefinition is available for a command.

unregister

protected void unregister(String[] commandName)

Unregisters all information about the given CommandStep. <bNOTE: package-protected method used primarily for testing and may be removed or modified in the future.

getCommand

public LiquibaseCommand getCommand(String commandName)

Deprecated.

use getCommandDefinition(String...)

execute

public <T extends CommandResult> T execute(LiquibaseCommand<T> command)
                                    throws CommandExecutionException

Deprecated.

Use CommandScope.execute()

Throws:

CommandExecutionException

resetCommandDefinitions

public void resetCommandDefinitions()

Reset the COMMAND_DEFINITIONS cache. Added for tests.