Top Description Methods
liquibase.change

public @Interface DatabaseChangeProperty

extends Annotation
Annotations
@Retention:RUNTIME
@Target:METHOD
@Repeatable:DatabaseChangeProperties
Imports
liquibase.ChecksumVersion, liquibase.database.Database, liquibase.serializer.LiquibaseSerializable, java.lang.annotation.*
Annotation used by AbstractChange to declare ChangeParameterMetaData information. The annotation should be placed on the read method. This annotation should not be checked for outside AbstractChange, if any code is trying to determine the metadata provided by this annotation, it should get it from liquibase.change.ChangeFactory#getChangeMetaData(Change)

Method Summary

Modifier and TypeMethod and Description
public String
description()

Value to put into ChangeParameterMetaData#getDescription()

public String
exampleValue()

Value to put into liquibase.change.ChangeParameterMetaData#getExampleValue(Database)

public boolean
isChangeProperty()

If false, this field or method will not be included in liquibase.change.ChangeParameterMetaData

public String
mustEqualExisting()

Value to put into liquibase.change.ChangeParameterMetaData#getMustEqualExisting()

public String[]
requiredForDatabase()

Value to put into ChangeParameterMetaData#getRequiredForDatabase()

public LiquibaseSerializable.SerializationType
serializationType()

Format to use when serializing this Change via a liquibase.serializer.ChangeLogSerializer.

public String
since()

Value to put into liquibase.change.ChangeParameterMetaData#getSince()

public String[]
supportsDatabase()

Value to put into ChangeParameterMetaData#getSupportedDatabases()

public ChecksumVersion[]
version()

The checksum version that this annotation applies to.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

descriptionback to summary
public String description()

Value to put into ChangeParameterMetaData#getDescription()

exampleValueback to summary
public String exampleValue()

Value to put into liquibase.change.ChangeParameterMetaData#getExampleValue(Database)

isChangePropertyback to summary
public boolean isChangeProperty()

If false, this field or method will not be included in liquibase.change.ChangeParameterMetaData

mustEqualExistingback to summary
public String mustEqualExisting()

Value to put into liquibase.change.ChangeParameterMetaData#getMustEqualExisting()

requiredForDatabaseback to summary
public String[] requiredForDatabase()

Value to put into ChangeParameterMetaData#getRequiredForDatabase()

serializationTypeback to summary
public LiquibaseSerializable.SerializationType serializationType()

Format to use when serializing this Change via a liquibase.serializer.ChangeLogSerializer.

sinceback to summary
public String since()

Value to put into liquibase.change.ChangeParameterMetaData#getSince()

supportsDatabaseback to summary
public String[] supportsDatabase()

Value to put into ChangeParameterMetaData#getSupportedDatabases()

versionback to summary
public ChecksumVersion[] version()

The checksum version that this annotation applies to. This can be omitted, and it is assumed that the annotation applies to all checksum versions. If a version is applied to some, but not all of the DatabaseChangeProperty annotations on a particular property, the most specific matching annotation is selected. For example, if a particular property has: