Package io.wcm.devops.conga.generator.spi

Interface ValidatorPlugin

All Superinterfaces:

FilePlugin<ValidatorContext,Void>, Plugin

All Known Implementing Classes:

JsonValidator, NoneValidator, XmlValidator

public interface ValidatorPlugin
extends FilePlugin<ValidatorContext,Void>

Plugin that allows to validate a generate file.

Method Summary

Modifier and Type	Method	Description
Void	apply(FileContext file, ValidatorContext context)	Validates the given file
default ImplicitApplyOptions	implicitApply(FileContext file, ValidatorContext context)	Whether to apply this plugin implicitly.

Methods inherited from interface io.wcm.devops.conga.generator.spi.FilePlugin

accepts

Methods inherited from interface io.wcm.devops.conga.generator.spi.Plugin

getName

Method Detail

implicitApply

default ImplicitApplyOptions implicitApply(FileContext file,
                                           ValidatorContext context)

Whether to apply this plugin implicitly.

Specified by:

implicitApply in interface FilePlugin<ValidatorContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

Implicit apply option

apply

Void apply(FileContext file,
           ValidatorContext context)
    throws ValidationException

Validates the given file

Specified by:

apply in interface FilePlugin<ValidatorContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

nothing

Throws:

ValidationException - when the validation fails.