Package org.finos.tracdap.common.validation.core.impl

Class ValidationContextImpl

java.lang.Object

org.finos.tracdap.common.validation.core.impl.ValidationContextImpl

All Implemented Interfaces:

ValidationContext

public class ValidationContextImpl
extends Object
implements ValidationContext

Method Summary

Modifier and Type	Method	Description
ValidationContext	apply(ValidationFunction.Basic validator)
ValidationContext	apply(ValidationFunction.Typed<String> validator)
<T> ValidationContext	apply(ValidationFunction.Typed<T> validator, Class<T> targetClass)
<T, U> ValidationContext	apply(ValidationFunction.TypedArg<T,U> validator, Class<T> targetClass, U arg)
ValidationContext	apply(ValidationFunction.Version<Object> validator)
<T> ValidationContext	apply(ValidationFunction.Version<T> validator, Class<T> targetClass)
ValidationContext	applyIf(boolean condition, ValidationFunction.Basic validator)
ValidationContext	applyIf(boolean condition, ValidationFunction.Typed<String> validator)
<T> ValidationContext	applyIf(boolean condition, ValidationFunction.Typed<T> validator, Class<T> targetClass)
<T, U> ValidationContext	applyIf(boolean condition, ValidationFunction.TypedArg<T,U> validator, Class<T> targetClass, U arg)
<T> ValidationContext	applyIf(boolean condition, ValidationFunction.Version<T> validator, Class<T> targetClass)
ValidationContext	applyMapKeys(ValidationFunction.Basic validator)
ValidationContext	applyMapKeys(ValidationFunction.Typed<String> validator)
<U> ValidationContext	applyMapKeys(ValidationFunction.TypedArg<String,U> validator, U arg)
ValidationContext	applyMapValues(ValidationFunction.Basic validator)
<T> ValidationContext	applyMapValues(ValidationFunction.Typed<T> validator, Class<T> targetClass)
<T, U> ValidationContext	applyMapValues(ValidationFunction.TypedArg<T,U> validator, Class<T> targetClass, U arg)
ValidationContext	applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field, ValidationFunction.Basic validator)
<T> ValidationContext	applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field, ValidationFunction.Typed<T> validator, Class<T> targetClass)
<T, U> ValidationContext	applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field, ValidationFunction.TypedArg<T,U> validator, Class<T> targetClass, U arg)
<T> ValidationContext	applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field, ValidationFunction.Version<T> validator, Class<T> targetClass)
ValidationContext	applyRegistered()
ValidationContext	applyRepeated(ValidationFunction.Basic validator)
ValidationContext	applyRepeated(ValidationFunction.Typed<String> validator)
<T> ValidationContext	applyRepeated(ValidationFunction.Typed<T> validator, Class<T> targetClass)
<T, U> ValidationContext	applyRepeated(ValidationFunction.TypedArg<T,U> validator, Class<T> targetClass, U arg)
boolean	done()
ValidationContext	error(String message)	Record an error against the current location in the validation stack
boolean	failed()
com.google.protobuf.Descriptors.FieldDescriptor	field()
String	fieldName()
static ValidationContext	forMessage(com.google.protobuf.Message msg)
static ValidationContext	forMethod(com.google.protobuf.Message msg, com.google.protobuf.Descriptors.MethodDescriptor method)
static ValidationContext	forVersion(com.google.protobuf.Message current, com.google.protobuf.Message prior)
List<ValidationFailure>	getErrors()
boolean	isMap()
boolean	isOneOf()
boolean	isRepeated()
ValidationKey	key()
com.google.protobuf.Descriptors.OneofDescriptor	oneOf()
com.google.protobuf.Message	parentMsg()
ValidationContext	pop()	Pop the current object from the validation stack
ValidationContext	prior()
ValidationContext	push(com.google.protobuf.Descriptors.FieldDescriptor fd)	Push a member field of the current object onto the validation stack
ValidationContext	pushMap(com.google.protobuf.Descriptors.FieldDescriptor fd)	Push a map member field of the current object onto the validation stack This method will work with applyMapKeys() and applyMapValues().
<TMsg extends com.google.protobuf.Message> ValidationContext	pushMap(com.google.protobuf.Descriptors.FieldDescriptor mapField, Function<TMsg,Map<?,?>> getMapFunc)	Push a map member field of the current object onto the validation stack This method only pushes the map itself onto the stack, the validation target will be a Java Map object.
ValidationContext	pushMapKey(Object key)	Push an individual map key onto the validation stack Requires that the current target is a map field.
ValidationContext	pushMapValue(Object key)	Push an individual map value onto the validation stack Requires that the current target is a map field.
ValidationContext	pushOneOf(com.google.protobuf.Descriptors.OneofDescriptor oneOf)	Push a "one-of" field of the current object onto the validation stack
ValidationContext	pushRepeated(com.google.protobuf.Descriptors.FieldDescriptor fd)	Push a repeated member field of the current object onto the validation stack This method pushes a list onto the validation stack, so the target becomes a Java List object.
ValidationContext	pushRepeatedItem(int index)	Push an individual list item onto the validation stack Requires that the current target is a repeated field.
ValidationContext	pushRepeatedItem(int index, Object priorObj)	Push an individual list item onto the validation stack Requires that the current target is a repeated field.
ValidationContext	pushRepeatedItem(Object obj, Object priorObj)	Push an individual list item onto the validation stack Requires that the current target is a repeated field.
ValidationContext	skip()	Skip the current location in the validation stack Any future calls to apply() at this location or child locations will be ignored.
boolean	skipped()
Object	target()
ValidationType	validationType()

