com.github.victools.jsonschema.module.javax.validation

Class JavaxValidationModule

java.lang.Object

com.github.victools.jsonschema.module.javax.validation.JavaxValidationModule

All Implemented Interfaces:

com.github.victools.jsonschema.generator.Module

public class JavaxValidationModule
extends Object
implements com.github.victools.jsonschema.generator.Module

JSON Schema Generation Module: based on annotations from the javax.validation.constraints package.

• Determine whether a member is not nullable, base assumption being that all fields and method return values are nullable if not annotated.
• Populate "minItems" and "maxItems" for containers (i.e. arrays and collections).
• Populate "minLength" and "maxLength" for strings.
• Populate "minimum"/"exclusiveMinimum" and "maximum"/"exclusiveMaximum" for numbers.

Constructor Summary

Constructors

Constructor and Description
JavaxValidationModule()

Method Summary

Modifier and Type	Method and Description
void	applyToConfigBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder builder)
protected <A extends Annotation> A	getAnnotationFromFieldOrGetter(com.github.victools.jsonschema.generator.MemberScope<?,?> member, Class<A> annotationClass) Retrieves the annotation instance of the given type, either from the field it self or (if not present) from its getter.
protected Boolean	isNullable(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine whether a given field or method is annotated to be not nullable.
protected Integer	resolveArrayMaxItems(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a given array type's maximum number of items.
protected Integer	resolveArrayMinItems(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a given array type's minimum number of items.
protected BigDecimal	resolveNumberExclusiveMaximum(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a number type's maximum (exclusive) value.
protected BigDecimal	resolveNumberExclusiveMinimum(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a number type's minimum (exclusive) value.
protected BigDecimal	resolveNumberInclusiveMaximum(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a number type's maximum (inclusive) value.
protected BigDecimal	resolveNumberInclusiveMinimum(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a number type's minimum (inclusive) value.
protected Integer	resolveStringMaxLength(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a given text type's maximum number of characters.
protected Integer	resolveStringMinLength(com.github.victools.jsonschema.generator.MemberScope<?,?> member) Determine a given text type's minimum number of characters.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaxValidationModule

public JavaxValidationModule()

Method Detail

applyToConfigBuilder

public void applyToConfigBuilder(com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder builder)

Specified by:

applyToConfigBuilder in interface com.github.victools.jsonschema.generator.Module

getAnnotationFromFieldOrGetter

protected <A extends Annotation> A getAnnotationFromFieldOrGetter(com.github.victools.jsonschema.generator.MemberScope<?,?> member,
                                                                  Class<A> annotationClass)

Retrieves the annotation instance of the given type, either from the field it self or (if not present) from its getter.

Type Parameters:

A - type of annotation

Parameters:

member - field or method to retrieve annotation instance from (or from a field's getter or getter method's field)

annotationClass - type of annotation

Returns:

annotation instance (or null)

See Also:

MemberScope.getAnnotation(Class), FieldScope.findGetter(), MethodScope.findGetterField()

isNullable

protected Boolean isNullable(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine whether a given field or method is annotated to be not nullable.

Parameters:

member - the field or method to check

Returns:

whether member is annotated as nullable or not (returns null if not specified: assumption it is nullable then)

resolveArrayMinItems

protected Integer resolveArrayMinItems(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a given array type's minimum number of items.

Parameters:

member - the field or method to check

Returns:

specified minimum number of array items (or null)

See Also:

Size

resolveArrayMaxItems

protected Integer resolveArrayMaxItems(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a given array type's maximum number of items.

Parameters:

member - the field or method to check

Returns:

specified maximum number of array items (or null)

See Also:

Size

resolveStringMinLength

protected Integer resolveStringMinLength(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a given text type's minimum number of characters.

Parameters:

member - the field or method to check

Returns:

specified minimum number of characters (or null)

See Also:

Size, NotEmpty, NotBlank

resolveStringMaxLength

protected Integer resolveStringMaxLength(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a given text type's maximum number of characters.

Parameters:

member - the field or method to check

Returns:

specified minimum number of characters (or null)

See Also:

Size

resolveNumberInclusiveMinimum

protected BigDecimal resolveNumberInclusiveMinimum(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a number type's minimum (inclusive) value.

Parameters:

member - the field or method to check

Returns:

specified inclusive minimum value (or null)

See Also:

Min, DecimalMin, PositiveOrZero

resolveNumberExclusiveMinimum

protected BigDecimal resolveNumberExclusiveMinimum(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a number type's minimum (exclusive) value.

Parameters:

member - the field or method to check

Returns:

specified exclusive minimum value (or null)

See Also:

DecimalMin, Positive

resolveNumberInclusiveMaximum

protected BigDecimal resolveNumberInclusiveMaximum(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a number type's maximum (inclusive) value.

Parameters:

member - the field or method to check

Returns:

specified inclusive maximum value (or null)

See Also:

Max, DecimalMax.inclusive(), NegativeOrZero

resolveNumberExclusiveMaximum

protected BigDecimal resolveNumberExclusiveMaximum(com.github.victools.jsonschema.generator.MemberScope<?,?> member)

Determine a number type's maximum (exclusive) value.

Parameters:

member - the field or method to check

Returns:

specified exclusive maximum value (or null)

See Also:

DecimalMax.inclusive(), Negative