org.spf4j.maven.plugin.avro.avscp.validation.impl

Class SchemaDocValidator

java.lang.Object

org.spf4j.maven.plugin.avro.avscp.validation.impl.SchemaDocValidator

All Implemented Interfaces:

Validator<org.apache.avro.Schema>

public final class SchemaDocValidator
extends Object
implements Validator<org.apache.avro.Schema>

Validates schema documentation fields are not empty for: Records, Fixed, Enum, Record Fields.

Additionally for record fields of union type where one type is null, the doc is validated for the presence of the "null" string, with the expectation that the documentation contains a explanation on what in means.

Author:

Zoltan Farkas

Nested Class Summary

Nested classes/interfaces inherited from interface org.spf4j.maven.plugin.avro.avscp.validation.Validator

Validator.Result

Constructor Summary

Constructors

Constructor and Description
SchemaDocValidator()

Method Summary

Modifier and Type	Method and Description
String	getName()
Class<org.apache.avro.Schema>	getValidationInput()
Validator.Result	validate(org.apache.avro.Schema schema, ValidatorMojo mojo)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaDocValidator

public SchemaDocValidator()

Method Detail

getName

public String getName()

Specified by:

getName in interface Validator<org.apache.avro.Schema>

validate

@Nonnull
public Validator.Result validate(org.apache.avro.Schema schema,
                                          ValidatorMojo mojo)

Specified by:

validate in interface Validator<org.apache.avro.Schema>

getValidationInput

public Class<org.apache.avro.Schema> getValidationInput()

Specified by:

getValidationInput in interface Validator<org.apache.avro.Schema>