Methods inherited from class java.lang.Object

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

Method Details

forMethod

public static ValidationContext forMethod(com.google.protobuf.Message msg,
 com.google.protobuf.Descriptors.MethodDescriptor method)

forMessage

public static ValidationContext forMessage(com.google.protobuf.Message msg)

forVersion

public static ValidationContext forVersion(com.google.protobuf.Message current,
 com.google.protobuf.Message prior)

push

public ValidationContext push(com.google.protobuf.Descriptors.FieldDescriptor fd)

Description copied from interface: ValidationContext

Push a member field of the current object onto the validation stack

Specified by:

push in interface ValidationContext

Parameters:

fd - The field that will be pushed onto the stack

Returns:

A validation context pointing at the field that has been pushed

pushOneOf

public ValidationContext pushOneOf(com.google.protobuf.Descriptors.OneofDescriptor oneOf)

Description copied from interface: ValidationContext

Push a "one-of" field of the current object onto the validation stack

Specified by:

pushOneOf in interface ValidationContext

Parameters:

oneOf - The one-of field that will be pushed onto the stack

Returns:

A validation context pointing at the field that has been pushed

pushRepeated

public ValidationContext pushRepeated(com.google.protobuf.Descriptors.FieldDescriptor fd)

Description copied from interface: ValidationContext

Push a repeated member field of the current object onto the validation stack This method pushes a list onto the validation stack, so the target becomes a Java List object. To push individual list items, use pushRepeatedItem() after calling this method.

Specified by:

pushRepeated in interface ValidationContext

Parameters:

fd - The field that will be pushed onto the stack

Returns:

A validation context pointing at the list that has been pushed

pushRepeatedItem

public ValidationContext pushRepeatedItem(int index)

Description copied from interface: ValidationContext

Push an individual list item onto the validation stack Requires that the current target is a repeated field.

Specified by:

pushRepeatedItem in interface ValidationContext

Parameters:

index - The index of the list item to push onto the stack (must be within bounds of the list)

Returns:

A validation context pointing at the list item that has been pushed

pushRepeatedItem

public ValidationContext pushRepeatedItem(int index,
 Object priorObj)

Description copied from interface: ValidationContext

Push an individual list item onto the validation stack Requires that the current target is a repeated field. This overload allows a prior version of the object to be specified for version comparison. This is helpful for version validators, which need to match current / prior entries in a list.

Specified by:

pushRepeatedItem in interface ValidationContext

Parameters:

index - The index of the list item to push onto the stack (must be within bounds of the list)

priorObj - The prior object to be compared against this list item in version validators

Returns:

A validation context pointing at the list item that has been pushed

pushRepeatedItem

public ValidationContext pushRepeatedItem(Object obj,
 Object priorObj)

Description copied from interface: ValidationContext

Push an individual list item onto the validation stack Requires that the current target is a repeated field. This overload allows a prior version of the object to be specified for version comparison. This is helpful for version validators, which need to match current / prior entries in a list.

Specified by:

pushRepeatedItem in interface ValidationContext

Parameters:

obj - The current list item to push onto the stack (must be a member of the list)

priorObj - The prior object to be compared against this list item in version validators

Returns:

