/*******************************************************************************
 * 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.BufferedReader;
import java.io.IOException;

/**
 * htmlをパースするためのクラスのインタフェース。
 * 
 * @author IGA Tosiki
 */
public interface BlancoHtmlParser {
    /**
     * パースの際に利用するリーダー。
     * 
     * @return リーダー。
     */
    BufferedReader getReader();

    /**
     * HTML コンテンツ・ハンドラーをセットします。
     * 
     * @param handler
     *            HTMLハンドラーオブジェクト。
     */
    void setHandler(BlancoHtmlContentHandler handler);

    /**
     * HTML コンテンツ・ハンドラーを取得します。
     * 
     * @return HTMLハンドラーオブジェクト。
     */
    BlancoHtmlContentHandler getHandler();

    /**
     * パースの際に利用する文字エンコーディングを設定します。
     * 
     * @param encoding
     *            文字エンコーディング。
     */
    void setEncoding(String encoding);

    /**
     * パースの際に利用する文字エンコーディングを取得します。
     * 
     * @return 文字エンコーディング。
     */
    String getEncoding();

    /**
     * 与えられたhtmlをパースします。
     * 
     * @param argInputHtml
     *            入力html。
     */
    void parse(byte[] argInputHtml) throws IOException;

    /**
     * 与えられたhtmlをパースします。
     * 
     * @param reader
     *            入力htmlのリーダー。
     */
    void parse(final BufferedReader reader) throws IOException;
}
