Package ch.so.agi.hop.doclint.validate

Class SampleValidator

java.lang.Object

ch.so.agi.hop.doclint.validate.SampleValidator

public final class SampleValidator
extends Object

Validates that every plugin element has a user example under examples/.

v0.1 checks two things: at least one readable .hpl pipeline exists and it references the plugin element id in a <type> element. The example is parsed as XML; a broken sample is reported as an error.

Constructor Summary

Constructors

Constructor	Description
SampleValidator()

Method Summary

Modifier and Type	Method	Description
List<CheckResult>	validate(List<PluginElement> elements, DocLintConfig config)

Methods inherited from class java.lang.Object

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

Constructor Details

SampleValidator

public SampleValidator()

Method Details

validate

public List<CheckResult> validate(List<PluginElement> elements,
 DocLintConfig config)
                           throws IOException

Throws:

IOException