WellformednessCheckingSink (Doxia :: Core 1.9.1 Test API)

java.lang.Object
- org.apache.maven.doxia.sink.impl.AbstractSink
- - org.apache.maven.doxia.sink.impl.WellformednessCheckingSink

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.sink.Sink
```
public class WellformednessCheckingSink
extends org.apache.maven.doxia.sink.impl.AbstractSink
```
This sink is used for testing purposes in order to check wether the input of some parser is well-formed.

Author:

Lars Trieloff

Field Summary
- Fields inherited from interface org.apache.maven.doxia.sink.Sink
  JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5, SECTION_LEVEL_6
- Fields inherited from interface org.apache.maven.doxia.markup.Markup
  COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

Constructor Summary

Constructors
Constructor and Description

WellformednessCheckingSink()

Constructors
Constructor and Description
`WellformednessCheckingSink()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`address_()`
`void`	`address()`
`void`	`address(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`anchor_()`
`void`	`anchor(String name)`
`void`	`anchor(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`article_()`
`void`	`article()`
`void`	`article(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`author_()`
`void`	`author()`
`void`	`author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`blockquote_()`
`void`	`blockquote()`
`void`	`blockquote(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`body_()`
`void`	`body()`
`void`	`body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`bold_()`
`void`	`bold()`
`void`	`close()`
`void`	`comment(String comment)`
`void`	`content_()`
`void`	`content()`
`void`	`content(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`data_()`
`void`	`data(String value)`
`void`	`data(String value, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`date_()`
`void`	`date()`
`void`	`date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definedTerm_()`
`void`	`definedTerm()`
`void`	`definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definition_()`
`void`	`definition()`
`void`	`definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definitionList_()`
`void`	`definitionList()`
`void`	`definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`definitionListItem_()`
`void`	`definitionListItem()`
`void`	`definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`division_()`
`void`	`division()`
`void`	`division(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`figure_()`
`void`	`figure()`
`void`	`figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`figureCaption_()`
`void`	`figureCaption()`
`void`	`figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`figureGraphics(String name)`
`void`	`figureGraphics(String src, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`flush()`
`void`	`footer_()`
`void`	`footer()`
`void`	`footer(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`String`	`getOffender()` Gets the offending element that breaks the wellformedness as well as the exepected element.
`List<String>`	`getOffenders()` Gets the list of errors found during wellformedness-check
`void`	`head_()`
`void`	`head()`
`void`	`head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`header_()`
`void`	`header()`
`void`	`header(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`horizontalRule()`
`void`	`horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`inline_()`
`void`	`inline()`
`void`	`inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`boolean`	`isWellformed()` Finds out wether the wellformedness-contraints of the model have been violated.
`void`	`italic_()`
`void`	`italic()`
`void`	`lineBreak()`
`void`	`lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`lineBreakOpportunity()`
`void`	`lineBreakOpportunity(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`link_()`
`void`	`link(String name)`
`void`	`link(String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`list_()`
`void`	`list()`
`void`	`list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`listItem_()`
`void`	`listItem()`
`void`	`listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`monospaced_()`
`void`	`monospaced()`
`void`	`navigation_()`
`void`	`navigation()`
`void`	`navigation(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`nonBreakingSpace()`
`void`	`numberedList_()`
`void`	`numberedList(int numbering)`
`void`	`numberedList(int numbering, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`numberedListItem_()`
`void`	`numberedListItem()`
`void`	`numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`pageBreak()`
`void`	`paragraph_()`
`void`	`paragraph()`
`void`	`paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`rawText(String text)`
`void`	`section_(int level)`
`void`	`section(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`section1_()`
`void`	`section1()`
`void`	`section2_()`
`void`	`section2()`
`void`	`section3_()`
`void`	`section3()`
`void`	`section4_()`
`void`	`section4()`
`void`	`section5_()`
`void`	`section5()`
`void`	`section6_()`
`void`	`section6()`
`void`	`sectionTitle_()`
`void`	`sectionTitle_(int level)`
`void`	`sectionTitle()`
`void`	`sectionTitle(int level, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`sectionTitle1_()`
`void`	`sectionTitle1()`
`void`	`sectionTitle2_()`
`void`	`sectionTitle2()`
`void`	`sectionTitle3_()`
`void`	`sectionTitle3()`
`void`	`sectionTitle4_()`
`void`	`sectionTitle4()`
`void`	`sectionTitle5_()`
`void`	`sectionTitle5()`
`void`	`sectionTitle6_()`
`void`	`sectionTitle6()`
`void`	`sidebar_()`
`void`	`sidebar()`
`void`	`sidebar(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`table_()`
`void`	`table()`
`void`	`table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableCaption_()`
`void`	`tableCaption()`
`void`	`tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableCell_()`
`void`	`tableCell()`
`void`	`tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableCell(String width)`
`void`	`tableHeaderCell_()`
`void`	`tableHeaderCell()`
`void`	`tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableHeaderCell(String width)`
`void`	`tableRow_()`
`void`	`tableRow()`
`void`	`tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`tableRows_()`
`void`	`tableRows(int[] justification, boolean grid)`
`void`	`text(String text)`
`void`	`text(String text, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`time_()`
`void`	`time(String datetime)`
`void`	`time(String datetime, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`title_()`
`void`	`title()`
`void`	`title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`unknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`
`void`	`verbatim_()`
`void`	`verbatim(boolean boxed)`
`void`	`verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)`

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, init, unifyEOLs

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- WellformednessCheckingSink
```
public WellformednessCheckingSink()
```

Method Detail

head
```
public void head()
```

head_
```
public void head_()
```

body
```
public void body()
```

body_
```
public void body_()
```

article
```
public void article()
```

article_
```
public void article_()
```

navigation
```
public void navigation()
```

navigation_
```
public void navigation_()
```

sidebar
```
public void sidebar()
```

sidebar_
```
public void sidebar_()
```

section1
```
public void section1()
```

section1_
```
public void section1_()
```

section2
```
public void section2()
```

section2_
```
public void section2_()
```

section3
```
public void section3()
```

section3_
```
public void section3_()
```

section4
```
public void section4()
```

section4_
```
public void section4_()
```

section5
```
public void section5()
```

section5_
```
public void section5_()
```

section6
```
public void section6()
```

section6_
```
public void section6_()
```

header
```
public void header()
```

header_
```
public void header_()
```

content
```
public void content()
```

content_
```
public void content_()
```

footer
```
public void footer()
```

footer_
```
public void footer_()
```

list
```
public void list()
```

list_
```
public void list_()
```

listItem
```
public void listItem()
```

listItem_
```
public void listItem_()
```

numberedList

public void numberedList(int numbering)

numberedList_
```
public void numberedList_()
```

numberedListItem
```
public void numberedListItem()
```

numberedListItem_
```
public void numberedListItem_()
```

definitionList
```
public void definitionList()
```

definitionList_
```
public void definitionList_()
```

definitionListItem
```
public void definitionListItem()
```

definitionListItem_
```
public void definitionListItem_()
```

definition
```
public void definition()
```

definition_
```
public void definition_()
```

figure
```
public void figure()
```

figure_
```
public void figure_()
```

table
```
public void table()
```

table_
```
public void table_()
```

tableRows

public void tableRows(int[] justification,
             boolean grid)

tableRows_
```
public void tableRows_()
```

tableRow
```
public void tableRow()
```

tableRow_
```
public void tableRow_()
```

title
```
public void title()
```

title_
```
public void title_()
```

author
```
public void author()
```

author_
```
public void author_()
```

date
```
public void date()
```

date_
```
public void date_()
```

sectionTitle
```
public void sectionTitle()
```

sectionTitle_
```
public void sectionTitle_()
```

sectionTitle1
```
public void sectionTitle1()
```

sectionTitle1_
```
public void sectionTitle1_()
```

sectionTitle2
```
public void sectionTitle2()
```

sectionTitle2_
```
public void sectionTitle2_()
```

sectionTitle3
```
public void sectionTitle3()
```

sectionTitle3_
```
public void sectionTitle3_()
```

sectionTitle4
```
public void sectionTitle4()
```

sectionTitle4_
```
public void sectionTitle4_()
```

sectionTitle5
```
public void sectionTitle5()
```

sectionTitle5_
```
public void sectionTitle5_()
```

sectionTitle6
```
public void sectionTitle6()
```

sectionTitle6_
```
public void sectionTitle6_()
```

paragraph
```
public void paragraph()
```

paragraph_
```
public void paragraph_()
```

data
```
public void data(String value)
```

data_
```
public void data_()
```

time
```
public void time(String datetime)
```

time_
```
public void time_()
```

address
```
public void address()
```

address_
```
public void address_()
```

blockquote
```
public void blockquote()
```

blockquote_
```
public void blockquote_()
```

division
```
public void division()
```

division_
```
public void division_()
```

verbatim
```
public void verbatim(boolean boxed)
```

verbatim_
```
public void verbatim_()
```

definedTerm
```
public void definedTerm()
```

definedTerm_
```
public void definedTerm_()
```

figureCaption
```
public void figureCaption()
```

figureCaption_
```
public void figureCaption_()
```

tableCell
```
public void tableCell()
```

tableCell
```
public void tableCell(String width)
```

tableCell_
```
public void tableCell_()
```

tableHeaderCell
```
public void tableHeaderCell()
```

tableHeaderCell

public void tableHeaderCell(String width)

tableHeaderCell_
```
public void tableHeaderCell_()
```

tableCaption
```
public void tableCaption()
```

tableCaption_
```
public void tableCaption_()
```

figureGraphics

public void figureGraphics(String name)

horizontalRule
```
public void horizontalRule()
```

pageBreak
```
public void pageBreak()
```

anchor
```
public void anchor(String name)
```

anchor_
```
public void anchor_()
```

link
```
public void link(String name)
```

link_
```
public void link_()
```

inline
```
public void inline()
```

inline_
```
public void inline_()
```

italic
```
public void italic()
```

italic_
```
public void italic_()
```

bold
```
public void bold()
```

bold_
```
public void bold_()
```

monospaced
```
public void monospaced()
```

monospaced_
```
public void monospaced_()
```

lineBreak
```
public void lineBreak()
```

lineBreakOpportunity
```
public void lineBreakOpportunity()
```

nonBreakingSpace
```
public void nonBreakingSpace()
```

text
```
public void text(String text)
```

rawText
```
public void rawText(String text)
```

comment
```
public void comment(String comment)
```

flush
```
public void flush()
```

close
```
public void close()
```

isWellformed
```
public boolean isWellformed()
```
Finds out wether the wellformedness-contraints of the model have been violated.

Returns:
false for non-wellformed models

getOffender
```
public String getOffender()
```
Gets the offending element that breaks the wellformedness as well as the exepected element.

Returns:
the expected and acual elements

getOffenders
```
public List<String> getOffenders()
```
Gets the list of errors found during wellformedness-check

Returns:
a list of String of error messages

head

public void head(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

title

public void title(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

author

public void author(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

date

public void date(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

body

public void body(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

article

public void article(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

navigation

public void navigation(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

sidebar

public void sidebar(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

section

public void section(int level,
           org.apache.maven.doxia.sink.SinkEventAttributes attributes)

section_
```
public void section_(int level)
```

sectionTitle

public void sectionTitle(int level,
                org.apache.maven.doxia.sink.SinkEventAttributes attributes)

sectionTitle_
```
public void sectionTitle_(int level)
```

header

public void header(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

content

public void content(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

footer

public void footer(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

list

public void list(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

listItem

public void listItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

numberedList

public void numberedList(int numbering,
                org.apache.maven.doxia.sink.SinkEventAttributes attributes)

numberedListItem

public void numberedListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

definitionList

public void definitionList(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

definitionListItem

public void definitionListItem(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

definition

public void definition(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

definedTerm

public void definedTerm(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

figure

public void figure(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

figureCaption

public void figureCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

figureGraphics

public void figureGraphics(String src,
                  org.apache.maven.doxia.sink.SinkEventAttributes attributes)

table

public void table(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

tableRow

public void tableRow(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

tableCell

public void tableCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

tableHeaderCell

public void tableHeaderCell(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

tableCaption

public void tableCaption(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

paragraph

public void paragraph(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

data

public void data(String value,
        org.apache.maven.doxia.sink.SinkEventAttributes attributes)

time

public void time(String datetime,
        org.apache.maven.doxia.sink.SinkEventAttributes attributes)

address

public void address(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

blockquote

public void blockquote(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

division

public void division(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

verbatim

public void verbatim(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

horizontalRule

public void horizontalRule(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

anchor

public void anchor(String name,
          org.apache.maven.doxia.sink.SinkEventAttributes attributes)

link

public void link(String name,
        org.apache.maven.doxia.sink.SinkEventAttributes attributes)

inline

public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

lineBreak

public void lineBreak(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

lineBreakOpportunity

public void lineBreakOpportunity(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

text

public void text(String text,
        org.apache.maven.doxia.sink.SinkEventAttributes attributes)

unknown

public void unknown(String name,
           Object[] requiredParams,
           org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Class WellformednessCheckingSink

Field Summary

Fields inherited from interface org.apache.maven.doxia.sink.Sink

Fields inherited from interface org.apache.maven.doxia.markup.Markup

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink

Methods inherited from class java.lang.Object

Constructor Detail

WellformednessCheckingSink

Method Detail

head

head_

body

body_

article

article_

navigation

navigation_

sidebar

sidebar_

section1

section1_

section2

section2_

section3

section3_

section4

section4_

section5

section5_

section6

section6_

header

header_

content

content_

footer

footer_

list

list_

listItem

listItem_

numberedList

numberedList_

numberedListItem

numberedListItem_

definitionList

definitionList_

definitionListItem

definitionListItem_

definition

definition_

figure

figure_

table

table_

tableRows

tableRows_

tableRow

tableRow_

title

title_

author

author_

date

date_

sectionTitle

sectionTitle_

sectionTitle1

sectionTitle1_

sectionTitle2

sectionTitle2_

sectionTitle3

sectionTitle3_

sectionTitle4

sectionTitle4_

sectionTitle5

sectionTitle5_

sectionTitle6