Package io.wcm.devops.conga.generator.plugins.validator

Class XmlValidator

java.lang.Object

io.wcm.devops.conga.generator.plugins.validator.XmlValidator

All Implemented Interfaces:

FilePlugin<ValidatorContext,Void>, Plugin, ValidatorPlugin

public final class XmlValidator
extends Object
implements ValidatorPlugin

Validates XML syntax.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	Plugin name

Constructor Summary

Constructors

Constructor	Description
XmlValidator()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	accepts(FileContext file, ValidatorContext context)	Checks if the plugin can be applied to the given file.
Void	apply(FileContext file, ValidatorContext context)	Validates the given file
String	getName()

Methods inherited from class java.lang.Object

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

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

implicitApply

Field Detail

NAME

public static final String NAME

Plugin name

See Also:

Constant Field Values

Constructor Detail

XmlValidator

public XmlValidator()

Constructor.

Method Detail

getName

public String getName()

Specified by:

getName in interface Plugin

Returns:

Plugin name to be referenced in definition file

accepts

public boolean accepts(FileContext file,
                       ValidatorContext context)

Description copied from interface: FilePlugin

Checks if the plugin can be applied to the given file.

Specified by:

accepts in interface FilePlugin<ValidatorContext,Void>

Parameters:

file - Context file

context - Context objects

Returns:

true when the plugin can be applied to the given file.

apply

public Void apply(FileContext file,
                  ValidatorContext context)
           throws ValidationException

Description copied from interface: ValidatorPlugin

Validates the given file

Specified by:

apply in interface FilePlugin<ValidatorContext,Void>

Specified by:

apply in interface ValidatorPlugin

Parameters:

file - Context file

context - Context objects

Returns:

nothing

Throws:

ValidationException - when the validation fails.