Package liquibase.util

Class ShowSummaryUtil

java.lang.Object

liquibase.util.ShowSummaryUtil

public class ShowSummaryUtil
extends Object

Methods to show a summary of change set counts after an update

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShowSummaryUtil.ShouldNotCountAsSkipChangesetFilter	Internal use only filter.

Constructor Summary

Constructors

Constructor	Description
ShowSummaryUtil()

Method Summary

Modifier and Type	Method	Description
static UpdateSummaryDetails	buildSummaryDetails(DatabaseChangeLog changeLog, UpdateSummaryEnum showSummary, UpdateSummaryOutputEnum showSummaryOutput, StatusVisitor statusVisitor, OutputStream outputStream, ChangeLogIterator runChangeLogIterator)	Deprecated. use buildSummaryDetails(DatabaseChangeLog, UpdateSummaryEnum, UpdateSummaryOutputEnum, StatusVisitor, OutputStream, ChangeLogIterator, ChangeExecListener) instead.
static UpdateSummaryDetails	buildSummaryDetails(DatabaseChangeLog changeLog, UpdateSummaryEnum showSummary, UpdateSummaryOutputEnum showSummaryOutput, StatusVisitor statusVisitor, OutputStream outputStream, ChangeLogIterator runChangeLogIterator, ChangeExecListener changeExecListener)	Show a summary of the changesets which were executed AND return an object with the records of what has happened.
static void	showUpdateSummary(DatabaseChangeLog changeLog, UpdateSummaryEnum showSummary, UpdateSummaryOutputEnum showSummaryOutput, StatusVisitor statusVisitor, OutputStream outputStream)	Deprecated.
static void	showUpdateSummary(DatabaseChangeLog changeLog, UpdateSummaryEnum showSummary, UpdateSummaryOutputEnum showSummaryOutput, StatusVisitor statusVisitor, OutputStream outputStream, ChangeLogIterator runChangeLogIterator)	Show a summary of the changesets which were executed

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowSummaryUtil

public ShowSummaryUtil()

Method Detail

showUpdateSummary

@Deprecated
public static void showUpdateSummary(DatabaseChangeLog changeLog,
                                     UpdateSummaryEnum showSummary,
                                     UpdateSummaryOutputEnum showSummaryOutput,
                                     StatusVisitor statusVisitor,
                                     OutputStream outputStream)
                              throws LiquibaseException,
                                     IOException

Deprecated.

Show a summary of the changesets which were executed

Parameters:

changeLog - The changelog used in this update

showSummary - Flag to control whether or not we show the summary

showSummaryOutput - Flag to control where we show the summary

statusVisitor - The StatusVisitor used to determine statuses

outputStream - The OutputStream to use for the summary

Throws:

LiquibaseException - Thrown by this method

IOException - Thrown by this method

showUpdateSummary

public static void showUpdateSummary(DatabaseChangeLog changeLog,
                                     UpdateSummaryEnum showSummary,
                                     UpdateSummaryOutputEnum showSummaryOutput,
                                     StatusVisitor statusVisitor,
                                     OutputStream outputStream,
                                     ChangeLogIterator runChangeLogIterator)
                              throws LiquibaseException,
                                     IOException

Show a summary of the changesets which were executed

Parameters:

changeLog - The changelog used in this update

showSummary - Flag to control whether or not we show the summary

showSummaryOutput - Flag to control where we show the summary

statusVisitor - The StatusVisitor used to determine statuses

outputStream - The OutputStream to use for the summary

Throws:

LiquibaseException - Thrown by this method

IOException - Thrown by this method

buildSummaryDetails

@Deprecated
public static UpdateSummaryDetails buildSummaryDetails(DatabaseChangeLog changeLog,
                                                       UpdateSummaryEnum showSummary,
                                                       UpdateSummaryOutputEnum showSummaryOutput,
                                                       StatusVisitor statusVisitor,
                                                       OutputStream outputStream,
                                                       ChangeLogIterator runChangeLogIterator)
                                                throws LiquibaseException,
                                                       IOException

Deprecated.

use buildSummaryDetails(DatabaseChangeLog, UpdateSummaryEnum, UpdateSummaryOutputEnum, StatusVisitor, OutputStream, ChangeLogIterator, ChangeExecListener) instead.

Show a summary of the changesets which were executed AND return an object with the records of what has happened.

Parameters:

changeLog - The changelog used in this update

showSummary - Flag to control whether we show the summary

showSummaryOutput - Flag to control where we show the summary

statusVisitor - The StatusVisitor used to determine statuses

outputStream - The OutputStream to use for the summary

Returns:

the details of the update summary

Throws:

LiquibaseException - Thrown by this method

IOException - Thrown by this method

buildSummaryDetails

public static UpdateSummaryDetails buildSummaryDetails(DatabaseChangeLog changeLog,
                                                       UpdateSummaryEnum showSummary,
                                                       UpdateSummaryOutputEnum showSummaryOutput,
                                                       StatusVisitor statusVisitor,
                                                       OutputStream outputStream,
                                                       ChangeLogIterator runChangeLogIterator,
                                                       ChangeExecListener changeExecListener)
                                                throws LiquibaseException,
                                                       IOException

Show a summary of the changesets which were executed AND return an object with the records of what has happened.

Parameters:

changeLog - The changelog used in this update

showSummary - Flag to control whether we show the summary

showSummaryOutput - Flag to control where we show the summary

statusVisitor - The StatusVisitor used to determine statuses

outputStream - The OutputStream to use for the summary

changeExecListener -

Returns:

the details of the update summary

Throws:

LiquibaseException - Thrown by this method

IOException - Thrown by this method