Top Description Methods
liquibase.change.custom

public Interface CustomChange

Known Direct Subinterfaces
liquibase.change.custom.CustomSqlChange, liquibase.change.custom.CustomTaskChange
Imports
liquibase.database.Database, liquibase.exception.SetupException, .ValidationErrors, liquibase.resource.ResourceAccessor
Interface to implement when creating a custom change. Actual custom changes implementations need to implement CustomSqlChange or CustomTaskChange.

See Also
custom-change for more information.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a String containing the message after the change is executed
getConfirmationMessage()

Confirmation message to be displayed after the change is executed

public void
setFileOpener(ResourceAccessor resourceAccessor)

Sets the fileOpener that should be used for any file loading and resource finding for files that are provided by the user.

public void
setUp()

This method will be called after the no arg constructor and all of the properties have been set to allow the task to do any heavy tasks or more importantly generate any exceptions to report to the user about the settings provided.

public ValidationErrors
validate(Database
The database the change will be ran against
database)

Tests that the change is configured correctly before attempting to execute it.

Method Detail

getConfirmationMessageback to summary
public String getConfirmationMessage()

Confirmation message to be displayed after the change is executed

Returns:String

a String containing the message after the change is executed

setFileOpenerback to summary
public void setFileOpener(ResourceAccessor resourceAccessor)

Sets the fileOpener that should be used for any file loading and resource finding for files that are provided by the user.

setUpback to summary
public void setUp() throws SetupException

This method will be called after the no arg constructor and all of the properties have been set to allow the task to do any heavy tasks or more importantly generate any exceptions to report to the user about the settings provided.

validateback to summary
public ValidationErrors validate(Database database)

Tests that the change is configured correctly before attempting to execute it.

Parameters
database:Database

The database the change will be ran against