[DOXIA-712] Add validation capability to Sink API

[jira-importer]

Konrad Windszus opened DOXIA-712 and commented

The Sink API comes with several limitations with regards to valid order of events/method calls and valid parametrization. Those are documented in the javadoc of the Sink interface but are complex to follow. This includes

• certain start events need to be followed by an according end event
• sectionTitle(int,SinkEventAttributes) needs to be directly preceded by section(int,SinkEventAttributes) with the same first argument.
• certain rules for sequence of events for table, list (numbered, non-numbered and definition) and figure
• validation of certain common parameters like level or SinkEventAttributes for valid values

As we encourage the direct usage of the Sink API for report mojos there should be a way for mojo authors to quickly crosscheck whether they used the Sink API in a correct way.

---

Issue Links:

• DOXIA-711 Introduce SinkWrapper with factory
  ("is blocked by")
• DOXIA-699 Xhtml5Parser may emit sectionX() without sectionX_() when using both <hX> and <section>

[jira-importer]

Michael Osipov commented

How should this happen? Per Sink implemenatation because only they know the semantics of validation? A configure flag to enforce?

[jira-importer]

Konrad Windszus commented

All those limitations outlined above are defined by the Sink interface (i.e. are implementation agnostic). That is for me the whole point of using this Sink indirection. The Sink API must work the same irrespective of the actual implementation.