org.attoparser.ICommentHandler Maven / Gradle / Ivy
Show all versions of attoparser Show documentation
/*
* =============================================================================
*
* Copyright (c) 2012-2022, The ATTOPARSER team (https://www.attoparser.org)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* =============================================================================
*/
package org.attoparser;
/**
*
* Interface to be implemented by all handlers capable of receiving events about Comments.
*
*
* Events in this interface are a part of the {@link IMarkupHandler} interface, the main handling interface in
* AttoParser.
*
*
* @author Daniel Fernández
* @since 2.0.0
* @see org.attoparser.IMarkupHandler
*
*/
public interface ICommentHandler {
/**
*
* 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.
*
*
* @param buffer the document buffer (not copied)
* @param contentOffset offset for the content partition.
* @param contentLen length of the content partition.
* @param outerOffset offset for the outer partition.
* @param outerLen length of the outer partition.
* @param line the line in the original document where this artifact starts.
* @param col the column in the original document where this artifact starts.
* @throws ParseException if any exceptions occur during handling.
*/
public void handleComment(
final char[] buffer,
final int contentOffset, final int contentLen,
final int outerOffset, final int outerLen,
final int line, final int col)
throws ParseException;
}