Package org.apache.maven.doxia.sink.impl

Class SinkWrapper

java.lang.Object
org.apache.maven.doxia.sink.impl.AbstractSink
org.apache.maven.doxia.sink.impl.SinkWrapper
All Implemented Interfaces:
AutoCloseable, Markup, Sink
Direct Known Subclasses:
IndexingSink, RandomAccessSink, UniqueAnchorNamesValidator
public class SinkWrapper extends AbstractSink
By default a SinkWrapper just delegates each method to the wrapped sink's method. For certain sink methods a derived wrapper may modify the sink before/after or instead of calling the delegate's method. Sink wrappers can either be registered manually via Parser.addSinkWrapperFactory(SinkWrapperFactory) or are automatically registered if provided as JSR330 component. In addition Sink wrappers can be used programmatically without an according factory.
Since:
2.0.0

  • Constructor Details

  • Method Details

    • getWrappedSink

      public Sink getWrappedSink()

    • setWrappedSink

      public void setWrappedSink(Sink sink)

    • head

      public void head(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts the head element.

      This contains information about the current document, (eg its title) that is not considered document content. The head element is optional but if it exists, it has to be unique within a sequence of Sink events that produces one output document, and it has to come before the Sink.body(SinkEventAttributes) element.

      The canonical sequence of events for the head element is: 

         sink.head();

   sink.title();
   sink.text("Title");
   sink.title_();

   sink.author();
   sink.text("Author");
   sink.author_();

   sink.date();
   sink.text("Date");
   sink.date_();

   sink.head_();

      but none of the enclosed events is required. However, if they exist they have to occur in the order shown, and the title() and date() events have to be unique (author() events may occur any number of times).

      Supported attributes are:

      PROFILE, LANG.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • head_

      public void head_()
      Description copied from interface: Sink
      Ends the head element.

    • title

      public void title(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts the title element. This is used to identify the document.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • title_

      public void title_()
      Description copied from interface: Sink
      Ends the title element.

    • author

      public void author(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts an author element. This is used to identify the author of the document.

      Supported attributes are: EMAIL.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • author_

      public void author_()
      Description copied from interface: Sink
      Ends an author element.

    • date

      public void date(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts the date element. This is used to identify the date of the document: there is no strict definition if it is creation date or last modification date, which are the 2 classical semantics. There is no formal formatting requirements either.
      The date is recommended (but it is not a requirement) to be aligned to the ISO-8601 standard, i.e.: 
      YYYY-MM-DD
      where
      • YYYY is the year in the Gregorian calendar,
      • MM is the month of the year between 01 (January) and 12 (December),
      • and DD is the day of the month between 01 and 31.

      Supported attributes are: none.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • date_

      public void date_()
      Description copied from interface: Sink
      Ends the date element.

    • body

      public void body(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts the body of a document. This contains the document's content.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • body_

      public void body_()
      Description copied from interface: Sink
      Ends the body element.

    • article

      public void article(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts an article within a document.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • article_

      public void article_()
      Description copied from interface: Sink
      Ends the article element.

    • sidebar

      public void sidebar(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a sidebar section within a document.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • section

      public void section(int level, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Start a new section at the given level.

      Sections with higher level have to be entirely contained within sections of lower level.

      Supported attributes are the base attributes.

      Parameters:
      level - the section level (must be a value between 1 and 6).
      attributes - A set of SinkEventAttributes, may be null.

    • section_

      public void section_(int level)
      Description copied from interface: Sink
      Ends a section at the given level.
      Parameters:
      level - the section level (must be a value between 1 and 6).

    • sectionTitle

      public void sectionTitle(int level, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Start a new section title at the given level.

      This element is optional, but if it exists, it has to be contained, and be the first element, within a corresponding section element of the same level.

      NOTE: It is strongly recommended not to make section titles implicit anchors. Neither Parsers nor Sinks should insert any content that is not explicitly present in the original source document, as this would lead to undefined behaviour for multi-format processing chains. However, while Parsers must never emit anchors for section titles, some specialized Sinks may implement such a feature if the resulting output documents are not going to be further processed (and this is properly documented).

      Supported attributes are the base attributes plus ALIGN.

      Parameters:
      level - the section title level (must be a value between 1 and 6).
      attributes - A set of SinkEventAttributes, may be null.

    • sectionTitle_

      public void sectionTitle_(int level)
      Description copied from interface: Sink
      Ends a section title at the given level.
      Parameters:
      level - the section title level (must be a value between 1 and 6).

    • header

      public void header(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Start a new header within the section or body.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • header_

      public void header_()
      Description copied from interface: Sink
      Ends a header element.

    • content

      public void content(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Start the main content section between the header and the footer within the sections and/or body.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • content_

      public void content_()
      Description copied from interface: Sink
      Ends a main content section.

    • footer

      public void footer(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Start a new footer within the section or body.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • list

      public void list(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts an unordered list.

      Supported attributes are the base attributes.

      A list must contain at least one Sink.listItem(SinkEventAttributes) or Sink.listItem() as direct successor of this method.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • list_

      public void list_()
      Description copied from interface: Sink
      Ends an unordered list element.

    • listItem

      public void listItem(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a list item element within an unordered list.

      Supported attributes are the base attributes.

      Nested lists must have the following Sink method sequence:
      1. Sink.listItem(SinkEventAttributes) or Sink.listItem()
      2. Sink.list(SinkEventAttributes) or Sink.list()
      3. Sink.listItem(SinkEventAttributes) or Sink.listItem()
      4. ...
      5. Sink.listItem_()
      6. Sink.list_()
      7. ...
      8. Sink.listItem_()
      9. Sink.list_()
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • listItem_

      public void listItem_()
      Description copied from interface: Sink
      Ends a list item element within an unordered list.

    • numberedList

      public void numberedList(int numbering, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts an ordered list element.

      Supported attributes are the base attributes.

      A list must contain at least one Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem() as direct successor of this method.
      Parameters:
      numbering - the numbering style.
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • numberedList_

      public void numberedList_()
      Description copied from interface: Sink
      Ends an ordered list element.

    • numberedListItem

      public void numberedListItem(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a list item element within an ordered list.

      Supported attributes are the base attributes.

      Nested lists must have the following Sink method sequence:
      1. Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem()
      2. Sink.numberedList(int,SinkEventAttributes) or Sink.numberedList(int)
      3. Sink.numberedListItem(SinkEventAttributes) or Sink.numberedListItem()
      4. ...
      5. Sink.numberedListItem_()
      6. Sink.numberedList_()
      7. ...
      8. Sink.numberedListItem_()
      9. Sink.numberedList_()
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • numberedListItem_

      public void numberedListItem_()
      Description copied from interface: Sink
      Ends a list item element within an ordered list.

    • definitionList

      public void definitionList(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a definition list.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • definitionList_

      public void definitionList_()
      Description copied from interface: Sink
      Ends a definition list element.

    • definitionListItem

      public void definitionListItem(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a list item element within a definition list.

      Every definitionListItem has to contain exactly one Sink.definedTerm(SinkEventAttributes) and one Sink.definition(SinkEventAttributes), in this order.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • definitionListItem_

      public void definitionListItem_()
      Description copied from interface: Sink
      Ends a list item element within a definition list.

    • definition

      public void definition(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a definition element within a definition list.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • definition_

      public void definition_()
      Description copied from interface: Sink
      Ends a definition element within a definition list.

    • definedTerm

      public void definedTerm(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a definition term element within a definition list.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • definedTerm_

      public void definedTerm_()
      Description copied from interface: Sink
      Ends a definition term element within a definition list.

    • figure

      public void figure(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a basic image embedding element.

      The canonical sequence of events for the figure element is: 

         sink.figure();

   sink.figureGraphics("figure.png");

   sink.figureCaption();
   sink.text("Figure caption",);
   sink.figureCaption_();

   sink.figure_();

      where the figureCaption element is optional.

      However, NOTE that the order of figureCaption and figureGraphics events is arbitrary, ie a parser may emit the figureCaption before or after the figureGraphics. Implementing sinks should be prepared to handle both possibilities.

      NOTE also that the figureGraphics() event does not have to be embedded inside figure(), in particular for in-line images the figureGraphics() should be used stand-alone (in HTML language, figureGraphics() produces a <img> tag, while figure() opens a paragraph- or <div>- like environment).

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • figure_

      public void figure_()
      Description copied from interface: Sink
      Ends a basic image embedding element.

    • figureCaption

      public void figureCaption(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a figure caption.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • figureCaption_

      public void figureCaption_()
      Description copied from interface: Sink
      Ends a caption of an image.

    • figureGraphics

      public void figureGraphics(String src, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Adds a graphic element.

      The src parameter should be a valid link, ie it can be an absolute URL or a link relative to the current source document.

      Supported attributes are the base attributes plus:

      SRC, ALT, WIDTH, HEIGHT, ALIGN, BORDER, HSPACE, VSPACE, ISMAP, USEMAP.

      If the SRC attribute is specified in SinkEventAttributes, it will be overridden by the src parameter.

      Parameters:
      src - the image source, a valid URL.
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • table

      public void table(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a table.

      The canonical sequence of events for the table element is: 

         sink.table();

   sink.tableRows(justify, true);

   sink.tableRow();
   sink.tableCell();
   sink.text("cell 1,1");
   sink.tableCell_();
   sink.tableCell();
   sink.text("cell 1,2");
   sink.tableCell_();
   sink.tableRow_();

   sink.tableRows_();

   sink.tableCaption();
   sink.text("Table caption");
   sink.tableCaption_();

   sink.table_();

      where the tableCaption element is optional.

      However, NOTE that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

      Supported attributes are the base attributes plus:

      ALIGN, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, FRAME, RULES, SUMMARY, WIDTH.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • table_

      public void table_()
      Description copied from interface: Sink
      Ends a table element.

    • tableRows

      public void tableRows(int[] justification, boolean grid)
      Description copied from interface: Sink
      Starts an element that contains rows of table data.
      Parameters:
      justification - the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells. Each element of the array must be one of the following constants: Sink.JUSTIFY_LEFT, Sink.JUSTIFY_CENTER, Sink.JUSTIFY_RIGHT or Sink.JUSTIFY_DEFAULT.
      grid - true to render a grid, false otherwise.
      See Also:

    • tableRows_

      public void tableRows_()
      Description copied from interface: Sink
      Ends an element that contains rows of table data.

    • tableRow

      public void tableRow(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a table row.

      Supported attributes are the base attributes plus:

      ALIGN, BGCOLOR, VALIGN.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • tableRow_

      public void tableRow_()
      Description copied from interface: Sink
      Ends a row element.

    • tableCell

      public void tableCell(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a table cell.

      Supported attributes are the base attributes plus:

      ABBRV, ALIGN, AXIS, BGCOLOR, COLSPAN, HEADERS, HEIGHT, NOWRAP, ROWSPAN, SCOPE, VALIGN, WIDTH.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • tableCell_

      public void tableCell_()
      Description copied from interface: Sink
      Ends a cell element.

    • tableHeaderCell

      public void tableHeaderCell(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a table header cell.

      Supported attributes are the same as for tableCell.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • tableHeaderCell_

      public void tableHeaderCell_()
      Description copied from interface: Sink
      Ends a cell header element.

    • tableCaption

      public void tableCaption(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a table caption.

      Note that the order of tableCaption and Sink.tableRows(int[],boolean) events is arbitrary, ie a parser may emit the tableCaption before or after the tableRows. Implementing sinks should be prepared to handle both possibilities.

      Supported attributes are the base attributes plus ALIGN.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • tableCaption_

      public void tableCaption_()
      Description copied from interface: Sink
      Ends a caption element of a table.

    • paragraph

      public void paragraph(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a paragraph.

      Supported attributes are the base attributes plus ALIGN.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • paragraph_

      public void paragraph_()
      Description copied from interface: Sink
      Ends a paragraph element.

    • data

      public void data(String value, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a data element which groups together other elements representing microformats.

      Supported attributes are the base attributes plus VALUE.

      Parameters:
      value - the machine readable value of the data, may be null.
      attributes - A set of SinkEventAttributes, may be null.

    • data_

      public void data_()
      Description copied from interface: Sink
      Ends an data element.

    • time

      public void time(String datetime, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a time element which groups together other elements representing a time.

      Supported attributes are the base attributes plus DATETIME.

      Parameters:
      datetime - the machine readable value of the time, may be null.
      attributes - A set of SinkEventAttributes, may be null.

    • time_

      public void time_()
      Description copied from interface: Sink
      Ends a time element.

    • address

      public void address(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts an address element.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • address_

      public void address_()
      Description copied from interface: Sink
      Ends an address element.

    • blockquote

      public void blockquote(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a blockquote element.

      Supported attributes are the base attributes.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • blockquote_

      public void blockquote_()
      Description copied from interface: Sink
      Ends an blockquote element.

    • division

      public void division(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a division element grouping together other elements.

      Supported attributes are the base attributes plus ALIGN.

      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • division_

      public void division_()
      Description copied from interface: Sink
      Ends a division element.

    • verbatim

      public void verbatim(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a verbatim block, ie a block where whitespace has semantic relevance.

      Text in a verbatim block must only be wrapped at the linebreaks in the source, and spaces should not be collapsed. It should be displayed in a fixed-width font to retain the formatting but the overall size may be chosen by the implementation.

      Most Sink events may be emitted within a verbatim block, the only elements explicitly forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.

      Supported attributes are the base attributes plus:

      DECORATION (values: "source"), ALIGN, WIDTH.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • verbatim_

      public void verbatim_()
      Description copied from interface: Sink
      Ends a verbatim element.

    • horizontalRule

      public void horizontalRule(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Adds a horizontal separator rule.

      Supported attributes are the base attributes plus:

      ALIGN, NOSHADE, SIZE, WIDTH.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • pageBreak

      public void pageBreak()
      Description copied from interface: Sink
      Adds a new page separator.

    • anchor

      public void anchor(String name, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts an element which defines an anchor.

      The name parameter has to be a valid SGML NAME token. According to the HTML 4.01 specification section 6.2 SGML basic types:

      ID and NAME tokens must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").

      Supported attributes are the base attributes. If NAME is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

      Parameters:
      name - the name of the anchor. This has to be a valid SGML NAME token.
      attributes - A set of SinkEventAttributes, may be null.

    • anchor_

      public void anchor_()
      Description copied from interface: Sink
      Ends an anchor element.

    • link

      public void link(String name, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts a link.

      The name parameter has to be a valid URI according to RFC 3986, i.e. for internal links (links to an anchor within the same source document), name should start with the character "#". This also implies that all unsafe characters are already encoded.

      Supported attributes are the base attributes plus:

      CHARSET, COORDS, HREF, HREFLANG, REL, REV, SHAPE, TARGET, TYPE.

      If HREF is specified in the SinkEventAttributes, it will be overwritten by the name parameter.

      Parameters:
      name - the name of the link.
      attributes - A set of SinkEventAttributes, may be null.
      See Also:

    • inline

      public void inline(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Starts an inline element.

      The inline method is similar to Sink.text(String,SinkEventAttributes), but allows you to wrap arbitrary elements in addition to text.

      Supported attributes are the base attributes plus

      SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • inline_

      public void inline_()
      Description copied from interface: Sink
      Ends an inline element.

    • italic

      public void italic()
      Description copied from interface: Sink
      Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

    • italic_

      public void italic_()
      Description copied from interface: Sink
      Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

    • bold

      public void bold()
      Description copied from interface: Sink
      Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

    • bold_

      public void bold_()
      Description copied from interface: Sink
      Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

    • monospaced

      public void monospaced()
      Description copied from interface: Sink
      Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

    • monospaced_

      public void monospaced_()
      Description copied from interface: Sink
      Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

    • lineBreak

      public void lineBreak(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Adds a line break.

      Supported attributes are:

      ID, CLASS, TITLE, STYLE.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • lineBreakOpportunity

      public void lineBreakOpportunity(SinkEventAttributes attributes)
      Description copied from interface: Sink
      Adds a line break opportunity.

      Supported attributes are:

      ID, CLASS, TITLE, STYLE.
      Parameters:
      attributes - A set of SinkEventAttributes, may be null.

    • nonBreakingSpace

      public void nonBreakingSpace()
      Description copied from interface: Sink
      Adds a non breaking space, ie a space without any special formatting operations.

    • text

      public void text(String text, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Adds a text.

      The text parameter should contain only real content, ie any ignorable/collapsable whitespace/EOLs or other pretty-printing should be removed/normalized by a parser.

      If text contains any variants of line terminators, they should be normalized to the System EOL by an implementing Sink.

      Supported attributes are the base attributes plus

      SEMANTICS (values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").

      The following attributes are deprecated:

      VALIGN (values "sub", "sup"), DECORATION (values "underline", "overline", "line-through"), STYLE (values "italic", "bold", "monospaced").
      Parameters:
      text - The text to write.
      attributes - A set of SinkEventAttributes, may be null.

    • rawText

      public void rawText(String text)
      Description copied from interface: Sink
      Adds a raw text, ie a text without any special formatting operations.
      Parameters:
      text - The text to write.

    • comment

      public void comment(String comment)
      Description copied from interface: Sink
      Adds a comment (a text that should not be rendered but may be visible in the source of the output document).
      Parameters:
      comment - The comment to write.

    • markupLineBreak

      public void markupLineBreak(int indentLevel)
      Description copied from interface: Sink
      Adds a single line break with the specified indentation level. The default implementation does nothing. This is different from emitting a line break with Sink.lineBreak(SinkEventAttributes) or Sink.text(String, SinkEventAttributes) as those line breaks are part of the content (i.e. affect rendering) while this line break is purely for pretty-printing the Sink's output and should not affect the rendering of the content. This is useful for Sinks that emit text-based markup languages (e.g. HTML, XML, etc.) to produce more human-readable output.
      Parameters:
      indentLevel - the indentation level, where 0 means no indentation, 1 means one level of indentation, etc. The sink can decide how many spaces/tabs to use for each level of indentation.

    • unknown

      public void unknown(String name, Object[] requiredParams, SinkEventAttributes attributes)
      Description copied from interface: Sink
      Adds an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc.
      Parameters:
      name - The name of the event.
      requiredParams - An optional array of required parameters to the event. May be null.
      attributes - A set of SinkEventAttributes, may be null.

    • flush

      public void flush()
      Description copied from interface: Sink
      Flushes the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.

    • close

      public void close()
      Description copied from interface: Sink
      Closes the writer or the stream, if needed. Closing a previously-closed Sink has no effect.

    • setDocumentLocator

      public void setDocumentLocator(Locator locator)
      Description copied from interface: Sink
      Sets the locator which exposes location information for a particular Sink event.
      Specified by:
      setDocumentLocator in interface Sink
      Overrides:
      setDocumentLocator in class AbstractSink
      Parameters:
      locator - the locator (never null).

    • getDocumentLocator

      public Locator getDocumentLocator()
      Description copied from interface: Sink
      Returns the locator which exposes location information for a particular Sink event.
      Specified by:
      getDocumentLocator in interface Sink
      Overrides:
      getDocumentLocator in class AbstractSink
      Returns:
      the locator (never null).