org.attoparser.AbstractAttoParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of attoparser Show documentation
Powerful, fast and easy to use HTML and XML parser for Java
There is a newer version: 2.0.7.RELEASE
/*
 * =============================================================================
 * 
 *   Copyright (c) 2012, The ATTOPARSER team (http://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
 * 
 *       http://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;

import java.io.CharArrayReader;
import java.io.Reader;
import java.io.StringReader;




/**
 * 
 *   Base abstract class for all {@link IAttoParser} implementations, providing
 *   common code for unifying all the supported document formats (String, char[],
 *   char[] segment, Reader) into just one (Reader).
 * 
 * 
 *   Subclasses of this class should only implement the abstract
 *   {@link #parseDocument(Reader, IAttoHandler)} method.
 * 
 * 
 * @author Daniel Fernández
 * 
 * @since 1.0
 *
 */
public abstract class AbstractAttoParser implements IAttoParser {


    
    
    protected AbstractAttoParser() {
        super();
    }
    

    
    
    public final void parse(final String document, final IAttoHandler handler) 
            throws AttoParseException  {
        parse(new StringReader(document), handler);
    }
    
    public final void parse(final char[] document, final IAttoHandler handler) 
            throws AttoParseException {
        parse(new CharArrayReader(document), handler);
    }
    
    public final void parse(
            final char[] document, final int offset, final int len, final IAttoHandler handler) 
            throws AttoParseException {
        if (offset < 0 || len < 0) {
            throw new IllegalArgumentException(
                    "Neither document offset (" + offset + ") nor document length (" + 
                    len + ") can be less than zero");
        }
        parse(new CharArrayReader(document, offset, len), handler);
    }
    
    public final void parse(
            final Reader reader, final IAttoHandler handler) 
            throws AttoParseException {
        if (reader == null) {
            throw new IllegalArgumentException("Reader cannot be null");
        }
        if (handler == null) {
            throw new IllegalArgumentException("Handler cannot be null");
        }
        parseDocument(reader, handler);
    }
    

    /**
     * 
     *   Parse the document, as a {@link Reader}.
     * 
     * 
     *   This method is meant for overriding, and is the only parsing method
     *   that subclasses need to implement. 
     * 
     * 
     * @param reader a Reader on the document.
     * @param handler the handler to be used, an {@link IAttoHandler} implementation.
     * @throws AttoParseException if the document cannot be parsed.
     */
    protected abstract void parseDocument(
            final Reader reader, final IAttoHandler handler)
            throws AttoParseException;
    
}