Top Description Fields Constructors Methods
liquibase.change

public final Class CheckSum

extends Object
Class Inheritance
Annotations
@lombok.NoArgsConstructor
@lombok.Setter
Imports
liquibase.ChecksumVersion, .Scope, liquibase.util.MD5Util, .StringUtil, lombok.Getter, lombok.NoArgsConstructor, lombok.Setter, java.io.IOException, .InputStream, java.text.Normalizer, java.util.regex.Matcher, .Pattern

CheckSums are used by liquibase to determine if a Change has been modified since it was originally ran. CheckSums can be computed on either a String or an InputStream. The CheckSum contains a version number which can be used to determine whether the algorithm for computing a storedCheckSum has changed since the last time it was computed. If the algorithm changes, we cannot rely on the storedCheckSum value. It is not up to this class to determine what should be storedCheckSum-ed, it simply hashes what is passed to it.

Field Summary

Modifier and TypeField and Description
private static final Pattern
private static final String
private static final char
private String
private int
version

-- GETTER -- Return the Checksum Algorithm version for this CheckSum

Constructor Summary

AccessConstructor and Description
private
CheckSum(String
Generated checksum (format depends on version)
checksum
,
int
The version of the Liquibase checksum generator used
version
)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public static CheckSum
compute(String valueToChecksum)

Compute a storedCheckSum of the given string.

public static CheckSum
compute(final InputStream stream, boolean standardizeLineEndings)

Compute a CheckSum of the given data stream (no normalization of line endings!)

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public static int
getCurrentVersion()
Deprecated Use ChecksumVersion#latest() instead

Return the current CheckSum algorithm version.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static CheckSum
parse(String checksumValue)

Parse the given storedCheckSum string value and return a new CheckSum object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

CHECKSUM_PATTERNback to summary
private static final Pattern CHECKSUM_PATTERN
CHECKSUM_REGEXback to summary
private static final String CHECKSUM_REGEX
DELIMITERback to summary
private static final char DELIMITER
storedCheckSumback to summary
private String storedCheckSum
versionback to summary
private int version

-- GETTER -- Return the Checksum Algorithm version for this CheckSum

Annotations
@lombok.Getter

Constructor Detail

CheckSumback to summary
private CheckSum(String checksum, int version)

Constructor. Stores a given checksum generated by a given algorithm version into the new CheckSum object.

Parameters
checksum:String

Generated checksum (format depends on version)

version:int

The version of the Liquibase checksum generator used

Method Detail

computeback to summary
public static CheckSum compute(String valueToChecksum)

Compute a storedCheckSum of the given string.

computeback to summary
public static CheckSum compute(final InputStream stream, boolean standardizeLineEndings)

Compute a CheckSum of the given data stream (no normalization of line endings!)

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getCurrentVersionback to summary
public static int getCurrentVersion()

Deprecated

Use ChecksumVersion#latest() instead

Return the current CheckSum algorithm version.

Annotations
@Deprecated
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
parseback to summary
public static CheckSum parse(String checksumValue)

Parse the given storedCheckSum string value and return a new CheckSum object.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override