A validation context pointing at the list item that has been pushed

pushMap

public ValidationContext pushMap(com.google.protobuf.Descriptors.FieldDescriptor fd)

Description copied from interface: ValidationContext

Push a map member field of the current object onto the validation stack This method will work with applyMapKeys() and applyMapValues(). If you need to look up map items by key or want to call pushMapKey() / pushMapValue() explicitly, use the overload which takes getMapFunc as a parameter (protobuf for Java does not provide a generic way of looking up map keys).

Specified by:

pushMap in interface ValidationContext

Parameters:

fd - The field that will be pushed onto the stack

Returns:

A validation context pointing at the map that has been pushed (this is not a Map object)

pushMap

public <TMsg extends com.google.protobuf.Message>
ValidationContext pushMap(com.google.protobuf.Descriptors.FieldDescriptor mapField,
 Function<TMsg,Map<?,?>> getMapFunc)

Description copied from interface: ValidationContext

Push a map member field of the current object onto the validation stack This method only pushes the map itself onto the stack, the validation target will be a Java Map object. To push individual keys or values, use pushMapKey() or pushMapValue() after calling this method. This method needs a method reference from the parent message class to return Java map object associated with this field (protobuf for Java does not yet provide a generic way of looking up map keys).

Specified by:

pushMap in interface ValidationContext

Parameters:

mapField - The field that will be pushed onto the stack

getMapFunc - Method reference, on the parent message to return the field as a Java map

Returns:

A validation context pointing at the map that has been pushed (this is a Map object)

pushMapKey

public ValidationContext pushMapKey(Object key)

Description copied from interface: ValidationContext

Push an individual map key onto the validation stack Requires that the current target is a map field.

Specified by:

pushMapKey in interface ValidationContext

Parameters:

key - The map key to push onto the stack

Returns:

A validation context pointing at the map key that has been pushed

pushMapValue

public ValidationContext pushMapValue(Object key)

Description copied from interface: ValidationContext

Push an individual map value onto the validation stack Requires that the current target is a map field.

Specified by:

pushMapValue in interface ValidationContext

Parameters:

key - The key of the map value to push onto the stack

Returns:

A validation context pointing at the map value that has been pushed

pop

public ValidationContext pop()

Description copied from interface: ValidationContext

Pop the current object from the validation stack

Specified by:

pop in interface ValidationContext

Returns:

A validation context pointing at the parent of the current object

error

public ValidationContext error(String message)

Description copied from interface: ValidationContext

Record an error against the current location in the validation stack

Specified by:

error in interface ValidationContext

Parameters:

message - The error message to record

Returns:

A validation context which includes the recorded error

skip

public ValidationContext skip()

Description copied from interface: ValidationContext

Skip the current location in the validation stack Any future calls to apply() at this location or child locations will be ignored. Errors already recorded at this location or child locations are still included in the validation report.

Specified by:

skip in interface ValidationContext

Returns:

A validation context with the current object marked as skipped

applyRegistered

public ValidationContext applyRegistered()

Specified by:

applyRegistered in interface ValidationContext

apply

public ValidationContext apply(ValidationFunction.Basic validator)

Specified by:

apply in interface ValidationContext

apply

public ValidationContext apply(ValidationFunction.Typed<String> validator)

Specified by:

apply in interface ValidationContext

apply

public <T> ValidationContext apply(ValidationFunction.Typed<T> validator,
 Class<T> targetClass)

Specified by:

apply in interface ValidationContext

apply

public <T,
U> ValidationContext apply(ValidationFunction.TypedArg<T,U> validator,
 Class<T> targetClass,
 U arg)

Specified by:

apply in interface ValidationContext

apply

public ValidationContext apply(ValidationFunction.Version<Object> validator)

Specified by:

apply in interface ValidationContext

apply

public <T> ValidationContext apply(ValidationFunction.Version<T> validator,
 Class<T> targetClass)

Specified by:

apply in interface ValidationContext

applyIf

public ValidationContext applyIf(boolean condition,
 ValidationFunction.Basic validator)

Specified by:

applyIf in interface ValidationContext

applyIf

public ValidationContext applyIf(boolean condition,
 ValidationFunction.Typed<String> validator)

Specified by:

applyIf in interface ValidationContext

applyIf

public <T> ValidationContext applyIf(boolean condition,
 ValidationFunction.Typed<T> validator,
 Class<T> targetClass)

Specified by:

