org.jorion.jdepend
Class AbstractParser

java.lang.Object
  org.jorion.jdepend.AbstractParser

Direct Known Subclasses:

ClassFileParser

public abstract class AbstractParser
extends java.lang.Object

The AbstractParser class is the base class for classes capable of parsing files to create a JavaClass instance.

Author:

Mike Clark, Clarkware Consulting, Inc.

Constructor Summary

AbstractParser()
Default constructor.

AbstractParser(PackageFilter filter)

Method Summary

void	addParseListener(ParserListener listener)
protected void	debug(java.lang.String message)
static boolean	getDebug()
protected PackageFilter	getFilter()
protected void	onParsedJavaClass(JavaClass jClass) Informs registered parser listeners that the specified JavaClass was parsed.
abstract JavaClass	parse(java.io.InputStream is) Registered parser listeners are informed that the resulting JavaClass was parsed.
static void	setDebug(boolean debug)
protected void	setFilter(PackageFilter filter)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractParser

public AbstractParser()

Default constructor.

AbstractParser

public AbstractParser(PackageFilter filter)

Parameters:

filter - A PackageFilter.

Method Detail

addParseListener

public void addParseListener(ParserListener listener)

Parameters:

listener - The listener to add.

parse

public abstract JavaClass parse(java.io.InputStream is)
                         throws java.io.IOException

Registered parser listeners are informed that the resulting JavaClass was parsed.

Parameters:

is - The input stream.

Returns:

A JavaClass object.

Throws:

java.io.IOException - Any IOException.

onParsedJavaClass

protected void onParsedJavaClass(JavaClass jClass)

Informs registered parser listeners that the specified JavaClass was parsed.

Parameters:

jClass - Parsed Java class.

getFilter

protected PackageFilter getFilter()

Returns:

A PackageFilter.

setFilter

protected void setFilter(PackageFilter filter)

debug

protected void debug(java.lang.String message)

Parameters:

message - The message to print out.

getDebug

public static boolean getDebug()

setDebug

public static void setDebug(boolean debug)