liquibase.change.custom.CustomChange Interface Reference

Inheritance diagram for liquibase.change.custom.CustomChange:
[legend]

List of all members.


Detailed Description

Interface to implement when creating a custom change.

Actual custom changes implementations need to implement CustomSqlChange or CustomTaskChange.

See http://www.liquibase.org/manual/custom_refactoring_class for more information.

Definition at line 14 of file CustomChange.java.


Public Member Functions

String getConfirmationMessage ()
 Confirmation message to be displayed after the change is executed.
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.
void setFileOpener (FileOpener fileOpener)
 Sets the fileOpener that should be used for any file loading and resource finding for files that are provided by the user.
void validate (Database database) throws InvalidChangeDefinitionException
 Tests that the change is configured correctly before attempting to execute it.

Member Function Documentation

String liquibase.change.custom.CustomChange.getConfirmationMessage (  ) 

Confirmation message to be displayed after the change is executed.

Returns:
a String containing the message after the change is executed

Referenced by liquibase.change.custom.CustomChangeWrapper.getConfirmationMessage().

void liquibase.change.custom.CustomChange.validate ( Database  database  )  throws InvalidChangeDefinitionException

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

Parameters:
database The database the change will be ran against


The documentation for this interface was generated from the following file:

doxygen