Package io.smallrye.openapi.runtime.scanner.dataobject

Class BeanValidationScanner

java.lang.Object

io.smallrye.openapi.runtime.scanner.dataobject.BeanValidationScanner

public class BeanValidationScanner
extends Object

Author:

Michael Edgar <michael@xlate.io>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BeanValidationScanner.RequirementHandler

Constructor Summary

Constructors

Constructor	Description
BeanValidationScanner(AnnotationScannerContext context)

Method Summary

Modifier and Type	Method	Description
static void	applyConstraints(AnnotationScannerContext context, org.jboss.jandex.Type type, org.eclipse.microprofile.openapi.models.media.Schema schema)	Apply validation constraints found on the type to the schema, if bean validation scanning is enabled on the given context.
void	applyConstraints(org.jboss.jandex.AnnotationTarget target, org.eclipse.microprofile.openapi.models.media.Schema schema, String propertyKey, BeanValidationScanner.RequirementHandler handler)	Determine if any Java Bean Validation constraint annotations are present on the AnnotationTarget that are applicable to the schema.
void	applyConstraints(org.jboss.jandex.Type target, org.eclipse.microprofile.openapi.models.media.Schema schema, String propertyKey, BeanValidationScanner.RequirementHandler handler)	Like applyConstraints(AnnotationTarget, Schema, String, RequirementHandler), but for constraints on Types.
boolean	hasConstraints(org.jboss.jandex.AnnotationTarget target)	Scan the annotation target to determine whether any annotations from the Bean Validation package (javax.validation.constraints) are present.

Methods inherited from class java.lang.Object

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

Constructor Details

BeanValidationScanner

public BeanValidationScanner(AnnotationScannerContext context)

Method Details

hasConstraints

public boolean hasConstraints(org.jboss.jandex.AnnotationTarget target)

Scan the annotation target to determine whether any annotations from the Bean Validation package (javax.validation.constraints) are present.

Parameters:

target - the annotation target to scan

Returns:

true if annotations from the Bean Validation package are present, otherwise false.

applyConstraints

public void applyConstraints(org.jboss.jandex.AnnotationTarget target,
 org.eclipse.microprofile.openapi.models.media.Schema schema,
 String propertyKey,
 BeanValidationScanner.RequirementHandler handler)

Determine if any Java Bean Validation constraint annotations are present on the AnnotationTarget that are applicable to the schema. This method will apply the constraints to the schema only if no value has previously been set. If the schema's type attribute has not been previously set or the schema contains a reference, this method will not apply any changes to the schema. Each of the constraints (defined in javax.validation.constraints) will apply to the schema based on the schema's type. When a bean validation @NotNull constraint applies to the schema, the provided BeanValidationScanner.RequirementHandler will be called in order for the component calling this method to determine if and how to apply the requirement. E.g. a required Schema is communicated differently for a parent schema and for a parameter described by the schema.

Parameters:

target - the object from which to retrieve the constraint annotations

schema - the schema to which the constraints will be applied

propertyKey - the name of the property in parentSchema that refers to the schema

handler - the handler to be called when a bean validation @NotNull constraint is encountered.

applyConstraints

public void applyConstraints(org.jboss.jandex.Type target,
 org.eclipse.microprofile.openapi.models.media.Schema schema,
 String propertyKey,
 BeanValidationScanner.RequirementHandler handler)

Like applyConstraints(AnnotationTarget, Schema, String, RequirementHandler), but for constraints on Types.

Parameters:

target - the object from which to retrieve the constraint annotations

schema - the schema to which the constraints will be applied

propertyKey - the name of the property in parentSchema that refers to the schema

handler - the handler to be called when a bean validation @NotNull constraint is encountered.

applyConstraints

public static void applyConstraints(AnnotationScannerContext context,
 org.jboss.jandex.Type type,
 org.eclipse.microprofile.openapi.models.media.Schema schema)

Apply validation constraints found on the type to the schema, if bean validation scanning is enabled on the given context.

Parameters:

context - current scanning context

type - the object from which to retrieve the constraint annotations

schema - the schema to which the constraints will be applied