Top Fields Constructors Methods
liquibase.exception

public Class ValidationErrors

extends Object
Class Inheritance
Imports
liquibase.Scope, liquibase.change.Change, .ChangeFactory, liquibase.changelog.ChangeSet, liquibase.database.Database, liquibase.precondition.Precondition, liquibase.util.StringUtil, java.util.ArrayList, .Collection, .Collections, .List

Field Summary

Modifier and TypeField and Description
protected String
protected List<String>
protected List<String>

Constructor Summary

AccessConstructor and Description
public
public
public
public

Method Summary

Modifier and TypeMethod and Description
public ValidationErrors
addAll(ValidationErrors validationErrors)

public void
addAll(ValidationErrors validationErrors, ChangeSet changeSet)

public ValidationErrors
addError(String message)

public ValidationErrors
addError(String message, ChangeSet changeSet)

public ValidationErrors
addWarning(String message)

public final void
checkDisallowedField(String
field whose value is checked
disallowedFieldName
,
Object
value that might be disallowed
value
,
Database
database the object/value combination is checked against
database
,
Class<? extends Database>...
a list of "forbidden" databases that do not allow this field/value combination
disallowedDatabases
)

Checks if a field is forbidden in combination with a given Database (most often because that database does not implement the features required by the field/value combination).

public ValidationErrors
checkRequiredField(String requiredFieldName, Object value)

Convenience method for checkRequiredField(String, Object, String, boolean) with allowEmptyValue=false

public ValidationErrors
checkRequiredField(String requiredFieldName, Object value, boolean allowEmptyValue)

Convenience method for checkRequiredField(String, Object, String, boolean) with a null postfix

public ValidationErrors
checkRequiredField(String requiredFieldName, Object value, String postfix)

Convenience method for checkRequiredField(String, Object, String, boolean) with allowEmptyValue=false

public ValidationErrors
checkRequiredField(String requiredFieldName, Object value, String postfix, boolean
If true, empty string and empty arrays are allowed. If false, they are not.
allowEmptyValue
)

Checks that the given value is set.

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 String
public List<String>
public List<String>
public List<String>
public List<String>
public boolean
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

changeback to summary
protected String change
errorMessagesback to summary
protected List<String> errorMessages
warningMessagesback to summary
protected List<String> warningMessages

Constructor Detail

ValidationErrorsback to summary
public ValidationErrors()
ValidationErrorsback to summary
public ValidationErrors(String change)
ValidationErrorsback to summary
public ValidationErrors(Change change)
ValidationErrorsback to summary
public ValidationErrors(Precondition precondition)

Method Detail

addAllback to summary
public ValidationErrors addAll(ValidationErrors validationErrors)
addAllback to summary
public void addAll(ValidationErrors validationErrors, ChangeSet changeSet)
addErrorback to summary
public ValidationErrors addError(String message)
addErrorback to summary
public ValidationErrors addError(String message, ChangeSet changeSet)
addWarningback to summary
public ValidationErrors addWarning(String message)
checkDisallowedFieldback to summary
public final void checkDisallowedField(String disallowedFieldName, Object value, Database database, Class<? extends Database>... disallowedDatabases)

Checks if a field is forbidden in combination with a given Database (most often because that database does not implement the features required by the field/value combination). If a "forbidden" use is detected, a validation error is added to the current list of ValidationErrors.

Note:
  • if value==null, the field is ALLOWED for all DBs
  • if the disallowedDatabases list does not at least contain 1 entry, the field is NOT allowed
Parameters
disallowedFieldName:String

field whose value is checked

value:Object

value that might be disallowed

database:Database

database the object/value combination is checked against

disallowedDatabases:Class<? extends Database>[]

a list of "forbidden" databases that do not allow this field/value combination

Annotations
@SafeVarargs
checkRequiredFieldback to summary
public ValidationErrors checkRequiredField(String requiredFieldName, Object value)

Convenience method for checkRequiredField(String, Object, String, boolean) with allowEmptyValue=false

checkRequiredFieldback to summary
public ValidationErrors checkRequiredField(String requiredFieldName, Object value, boolean allowEmptyValue)

Convenience method for checkRequiredField(String, Object, String, boolean) with a null postfix

checkRequiredFieldback to summary
public ValidationErrors checkRequiredField(String requiredFieldName, Object value, String postfix)

Convenience method for checkRequiredField(String, Object, String, boolean) with allowEmptyValue=false

checkRequiredFieldback to summary
public ValidationErrors checkRequiredField(String requiredFieldName, Object value, String postfix, boolean allowEmptyValue)

Checks that the given value is set.

Parameters
allowEmptyValue:boolean

If true, empty string and empty arrays are allowed. If false, they are not.

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
getChangeNameback to summary
public String getChangeName()
getErrorMessagesback to summary
public List<String> getErrorMessages()
getRequiredErrorMessagesback to summary
public List<String> getRequiredErrorMessages()
getUnsupportedErrorMessagesback to summary
public List<String> getUnsupportedErrorMessages()
getWarningMessagesback to summary
public List<String> getWarningMessages()
hasErrorsback to summary
public boolean hasErrors()
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
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