org.attoparser.markup
Interface ICommentHandling

All Known Implementing Classes:
AbstractBasicMarkupAttoHandler, AbstractDetailedMarkupAttoHandler, AbstractDetailedNonValidatingHtmlAttoHandler, AbstractDetailedXmlAttoHandler, AbstractStandardMarkupAttoHandler, AbstractStandardNonValidatingHtmlAttoHandler, AbstractStandardXmlAttoHandler, DOMXmlAttoHandler, DuplicatingBasicMarkupAttoHandler, DuplicatingDetailedMarkupAttoHandler, HtmlCodeDisplayAttoHandler, TextTracingBasicMarkupAttoHandler, TextTracingDetailedHtmlAttoHandler, TextTracingDetailedMarkupAttoHandler, TextTracingStandardMarkupAttoHandler, TracingDetailedHtmlAttoHandler, TracingDetailedMarkupAttoHandler

public interface ICommentHandling

Handler feature interface to be implemented by IAttoHandler implementations that offer reporting of markup comments.

Since:
1.0
Author:
Daniel Fernández

Method Summary
 void handleComment(char[] buffer, int contentOffset, int contentLen, int outerOffset, int outerLen, int line, int col)
           Called when a comment is found.
 

Method Detail

handleComment

void handleComment(char[] buffer,
                   int contentOffset,
                   int contentLen,
                   int outerOffset,
                   int outerLen,
                   int line,
                   int col)
                   throws AttoParseException

Called when a comment is found.

Two [offset, len] pairs are provided for two partitions (outer and content):

<!-- this is a comment -->
|   [CONTENT----------]  |
[OUTER-------------------]

Artifacts are reported using the document buffer directly, and this buffer should not be considered to be immutable, so reported structures should be copied if they need to be stored (either by copying len chars from the buffer char[] starting in offset or by creating a String from it using the same specification).

Implementations of this handler should never modify the document buffer.

Parameters:
buffer - the document buffer (not copied)
contentOffset - offset for the content partition.
contentLen - length of the content partition.
outerOffset - offset for the outer partition.
outerLen - length of the outer partition.
line - the line in the original document where this artifact starts.
col - the column in the original document where this artifact starts.
Throws:
AttoParseException


Copyright © 2013 The ATTOPARSER team. All Rights Reserved.