org.jplate.foundation.parser.javacc.impl
Class AbstractJavaccParser<B extends JPlateBuilderIfc<?>>

java.lang.Object
  org.jplate.foundation.parser.javacc.impl.AbstractJavaccParser<B>

Type Parameters:

B - A JPlate builder used to build things as tokens are parsed.

All Implemented Interfaces:

JavaccParserIfc<B>, JPlateParserIfc<B>

Direct Known Subclasses:

DefaultCdvParser, DefaultJPlateCsvParser, DefaultKvpParser, DefaultRfc4180CsvParser, DefaultTdvParser

public abstract class AbstractJavaccParser<B extends JPlateBuilderIfc<?>>
extends java.lang.Object
implements JavaccParserIfc<B>

Abstract base class of JavaCC derived parsers. Subclasses should not be created using the JavaCC static flag. Essentially this base class provides all the necessary "plumbing" to parse input streams, readers, files and strings - thereby requiring subclasses to only implement the parse(JPlateBuilderIfc) method.

Modifications:
    $Date: 2008-12-02 12:32:45 -0500 (Tue, 02 Dec 2008) $
    $Revision: 479 $
    $Author: sfloess $
    $HeadURL: https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/src/dev/java/org/jplate/foundation/parser/javacc/impl/AbstractJavaccParser.java $
    

Field Summary

private org.apache.commons.logging.Log

_log Used for logging.

Fields inherited from interface org.jplate.foundation.parser.javacc.JavaccParserIfc

BUILDER_IS_NULL_MSG, FILE_DOES_NOT_EXIST_MSG, FILE_IS_NULL_MSG, INPUT_STREAM_IS_NULL_MSG, READER_IS_NULL_MSG, STRING_IS_EMPTY_MSG

Constructor Summary

AbstractJavaccParser()

Method Summary

protected abstract void	parse(B builder) Is called by self to start parsing.
void	parse(java.io.File file, B builder) This method is called to parse data from file.
void	parse(java.io.InputStream inputStream, B builder) This method is called to parse data from inputStream.
void	parse(java.io.Reader reader, B builder) This method is called to parse data from reader.
void	parse(java.lang.String string, B builder) This method is called to parse data from string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jplate.foundation.parser.javacc.JavaccParserIfc

ReInit, ReInit, ReInit

Field Detail

_log

private final transient org.apache.commons.logging.Log _log

Used for logging.

Constructor Detail

AbstractJavaccParser

public AbstractJavaccParser()

Method Detail

parse

public void parse(java.io.Reader reader,
                  B builder)
           throws JPlateParsingException

This method is called to parse data from reader.

Specified by:

parse in interface JPlateParserIfc<B extends JPlateBuilderIfc<?>>

Parameters:

reader - Contains data to be parsed.

builder - A builder who can construct things on behalf of self.

Throws:

JPlateParsingException - If any problems arise parsing from reader.

parse

public void parse(java.io.InputStream inputStream,
                  B builder)
           throws JPlateParsingException

This method is called to parse data from inputStream.

Specified by:

parse in interface JPlateParserIfc<B extends JPlateBuilderIfc<?>>

Parameters:

inputStream - A stream containing data to be parsed.

builder - A builder who can construct things on behalf of self.

Throws:

JPlateParsingException - If any problems arise parsing from inputStream.

parse

public void parse(java.lang.String string,
                  B builder)
           throws JPlateParsingException

This method is called to parse data from string.

Specified by:

parse in interface JPlateParserIfc<B extends JPlateBuilderIfc<?>>

Parameters:

string - A string containing data to be parsed.

builder - A builder who can construct things on behalf of self.

Throws:

JPlateParsingException - if any problems arise parsing from string.

parse

public void parse(java.io.File file,
                  B builder)
           throws JPlateParsingException

This method is called to parse data from file.

Specified by:

parse in interface JPlateParserIfc<B extends JPlateBuilderIfc<?>>

Parameters:

file - is the file containing data to be parsed.

builder - is the builder who can construct things on behalf of self.

Throws:

JPlateParsingException - if any problems arise parsing from file.

parse

protected abstract void parse(B builder)
                       throws java.lang.Exception

Is called by self to start parsing.

Parameters:

builder - The object who can create objects from data contained in parser input stream/reader.

Throws:

java.lang.Exception - If any issue arise during parsing.