Liquibase 4.26.0 · liquibase.snapshot.SnapshotControl

Modifier and Type	Field and Description
private ObjectChangeFilter	objectChangeFilter
private SnapshotListener	snapshotListener
private Set<Class<? extends DatabaseObject>>	types
private boolean	warnIfObjectNotFound

Constructor Summary

Access	Constructor and Description
public	SnapshotControl(Database the DBMS for which snapshots should be generated database) Create a SnapshotControl for a given database and mark the database's standard types for inclusion.
public	SnapshotControl(Database the DBMS for which snapshots should be generated database, Class<? extends DatabaseObject>... the list of object types to be included in the snapshot types) Create a Snapshot control for a given database, but explicitly set the object types to be included in snapshots.
public	SnapshotControl(Database database, boolean expandTypesIfNeeded, Class<? extends DatabaseObject>... types)
public	SnapshotControl(Database the DBMS for which snapshots should be generated database, String the list of object types to be included in the snapshot, separated by commas types) Create a Snapshot control for a given database, but explicitly set the object types to be included in snapshots.
public	SnapshotControl(Database database, ObjectChangeFilter objectChangeFilter, Class<? extends DatabaseObject>... types)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the type was added to the list, false if it was already present. addType(Class<? extends DatabaseObject> The type to be added type, Database The database to check for any dependent types that need to be included as well database) Adds a new DatabaseObject type to the list of object types to be included in snapshots.
public String	getSerializableFieldNamespace(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldNamespace.
public Set<String>	getSerializableFields() Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields.
public LiquibaseSerializable.SerializationType	getSerializableFieldType(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.
public Object	getSerializableFieldValue(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.
public String	getSerializedObjectName() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName.
public String	getSerializedObjectNamespace() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public SnapshotListener	getSnapshotListener()
public Set<Class<? extends DatabaseObject>>	Returns: the set of currently registered types getTypesToInclude() Return the types to be included in snapshots
public boolean	Returns: true if WARNINGs should be emitted (default), false if not. isWarnIfObjectNotFound() Returns if the code should log a LogLevel.WARNING message if the object to be snapshotted could not be found.
public void	load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Implements liquibase.serializer.LiquibaseSerializable.load.
public ParsedNode	serialize() Implements liquibase.serializer.LiquibaseSerializable.serialize.
public void	setSnapshotListener(SnapshotListener snapshotListener)
private void	setTypes(Set<Class<? extends DatabaseObject>> types, Database database)
public SnapshotControl	setWarnIfObjectNotFound(boolean true if a warning should emitted (default value), false if not. warnIfObjectNotFound) Configures the code to log a LogLevel.WARNING message if the object to be snapshotted could not be found.
public boolean	Returns: true if that type is registered for inclusion, false if not shouldInclude(Class<? extends DatabaseObject> the DatabaseObject type to be checked type) Queries the currently registered list of types to be included and returns true if the given type is in that list
public <T extends DatabaseObject> boolean	shouldInclude(T example)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

objectChangeFilter	back to summary
private ObjectChangeFilter objectChangeFilter

snapshotListener	back to summary
private SnapshotListener snapshotListener

types	back to summary
private Set<Class<? extends DatabaseObject>> types

warnIfObjectNotFound	back to summary
private boolean warnIfObjectNotFound

Constructor Detail

SnapshotControl	back to summary
public SnapshotControl(Database database) Create a SnapshotControl for a given database and mark the database's standard types for inclusion. Parameters database:Database the DBMS for which snapshots should be generated

SnapshotControl

back to summary

public SnapshotControl(Database database)

Create a SnapshotControl for a given database and mark the database's standard types for inclusion.

Parameters

database:Database: the DBMS for which snapshots should be generated

SnapshotControl	back to summary
public SnapshotControl(Database database, Class<? extends DatabaseObject>... types) Create a Snapshot control for a given database, but explicitly set the object types to be included in snapshots. Parameters database:Database the DBMS for which snapshots should be generated types:Class<? extends DatabaseObject>[] the list of object types to be included in the snapshot Annotations @SafeVarargs

SnapshotControl

back to summary

public SnapshotControl(Database database, Class<? extends DatabaseObject>... types)

Create a Snapshot control for a given database, but explicitly set the object types to be included in snapshots.

Parameters

database:Database: the DBMS for which snapshots should be generated
types:Class<? extends DatabaseObject>[]: the list of object types to be included in the snapshot

Annotations

@SafeVarargs

SnapshotControl	back to summary
public SnapshotControl(Database database, boolean expandTypesIfNeeded, Class<? extends DatabaseObject>... types) Annotations @SafeVarargs

SnapshotControl	back to summary
public SnapshotControl(Database database, String types) Create a Snapshot control for a given database, but explicitly set the object types to be included in snapshots. Parameters database:Database the DBMS for which snapshots should be generated types:String the list of object types to be included in the snapshot, separated by commas

SnapshotControl

back to summary

public SnapshotControl(Database database, String types)

Create a Snapshot control for a given database, but explicitly set the object types to be included in snapshots.

Parameters

database:Database: the DBMS for which snapshots should be generated
types:String: the list of object types to be included in the snapshot, separated by commas

SnapshotControl	back to summary
public SnapshotControl(Database database, ObjectChangeFilter objectChangeFilter, Class<? extends DatabaseObject>... types)

Method Detail

addType	back to summary
public boolean addType(Class<? extends DatabaseObject> type, Database database) Adds a new DatabaseObject type to the list of object types to be included in snapshots. Parameters type:Class<? extends DatabaseObject> The type to be added database:Database The database to check for any dependent types that need to be included as well Returns:boolean true if the type was added to the list, false if it was already present.

addType

back to summary

public boolean addType(Class<? extends DatabaseObject> type, Database database)

Adds a new DatabaseObject type to the list of object types to be included in snapshots.

Parameters

type:Class<? extends DatabaseObject>: The type to be added
database:Database: The database to check for any dependent types that need to be included as well

Returns:boolean

true if the type was added to the list, false if it was already present.

getSerializableFieldNamespace	back to summary
public String getSerializableFieldNamespace(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldNamespace. Annotations @Override

getSerializableFieldNamespace

back to summary

public String getSerializableFieldNamespace(String field)

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldNamespace.

Annotations

@Override

getSerializableFields	back to summary
public Set<String> getSerializableFields() Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields. Annotations @Override

getSerializableFields

back to summary

public Set<String> getSerializableFields()

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFields.

Annotations

@Override

getSerializableFieldType	back to summary
public LiquibaseSerializable.SerializationType getSerializableFieldType(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType. Annotations @Override

getSerializableFieldType

back to summary

public LiquibaseSerializable.SerializationType getSerializableFieldType(String field)

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldType.

Annotations

@Override

getSerializableFieldValue	back to summary
public Object getSerializableFieldValue(String field) Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue. Annotations @Override

getSerializableFieldValue

back to summary

public Object getSerializableFieldValue(String field)

Implements liquibase.serializer.LiquibaseSerializable.getSerializableFieldValue.

Annotations

@Override

getSerializedObjectName	back to summary
public String getSerializedObjectName() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName. Annotations @Override

getSerializedObjectName

back to summary

public String getSerializedObjectName()

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectName.

Annotations

@Override

getSerializedObjectNamespace	back to summary
public String getSerializedObjectNamespace() Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace. Annotations @Override

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

getSnapshotListener	back to summary
public SnapshotListener getSnapshotListener()

getTypesToInclude	back to summary
public Set<Class<? extends DatabaseObject>> getTypesToInclude() Return the types to be included in snapshots Returns:Set<Class<? extends DatabaseObject>> the set of currently registered types

getTypesToInclude

back to summary

public Set<Class<? extends DatabaseObject>> getTypesToInclude()

Return the types to be included in snapshots

Returns:Set<Class<? extends DatabaseObject>>: the set of currently registered types

isWarnIfObjectNotFound	back to summary
public boolean isWarnIfObjectNotFound() Returns if the code should log a LogLevel.WARNING message if the object to be snapshotted could not be found. Returns:boolean true if WARNINGs should be emitted (default), false if not.

isWarnIfObjectNotFound

back to summary

public boolean isWarnIfObjectNotFound()

Returns if the code should log a LogLevel.WARNING message if the object to be snapshotted could not be found.

Returns:boolean: true if WARNINGs should be emitted (default), false if not.

load	back to summary
public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException Implements liquibase.serializer.LiquibaseSerializable.load. Annotations @Override

load

back to summary

public void load(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Implements liquibase.serializer.LiquibaseSerializable.load.

Annotations

@Override

serialize	back to summary
public ParsedNode serialize() Implements liquibase.serializer.LiquibaseSerializable.serialize. Annotations @Override

serialize

back to summary

public ParsedNode serialize()

Implements liquibase.serializer.LiquibaseSerializable.serialize.

Annotations

@Override

setSnapshotListener	back to summary
public void setSnapshotListener(SnapshotListener snapshotListener)

setTypes	back to summary
private void setTypes(Set<Class<? extends DatabaseObject>> types, Database database)

setWarnIfObjectNotFound	back to summary
public SnapshotControl setWarnIfObjectNotFound(boolean warnIfObjectNotFound) Configures the code to log a LogLevel.WARNING message if the object to be snapshotted could not be found. Parameters warnIfObjectNotFound:boolean true if a warning should emitted (default value), false if not.

setWarnIfObjectNotFound

back to summary

public SnapshotControl setWarnIfObjectNotFound(boolean warnIfObjectNotFound)

Configures the code to log a LogLevel.WARNING message if the object to be snapshotted could not be found.

Parameters

warnIfObjectNotFound:boolean: true if a warning should emitted (default value), false if not.

shouldInclude	back to summary
public boolean shouldInclude(Class<? extends DatabaseObject> type) Queries the currently registered list of types to be included and returns true if the given type is in that list Parameters type:Class<? extends DatabaseObject> the DatabaseObject type to be checked Returns:boolean true if that type is registered for inclusion, false if not

shouldInclude

back to summary

public boolean shouldInclude(Class<? extends DatabaseObject> type)

Queries the currently registered list of types to be included and returns true if the given type is in that list

Parameters

type:Class<? extends DatabaseObject>: the DatabaseObject type to be checked

Returns:boolean

true if that type is registered for inclusion, false if not

shouldInclude	back to summary
public <T extends DatabaseObject> boolean shouldInclude(T example)

public Class SnapshotControl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail