com.redhat.lightblue.crud.validator

Class RequiredChecker

java.lang.Object

com.redhat.lightblue.crud.validator.RequiredChecker

All Implemented Interfaces:

FieldConstraintChecker, FieldConstraintDocChecker

public class RequiredChecker
extends Object
implements FieldConstraintDocChecker

Constructor Summary

Constructors

Constructor and Description
RequiredChecker()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkConstraint(ConstraintValidator validator, FieldTreeNode fieldMetadata, Path fieldMetadataPath, FieldConstraint constraint, JsonDoc doc) Field constraint checker function that is run once for the document
static List<Path>	getMissingFields(Path fieldMetadataPath, JsonDoc doc) Returns the list of fields that are missing in the doc

Methods inherited from class java.lang.Object

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

Constructor Detail

RequiredChecker

public RequiredChecker()

Method Detail

checkConstraint

public void checkConstraint(ConstraintValidator validator,
                   FieldTreeNode fieldMetadata,
                   Path fieldMetadataPath,
                   FieldConstraint constraint,
                   JsonDoc doc)

Description copied from interface: FieldConstraintDocChecker

Field constraint checker function that is run once for the document

Specified by:

checkConstraint in interface FieldConstraintDocChecker

Parameters:

validator - The constraint validator instance from which the implementation can access the metadata and context information

fieldMetadataPath - The path for the field metadata (i.e. may contain *)

constraint - field constraint

doc - The document The function should add the errors to validator

getMissingFields

public static List<Path> getMissingFields(Path fieldMetadataPath,
                          JsonDoc doc)

Returns the list of fields that are missing in the doc

Parameters:

fieldMetadataPath - Path of the required field

doc - The document

Returns:

List of field instances that are not present in the doc.