applyIf in interface ValidationContext

applyIf

public <T,
U> ValidationContext applyIf(boolean condition,
 ValidationFunction.TypedArg<T,U> validator,
 Class<T> targetClass,
 U arg)

Specified by:

applyIf in interface ValidationContext

applyIf

public <T> ValidationContext applyIf(boolean condition,
 ValidationFunction.Version<T> validator,
 Class<T> targetClass)

Specified by:

applyIf in interface ValidationContext

applyOneOf

public ValidationContext applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field,
 ValidationFunction.Basic validator)

Specified by:

applyOneOf in interface ValidationContext

applyOneOf

public <T> ValidationContext applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field,
 ValidationFunction.Typed<T> validator,
 Class<T> targetClass)

Specified by:

applyOneOf in interface ValidationContext

applyOneOf

public <T,
U> ValidationContext applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field,
 ValidationFunction.TypedArg<T,U> validator,
 Class<T> targetClass,
 U arg)

Specified by:

applyOneOf in interface ValidationContext

applyOneOf

public <T> ValidationContext applyOneOf(com.google.protobuf.Descriptors.FieldDescriptor field,
 ValidationFunction.Version<T> validator,
 Class<T> targetClass)

Specified by:

applyOneOf in interface ValidationContext

applyRepeated

public ValidationContext applyRepeated(ValidationFunction.Basic validator)

Specified by:

applyRepeated in interface ValidationContext

applyRepeated

public ValidationContext applyRepeated(ValidationFunction.Typed<String> validator)

Specified by:

applyRepeated in interface ValidationContext

applyRepeated

public <T> ValidationContext applyRepeated(ValidationFunction.Typed<T> validator,
 Class<T> targetClass)

Specified by:

applyRepeated in interface ValidationContext

applyRepeated

public <T,
U> ValidationContext applyRepeated(ValidationFunction.TypedArg<T,U> validator,
 Class<T> targetClass,
 U arg)

Specified by:

applyRepeated in interface ValidationContext

applyMapKeys

public ValidationContext applyMapKeys(ValidationFunction.Basic validator)

Specified by:

applyMapKeys in interface ValidationContext

applyMapKeys

public ValidationContext applyMapKeys(ValidationFunction.Typed<String> validator)

Specified by:

applyMapKeys in interface ValidationContext

applyMapKeys

public <U> ValidationContext applyMapKeys(ValidationFunction.TypedArg<String,U> validator,
 U arg)

Specified by:

applyMapKeys in interface ValidationContext

applyMapValues

public ValidationContext applyMapValues(ValidationFunction.Basic validator)

Specified by:

applyMapValues in interface ValidationContext

applyMapValues

public <T> ValidationContext applyMapValues(ValidationFunction.Typed<T> validator,
 Class<T> targetClass)

Specified by:

applyMapValues in interface ValidationContext

applyMapValues

public <T,
U> ValidationContext applyMapValues(ValidationFunction.TypedArg<T,U> validator,
 Class<T> targetClass,
 U arg)

Specified by:

applyMapValues in interface ValidationContext

validationType

public ValidationType validationType()

Specified by:

validationType in interface ValidationContext

key

public ValidationKey key()

Specified by:

key in interface ValidationContext

target

public Object target()

Specified by:

target in interface ValidationContext

parentMsg

public com.google.protobuf.Message parentMsg()

Specified by:

parentMsg in interface ValidationContext

isOneOf

public boolean isOneOf()

Specified by:

isOneOf in interface ValidationContext

isRepeated

public boolean isRepeated()

Specified by:

isRepeated in interface ValidationContext

isMap

public boolean isMap()

Specified by:

isMap in interface ValidationContext

oneOf

public com.google.protobuf.Descriptors.OneofDescriptor oneOf()

Specified by:

oneOf in interface ValidationContext

field

public com.google.protobuf.Descriptors.FieldDescriptor field()

Specified by:

field in interface ValidationContext

fieldName

public String fieldName()

Specified by:

fieldName in interface ValidationContext

prior

public ValidationContext prior()

Specified by:

prior in interface ValidationContext

failed

public boolean failed()

Specified by:

failed in interface ValidationContext

skipped

public boolean skipped()

Specified by:

skipped in interface ValidationContext

done

public boolean done()

Specified by:

done in interface ValidationContext

getErrors

public List<ValidationFailure> getErrors()

Specified by:

getErrors in interface ValidationContext