Class QInstanceValidator

java.lang.Object

com.kingsrook.qqq.backend.core.instances.QInstanceValidator

public class QInstanceValidator
extends Object

Class that knows how to take a look at the data in a QInstance, and report if it is all valid - e.g., non-null things are set; references line-up (e.g., a table's backend must be a defined backend). Prior to doing validation, the the QInstanceEnricher is ran over the QInstance, e.g., to fill in things that can be defaulted or assumed. TODO let the instance customize or opt-out of Enrichment.

Constructor Summary

Constructors

Constructor	Description
QInstanceValidator()

Method Summary

Modifier and Type	Method	Description
static void	addValidatorPlugin(QInstanceValidatorPluginInterface<?> plugin)
boolean	assertCondition(boolean condition, String message)	For the given input condition, if it's true, then we're all good (and return true).
boolean	assertNoException(UnsafeLambda unsafeLambda, String message)	For the given lambda, if it doesn't throw an exception, then we're all good (and return true).
List<String>	getErrors()	Getter for errors
static ListingHash<Class<?>,QInstanceValidatorPluginInterface<?>>	getValidatorPlugins()	Getter for validatorPlugins
static void	removeAllValidatorPlugins()
void	revalidate(QInstance qInstance)
void	validate(QInstance qInstance)
void	validateField(QInstance qInstance, String prefix, Optional<QTableMetaData> table, QFieldMetaData field)	run validation on a field - optionally within the context of a table.
void	validateFieldSupplementalMetaData(QFieldMetaData field, QInstance qInstance)
void	validateQueryFilter(QInstance qInstance, String context, QTableMetaData table, QQueryFilter queryFilter, List<QueryJoin> queryJoins)
void	validateSimpleCodeReference(String prefix, QCodeReference codeReference, Class<?>... anyOfExpectedClasses)
void	warn(String message)

Methods inherited from class java.lang.Object

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

Constructor Details

QInstanceValidator

public QInstanceValidator()

Method Details

validate

public void validate(QInstance qInstance)
              throws QInstanceValidationException

Throws:

QInstanceValidationException

revalidate

public void revalidate(QInstance qInstance)
                throws QInstanceValidationException

Throws:

QInstanceValidationException

addValidatorPlugin

public static void addValidatorPlugin(QInstanceValidatorPluginInterface<?> plugin)

removeAllValidatorPlugins

public static void removeAllValidatorPlugins()

getValidatorPlugins

public static ListingHash<Class<?>,QInstanceValidatorPluginInterface<?>> getValidatorPlugins()

Getter for validatorPlugins

validateField

public void validateField(QInstance qInstance,
 String prefix,
 Optional<QTableMetaData> table,
 QFieldMetaData field)

run validation on a field - optionally within the context of a table.

validateFieldSupplementalMetaData

public void validateFieldSupplementalMetaData(QFieldMetaData field,
 QInstance qInstance)

validateQueryFilter

public void validateQueryFilter(QInstance qInstance,
 String context,
 QTableMetaData table,
 QQueryFilter queryFilter,
 List<QueryJoin> queryJoins)

validateSimpleCodeReference

public void validateSimpleCodeReference(String prefix,
 QCodeReference codeReference,
 Class<?>... anyOfExpectedClasses)

assertCondition

public boolean assertCondition(boolean condition,
 String message)

For the given input condition, if it's true, then we're all good (and return true). But if it's false, add the provided message to the list of errors (and return false, e.g., in case you need to stop evaluating rules to avoid exceptions).

assertNoException

public boolean assertNoException(UnsafeLambda unsafeLambda,
 String message)

For the given lambda, if it doesn't throw an exception, then we're all good (and return true). But if it throws, add the provided message to the list of errors (and return false, e.g., in case you need to stop evaluating rules to avoid exceptions).

warn

public void warn(String message)

getErrors

public List<String> getErrors()

Getter for errors