Package ac.simons.neo4j.migrations.core

Class ValidationResult

java.lang.Object

ac.simons.neo4j.migrations.core.ValidationResult

All Implemented Interfaces:

DatabaseOperationResult, OperationResult

public final class ValidationResult
extends Object
implements DatabaseOperationResult

The result of the Migrations.validate() operation.

Since:

1.2.0

Author:

Michael J. Simons

Soundtrack

Die Krupps - Paradise Now

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ValidationResult.Outcome	The outcome of the validation.

Method Summary

Modifier and Type	Method	Description
Optional<String>	getAffectedDatabase()
ValidationResult.Outcome	getOutcome()
Collection<String>	getWarnings()
boolean	isValid()
boolean	needsRepair()	If this method returns false, the database is either valid or the resolved migrations can be applied to bring the database into a valid state.
String	prettyPrint()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getWarnings

public Collection<String> getWarnings()

Specified by:

getWarnings in interface OperationResult

Returns:

all warnings, if any

prettyPrint

public String prettyPrint()

Specified by:

prettyPrint in interface OperationResult

Returns:

a sensible string applicable in a log or info message

getAffectedDatabase

public Optional<String> getAffectedDatabase()

Specified by:

getAffectedDatabase in interface DatabaseOperationResult

Returns:

the optional name of the database clean, an empty optional indicates the default database

getOutcome

public ValidationResult.Outcome getOutcome()

Returns:

the outcome of the validation

See Also:

• isValid()

isValid

public boolean isValid()

Returns:

true if the database is in a valid state

needsRepair

public boolean needsRepair()

If this method returns false, the database is either valid or the resolved migrations can be applied to bring the database into a valid state.

Returns:

true if the database needs repair.