io.mongock.runner.core.builder.roles

Interface ChangeLogScanner<SELF extends ChangeLogScanner<SELF,CONFIG>,CONFIG extends MongockConfiguration>

All Superinterfaces:

Configurable<SELF,CONFIG>, SelfInstanstiator<SELF>

All Known Subinterfaces:

RunnerBuilder<SELF,CONFIG>

public interface ChangeLogScanner<SELF extends ChangeLogScanner<SELF,CONFIG>,CONFIG extends MongockConfiguration>
extends Configurable<SELF,CONFIG>, SelfInstanstiator<SELF>

Method Summary

Modifier and Type	Method and Description
default SELF	addChangeLogClass(Class<?> clazz) Deprecated.
default SELF	addChangeLogClasses(List<Class<?>> classes) Deprecated.
default SELF	addChangeLogsScanPackage(String migrationScanPackage) Deprecated.
default SELF	addChangeLogsScanPackages(List<String> migrationScanPackageList) Deprecated.
default SELF	addMigrationClass(Class<?> clazz) Adds a class to be scanned to the list.
default SELF	addMigrationClasses(List<Class<?>> classes) Adds a list of classes to be scanned to the list.
default SELF	addMigrationScanPackage(String migrationScanPackage) Adds a package to be scanned to the list.
default SELF	addMigrationScanPackages(List<String> migrationScanPackageList) Adds a list of packages to be scanned to the list.
SELF	setChangeLogInstantiator(Function<Class<?>,Object> changeLogInstantiator) Deprecated.
default SELF	setDefaultMigrationAuthor(String defaultMigrationAuthor) Sets the default migration author to be used when a changeLog doesn't provide author.

Methods inherited from interface io.mongock.runner.core.builder.roles.Configurable

getConfig, getType, getVersion, setConfig

Methods inherited from interface io.mongock.runner.core.builder.roles.SelfInstanstiator

getInstance

Method Detail

setDefaultMigrationAuthor

default SELF setDefaultMigrationAuthor(String defaultMigrationAuthor)

Sets the default migration author to be used when a changeLog doesn't provide author.

Parameters:

defaultMigrationAuthor - the default author

Returns:

builder for fluent interface

addMigrationScanPackages

default SELF addMigrationScanPackages(List<String> migrationScanPackageList)

Adds a list of packages to be scanned to the list. Mongock allows multiple classes and packages Requires at least one package

Parameters:

migrationScanPackageList - list of packages to be scanned

Returns:

builder for fluent interface

addMigrationScanPackage

default SELF addMigrationScanPackage(String migrationScanPackage)

Adds a package to be scanned to the list. Mongock allows multiple classes and packages Requires at least one package

Parameters:

migrationScanPackage - package to be scanned

Returns:

builder for fluent interface

addMigrationClasses

default SELF addMigrationClasses(List<Class<?>> classes)

Adds a list of classes to be scanned to the list. Mongock allows multiple classes and packages Requires at least one class

Parameters:

classes - list of classes to be scanned

Returns:

builder for fluent interface

addMigrationClass

default SELF addMigrationClass(Class<?> clazz)

Adds a class to be scanned to the list. Mongock allows multiple classes and packages Requires at least one package

Parameters:

clazz - package to be scanned

Returns:

builder for fluent interface

setChangeLogInstantiator

@Deprecated
SELF setChangeLogInstantiator(Function<Class<?>,Object> changeLogInstantiator)

Deprecated.

Sets a function that will be used to instantiate ChangeLog classes. If unset, Class.getConstructor().newInstance() will be used Deprecated: In future versions will be ignored. Internal 'instantiator' will be sued instead, passing parameters from the context in the constructor(first found). In the current version(5), only we used for changeLogs used on changeLogs based on annotations.

Parameters:

changeLogInstantiator - the function that will create an instance of a class

Returns:

builder for fluent interface

addChangeLogsScanPackages

@Deprecated
default SELF addChangeLogsScanPackages(List<String> migrationScanPackageList)

Deprecated.

Deprecated. Use addMigrationScanPackages instead

addChangeLogsScanPackage

@Deprecated
default SELF addChangeLogsScanPackage(String migrationScanPackage)

Deprecated.

Deprecated. Use addMigrationScanPackage instead

addChangeLogClasses

@Deprecated
default SELF addChangeLogClasses(List<Class<?>> classes)

Deprecated.

Deprecated. Use addMigrationClasses instead

addChangeLogClass

@Deprecated
default SELF addChangeLogClass(Class<?> clazz)

Deprecated.

Deprecated. Use addMigrationClass instead