/*******************************************************************************
 * Copyright (c) 2008 IGA Tosiki, NTT DATA BUSINESS BRAINS Corp.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    IGA Tosiki (NTT DATA BUSINESS BRAINS Corp.) - initial API and implementation
 *******************************************************************************/
/*
 * blanco Framework
 * Copyright (C) 2008 NTT DATA BUSINESS BRAINS CORPORATION
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 */
package blanco.html.parser;

import java.io.IOException;
import java.util.List;

import blanco.html.parser.valueobject.BlancoHtmlAttribute;

/**
 * HTML を SAX のようにパースするコンテンツ・ハンドラー。
 * 
 * @author IGA Tosiki
 */
public interface BlancoHtmlContentHandler {
    /**
     * ドキュメントの開始。
     * 
     * @throws IOException
     */
    public void startDocument() throws IOException;

    /**
     * ドキュメントの終了。
     * 
     * @throws IOException
     */
    public void endDocument() throws IOException;

    /**
     * 要素の開始。
     * 
     * HTMLという特性のため、start と end とが必ずしも対に発生しません。
     * 
     * @param name
     *            要素名。
     * @param attributes
     *            属性のリスト。
     */
    public void startElement(final String name,
            final List<BlancoHtmlAttribute> attrs) throws IOException;

    /**
     * 要素の終了。
     * 
     * HTMLという特性のため、start と end とが必ずしも対に発生しません。
     * 
     * @param name
     *            要素名。
     */
    public void endElement(final String name) throws IOException;

    /**
     * 文字列。実体参照などの処理がされていない文字列が「そのまま」戻ります。
     * 
     * @param argCharacters
     */
    public void characters(final String argCharacters) throws IOException;

    /**
     * コメント。そのままの文字列が戻ります。
     * 
     * @param argComments
     * @param argType
     *            0:!、1:%
     */
    public void comments(final String argComments, final int argType)
            throws IOException;
}
