org.htmlparser.util.EncodingChangeException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of htmllexer Show documentation
HTML Lexer is the low level lexical analyzer.
The newest version!
// HTMLParser Library - A java-based parser for HTML
// http://htmlparser.org
// Copyright (C) 2006 Claude Duguay
//
// Revision Control Information
//
// $URL: https://htmlparser.svn.sourceforge.net/svnroot/htmlparser/tags/HTMLParserProject-2.1/lexer/src/main/java/org/htmlparser/util/EncodingChangeException.java $
// $Author: derrickoswald $
// $Date: 2007-03-04 20:24:09 +0100 (Sun, 04 Mar 2007) $
// $Revision: 29 $
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Common Public License; either
// version 1.0 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// Common Public License for more details.
//
// You should have received a copy of the Common Public License
// along with this library; if not, the license is available from
// the Open Source Initiative (OSI) website:
//   http://opensource.org/licenses/cpl1.0.php

package org.htmlparser.util;

/**
 * The encoding is changed invalidating already scanned characters.
 * When the encoding is changed, as for example when encountering a <META>
 * tag that includes a charset directive in the content attribute that
 * disagrees with the encoding specified by the HTTP header (or the default
 * encoding if none), the parser retraces the bytes it has interpreted so far
 * comparing the characters produced under the new encoding. If the new
 * characters differ from those it has already yielded to the application, it
 * throws this exception to indicate that processing should be restarted under
 * the new encoding.
 * This exception is the object thrown so that applications may distinguish
 * between an encoding change, which may be successfully cured by restarting
 * the parse from the beginning, from more serious errors.
 * @see IteratorImpl
 * @see ParserException
 **/
public class EncodingChangeException
    extends
        ParserException
{
    /**
     * The old encoding.
     */
    private String mOldEncoding;

    /**
     * The new encoding.
     */
    private String mNewEncoding;

    /**
     * Create an exception idicative of a problematic encoding change.
     * @param message The message describing the error condifion.
     * @param oldEncoding The encoding prior to the exception.
     * @param newEncoding The encoding that was attempted.
     */
    public EncodingChangeException (String message, String oldEncoding,
                                    String newEncoding)
    {
        super(message);
        mOldEncoding = oldEncoding;
        mNewEncoding = newEncoding;
    }

    /**
     * Gets the old encoding.
     * @return the old encoding.
     */
    public String getOldEncoding ()
    {
        return (mOldEncoding);
    }

    /**
     * Gets the new encoding.
     * @return the new encoding.
     */
    public String getNewEncoding ()
    {
        return (mNewEncoding);
    }
}